choco-ui

choco-ui

This template should help get you started developing with Vue 3 in Vite.

ВАЖНО!!

Проект находится в активной разработке и в любой момент могут быть добавлены обратно несовместимые изменения. Поэтому рекомендуется при установке фиксировать версию пока не выйдет релиз первой стабильной версии (1.0.0)

npm i choco-ui@0.7.0

Istallation

npm i choco-ui

Правила разработки

Описаны здесь

Preview Storybook

Создав PR, в комментариях вы получите уникальный preview storybook url от github бота, в качестве префикс возьмется название вашей ветки.

Этот URL можете расшейрить своим тестировщикам, дизайнерам.

Под капотом netlify-cli + github actions.

Storybook для ветки main - https://choco-ui.netlify.app/

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

1. Disable the built-in TypeScript Extension
   1. Run Extensions: Show Built-in Extensions from VSCode's command palette
   2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
2. Reload the VSCode window by running Developer: Reload Window from the command palette.

Customize configuration

See Vite Configuration Reference.

Project Setup

npm install

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Run Unit Tests with Vitest

npm run test:unit

Lint with ESLint

npm run lint

Usage

<script>
import { ChButton, ChInput } from 'choco-ui'; // Import needed components
import 'choco-ui/styles'; // Import styles for components
</script>

Styles can be imported separately in .css files and then imported to entry file

/* css/main.css */
@import 'choco-ui/styles';

:root {
    /* Custom styles */
    ...
}

// index.js, main.js or any other app entry file
import { createApp, h, resolveComponent  } from 'vue';
import '@css/main.css';

const App = {
  name: 'App',
  render: () => h('h1', 'Hello, vue app')
};

const app = createApp(App);

app.mount("#app");