С чего начать

Получение

Где скачать

Для обычного проекта используйте пакет из npm: менеджер зависимостей установит нужную версию и позволит обновлять её одной командой. Исходный код можно посмотреть отдельно в GitVerse.

Установка

Добавьте OKAUX в проект

Выполните команду в корневой папке проекта. Если Sass ещё не подключён, установите его отдельно согласно документации вашего сборщика.

npm install okaux

Подключение

Подключите стили и поведение

Для быстрого старта подключите полный SCSS-вход. Он включает фундамент, сетку, компоненты, системные стили и utility-классы.

@use "okaux/scss/app";

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

@use "okaux/scss/entries/core";
@use "okaux/scss/entries/components";
// Необязательно: @use "okaux/scss/entries/utilities";

Интерактивные компоненты регистрируются перед запуском. Подключайте только те модули, которые есть на странице.

import { Modal, Toast, okaux } from "okaux/js/app.js";

okaux
  .register(Modal.NAME, Modal)
  .register(Toast.NAME, Toast)
  .boot();

Настройка

Создайте локальный facade

Храните настройки проекта в отдельном SCSS-файле. Так обновления OKAUX не затронут ваши токены, а команда будет видеть единую точку конфигурации.

@forward "okaux/scss/tokens/colors" with (
  $color-brand-extend: (
    primary: #5b5bd6,
  )
);

@use "okaux/scss/app";