v1.0.0
Документация Компоненты API JSON GitHub
Документация / Руководство / Быстрый старт

Документация Klythora UI

Klythora UI — библиотека пользовательского интерфейса на базе нативных Web Components (Custom Elements, Shadow DOM). Позволяет использовать готовые интерактивные элементы в любом фреймворке или на чистом HTML без сборщиков.

Без зависимостей
Все компоненты полностью инкапсулированы через Shadow DOM. Стили не конфликтуют с глобальным CSS вашего проекта.

Быстрый старт

Для подключения библиотеки достаточно подключить скрипт index.js как ES-модуль.

index.html
<!DOCTYPE html>
<html lang="ru">
<head>
  <meta charset="UTF-8">
  <script type="module" src="https://klythora-ui.kiwiproject.ru/index.js"></script>
</head>
<body>
  <ui-button>Начать бесплатно</ui-button>
  <ui-outline-button>Смотреть демо</ui-outline-button>
</body>
</html>

Импорт и использование

Библиотека раздается с поддержкой CORS и готова к прямому импорту как в обычные HTML-страницы, так и в любые современные фреймворки (React, Vue, Svelte, Next.js).

1. Подключение через тег script в HTML

Подключите единый бандл библиотеки одной строкой. Все веб-компоненты автоматически зарегистрируются в браузере:

index.html
<!-- Подключение библиотеки -->
<script type="module" src="https://klythora-ui.kiwiproject.ru/index.js"></script>

<!-- Использование в разметке -->
<ui-button>Начать работу</ui-button>
<ui-badge variant="live" dot>в сети</ui-badge>

2. Импорт в JavaScript / TypeScript (ESM)

Импортируйте конкретные классы компонентов напрямую по URL:

main.js
// Импорт нужных компонентов напрямую из сервера библиотеки
import { UiButton, UiBadge, UiCard, UiInput } from 'https://klythora-ui.kiwiproject.ru/index.js';

// Либо импорт отдельного файла компонента
import 'https://klythora-ui.kiwiproject.ru/components/ui-button.js';

3. Использование во фреймворках (React / Vue)

Web Components поддерживаются стандартами W3C, поэтому теги <ui-*> можно использовать в JSX/шаблонах так же, как обычные HTML-элементы:

App.jsx
export default function App() {
  return (
    <div>
      <ui-badge variant="recommended">Рекомендуемый</ui-badge>
      <ui-button onClick={() => alert('Клик!')}>
        Нажать
      </ui-button>
    </div>
  );
}

<ui-button>

Основная кнопка с формой pill, микроанимацией при наведении и поддержкой тем.

Интерактивный пример Live Component
Начать 14 дней бесплатно Войти Ответить Недоступно
HTML
<ui-button>Начать 14 дней бесплатно</ui-button>
<ui-button theme="white">Войти</ui-button>
<ui-button size="sm">Ответить</ui-button>
<ui-button disabled>Недоступно</ui-button>
АтрибутТипПо умолчаниюОписание
theme"black" | "white""black"Цветовая схема кнопки
size"sm" | "md" | "lg""md"Размер кнопки
disabledbooleanfalseБлокировка нажатия

<ui-outline-button>

Контурная кнопка для второстепенных действий (экспорт, фильтры, переходы).

Смотреть обзор (90 сек) Экспорт Поделиться
HTML
<ui-outline-button>Смотреть обзор (90 сек)</ui-outline-button>
<ui-outline-button size="sm">Экспорт</ui-outline-button>
<ui-outline-button size="sm">Поделиться</ui-outline-button>

<ui-badge>

Метка статуса процесса, категории или количества непрочитанных сообщений.

Рекомендуемый в сети синхронизация 28 новых активен
HTML
<ui-badge variant="recommended">Рекомендуемый</ui-badge>
<ui-badge variant="live" dot>в сети</ui-badge>
<ui-badge variant="syncing" dot>синхронизация</ui-badge>
<ui-badge variant="count">28 новых</ui-badge>
АтрибутТипПо умолчаниюОписание
variant"recommended" | "live" | "syncing" | "count" | "blue""default"Стиль оформления
dotbooleanfalseОтображает светящийся индикатор-точку

<ui-input>

Поле ввода текста со скруглением pill. При типе type="search" автоматически отображается иконка поиска.

HTML
<ui-input type="search" placeholder="Поиск по диалогам и контактам..."></ui-input>
<ui-input placeholder="Имя клиента..." value="Анна Смирнова"></ui-input>

<ui-tabs> и <ui-tab>

Сегментированный переключатель вкладок с поддержкой числовых бейджей.

Обзор Входящие Лиды Статистика Сценарии
HTML
<ui-tabs>
  <ui-tab active>Обзор</ui-tab>
  <ui-tab count="28">Входящие</ui-tab>
  <ui-tab>Лиды</ui-tab>
  <ui-tab>Статистика</ui-tab>
</ui-tabs>

<ui-stat-card>

Карточка метрики для дашборда с крупным числовым значением и индикатором динамики.

HTML
<ui-stat-card label="Горячие лиды" value="382" trend="↑ 18% за неделю" trend-direction="up"></ui-stat-card>
<ui-stat-card label="Ожидают ответа" value="4" trend="+2 с 9:00" trend-direction="warning"></ui-stat-card>

<ui-progress-bar>

Индикатор заполнения для воронок продаж и статусов выполнения.

HTML
<ui-progress-bar label="Новые лиды" count="412" value="85" color="blue"></ui-progress-bar>
<ui-progress-bar label="Квалифицированные" count="228" value="50" color="orange"></ui-progress-bar>
<ui-progress-bar label="Закрытые сделки" count="96" value="25" color="emerald"></ui-progress-bar>

<ui-feature-card>

Карточка для презентации возможностей продукта со слотом для иконки и виджета.

✉
WhatsApp в сети

<ui-pricing-card>

Карточка тарифа с названием, ценой, перечнем опций и кнопкой действия.

Рекомендуемый
  • До 8 рабочих мест
  • Безлимитные автоматические ответы
  • Воронки, правила и вебхуки
Попробовать бесплатно

<ui-avatar>

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

ИВ АК МС
HTML
<ui-avatar status="online">ИВ</ui-avatar>
<ui-avatar size="sm">АК</ui-avatar>
<ui-avatar size="lg" status="busy">МС</ui-avatar>
Esc