Skip to content

Repository files navigation

Cattr UI

UI-библиотека Cattr на Vue 2. Проект является форком AT UI и сохраняет его API, дополняя оригинальную библиотеку стилями, темой и исправлениями, необходимыми Cattr.

Это внутренняя библиотека Cattr, а не официальный релиз AT UI. Для новых проектов стоит учитывать, что она основана на устаревшем стеке Vue 2 и Webpack 3.

Отличия от AT UI

  • пакет публикуется как @amazingcat/cattr-ui;
  • исходники AT UI Style включены в src/stylesheet, отдельный пакет стилей не нужен;
  • переменные, сетка, шрифты и стили компонентов адаптированы под интерфейс Cattr;
  • поддерживается импорт отдельных компонентов;
  • добавлено событие rowClick для строк таблицы;
  • включены исправления поведения InputNumber, Tabs, Table и других компонентов, используемых в Cattr.

Установка

pnpm add @amazingcat/cattr-ui

Подключение

Подключение всей библиотеки:

import Vue from 'vue'
import CattrUI from '@amazingcat/cattr-ui'
import '@amazingcat/cattr-ui/src/stylesheet/src/index.scss'

Vue.use(CattrUI)

После этого компоненты доступны глобально:

<template>
  <at-button type="primary">Сохранить</at-button>
</template>

Для импорта отдельного компонента:

import Vue from 'vue'
import Button from '@amazingcat/cattr-ui/src/components/button'
import '@amazingcat/cattr-ui/src/stylesheet/src/index.scss'

Vue.use(Button)

Разработка

Для разработки используются Node.js 24.21 (версия закреплена в .nvmrc) и pnpm 12.9 (версия закреплена в package.json).

corepack enable
pnpm install
pnpm dev

Основные команды:

Команда Назначение
pnpm dev Запустить локальную документацию и стенд разработки
pnpm lint Проверить JavaScript- и Vue-файлы линтером
pnpm build:locale Собрать локализации
pnpm build:component Собрать библиотеку компонентов
pnpm build:package Собрать локализации и библиотеку компонентов
pnpm build:docs Собрать пакет, стили Dart Sass и сайт документации в dist/
pnpm dist Выполнить полную сборку (псевдоним build:docs)

По умолчанию dev-сервер доступен по адресу http://localhost:7200/.

При push в ветку main GitHub Actions собирает документацию и публикует её на GitHub Pages.

Upstream и лицензия

Исходный проект: AT UI.

Проект распространяется по лицензии MIT.

About

Vue 2 UI component library used by Cattr, based on AT UI

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Used by

Contributors

Languages