Руководство по Alpine.js

Lily для Alpine — это HTML-фрагменты, которые вы вставляете на страницу, и один плагин, дающий интерактивным компонентам клавиатуру и состояние.

Что вы создадите

Небольшую форму настроек: два подписанных поля, переключатель и кнопку сохранения, с настоящей работой с клавиатуры и программы экранного доступа, сначала без оформления, потом с ним, примерно за 10 минут.

Прежде чем начать

Нужны Node.js и страница, на которой уже подключён Alpine.js 3. В Alpine нет модели компонентов, поэтому компонент Lily здесь — это разметка, которую копируют, а не импорт.

Шаг 1 — Установите и зарегистрируйте плагин

npm install alpinejs @lilydesignsystem/alpine-headless
<script type="module">
  import Alpine from "alpinejs";
  import lily from "@lilydesignsystem/alpine-headless/plugin";
  Alpine.plugin(lily);
  Alpine.start();
</script>

Плагин регистрирует одно поведение Alpine.data() для каждого интерактивного компонента, с именем lily и названием компонента: lilySwitchButton, lilyTabs, lilyCombobox. Фрагменты всех компонентов лежат в папке components/ пакета, у каждого есть комментарий-заголовок с элементом, классом, клавишами и ARIA.

Шаг 2 — Ваш первый компонент

Большинство компонентов — простая разметка, и плагин им не нужен:

<button class="button" type="submit">Save</button>

Интерактивный компонент добавляет поведение через x-data и связывает его через x-bind:

<button
  class="switch-button"
  x-data="lilySwitchButton(false)"
  x-bind="button"
  aria-label="Email me about appointments"
>
  Email me about appointments
</button>

Поведение даёт ему role="switch" и поддерживает aria-checked в актуальном виде, когда Enter, Пробел или щелчок переключают его. Слова ваши: Lily никогда не задаёт подпись.

Шаг 3 — Соберите небольшую форму

<form class="form" aria-label="Settings">
  <div class="field">
    <label class="label" for="name">Full name</label>
    <input class="text-input" type="text" id="name" name="name" autocomplete="name" required />
  </div>
  <div class="field">
    <label class="label" for="email">Email</label>
    <input class="email-input" type="email" id="email" name="email" autocomplete="email" required />
  </div>
  <button
    class="switch-button"
    type="button"
    x-data="lilySwitchButton(true)"
    x-bind="button"
    aria-label="Email me about appointments"
  >
    Email me about appointments
  </button>
  <button class="button" type="submit">Save</button>
</form>

Проверьте работу: откройте страницу и нажмите Tab. Фокус проходит по обоим полям, переключателю и кнопке. На переключателе Space переключает его, и программа экранного доступа говорит «переключатель, включено» или «выключено». Выглядит просто, и это правильно: оформление дальше.

Шаг 4 — Оформите

Подключите одну из 63 готовых тем, которые используют те же классы:

<link rel="stylesheet" href="/themes/light.css" />

Или напишите свой CSS для классов и состояния, которое задаёт поведение:

.switch-button[aria-checked="true"] { background: var(--color-primary); }
.switch-button:focus-visible { outline: 2px solid var(--lily-focus-ring); outline-offset: 2px; }

Оформляйте состояние ARIA, а не собственный класс: тогда вид никогда не разойдётся с тем, что слышит программа экранного доступа.

Шаг 5 — Посмотрите, как всё работает

  • Пример приложения на Alpine.js, lily-design-system-alpine-examples, показывает все компоненты с оформлением: pnpm install && pnpm run build.
  • Для Alpine есть шесть помощников: таблица данных, канбан-доска, календарь, диаграмма Ганта и редакторы Markdown и Org (@lilydesignsystem/alpine-*).

Что дальше