Введение в клиент

Waline официально предоставляет @waline/client, написанный на Vue + TypeScript, его размер составляет всего 100 КБ в gzip.

Подключение

Клиент Waline можно подключить через CDN или npm; мы предоставляем файлы в нескольких вариантах для разных сценариев.

Если в процессе возникнут проблемы, см.:

• Рецепты → Подключение через CDN
• Рецепты → Подключение в проект

Использование Waline

Самый простой способ использовать Waline — способ, подробно описанный в быстром старте: импортировать функцию init из Waline и инициализировать экземпляр Waline через init(yourOptions).

Среди параметров init обязательны el и serverURL. Первый — элемент или селектор элемента, в который монтируется Waline, второй — адрес сервера. Все параметры инициализации @waline/client см. в разделе Справочник клиента → API.

Счётчик комментариев

@waline/client также предоставляет подпакет для подсчёта комментариев. С его помощью можно отображать количество комментариев в списке статей блога или на других страницах без комментариев. Подробнее см. Возможности → Счётчик комментариев

Счётчик просмотров

Waline поддерживает подсчёт просмотров. Если сервис комментариев не нужен, а функция просмотров нужна, Waline предоставляет плагин подсчёта просмотров размером < 1KB в Gzip.

Подробнее о счётчике просмотров @waline/client см. Возможности → Счётчик просмотров

Поддержка форматов комментариев

@waline/client поддерживает множество синтаксисов комментариев и богатое форматирование. Помимо стандартного Markdown и расширений синтаксиса GFM, комментаторы могут встраивать HTML-теги, использовать математические формулы и многое другое. Остальной синтаксис см. в Возможности → Поддерживаемый синтаксис.

@waline/client также поддерживает предпросмотр вводимого комментария в реальном времени. Правда, из-за размера некоторые функции по умолчанию отключены. Если вы хотите их вернуть, см.:

• Рецепты → Настройка подсветчика кода в предпросмотре
• Рецепты → Настройка рендерера $TEX$ в предпросмотре

Реакции на статью

Считаете комментарии слишком громоздкими? Waline позволяет посетителям быстро выражать своё отношение к статьям — например, «Нравится», «Не нравится», «Не понимаю», «Скучно», «Удивлён» и т. д. Как включить эту функцию вручную, см. Возможности → Реакции на статью .

Возможности комментариев

Waline поддерживает ряд базовых возможностей, включая вход, аватары, несколько языков и предпросмотр в реальном времени.

Waline позволяет задавать метки уровней взаимодействия и пользовательские метки для ваших пользователей. Подробнее см. Метки пользователей.

Вкладка эмодзи

@waline/client поддерживает несколько вкладок эмодзи и позволяет легко подключать вкладки эмодзи через наборы. Помимо официальных, вы можете легко создавать собственные наборы.

Подробнее о вкладках эмодзи @waline/client см.:

• Возможности → Вкладка эмодзи
• Рецепты → Настройка эмодзи

Вставка изображений

@waline/client имеет встроенную поддержку загрузки изображений. По умолчанию изображения преобразуются в base64. При этом можно использовать и собственный хостинг изображений.

Подробнее о настройках загрузки изображений @waline/client см. Рецепты → Настройка загрузки изображений.

Поиск эмодзи

@waline/client предоставляет поиск мемов и эмодзи через giphy и позволяет настроить сервис поиска. См.:

• Возможности → Поиск эмодзи
• Рецепты → Настройка поиска эмодзи

Поддержка языков

@waline/client имеет встроенную поддержку нескольких языков, на её основе можно добавлять языки или изменять текст интерфейса. См.:

• Возможности → Установка языка.
• Рецепты → Настройка языка.

Поддержка доступности

Waline полностью соответствует стандартам доступности:

• У всех иконок и элементов управления есть соответствующие метки доступности.
• С любыми элементами управления Waline можно взаимодействовать как с клавиатуры, так и с помощью устройства указания, надеваемого на голову.

Так мы поддерживаем людей с нарушениями зрения и опорно-двигательного аппарата по всему миру! ❤️

Настраиваемые стили

Waline имеет встроенную поддержку тёмного режима. Чтобы пользователям было проще настраивать стиль Waline, мы предоставляем множество настраиваемых CSS-переменных.

Подробнее см. Собственные стили.

Продвинутая разработка

Поддержка одностраничных приложений

Waline поддерживает SPA (Single Page Applications).

Если вы хотите использовать Waline на сайте или в приложении на основе history API, можно применить метод update() к инициализированному экземпляру, чтобы обновить конфигурацию области комментариев, или метод destroy() на экземпляре, чтобы уничтожить Waline. Подробнее о реактивности @waline/client см. Рецепты → Реактивность.

Экосистема

Waline можно легко использовать через плагины для таких инструментов, как Hexo и VuePress, а также в сторонних клиентах.

О сторонних клиентах, темах и плагинах, поддерживающих Waline, см. Узнать больше → Экосистема.