diff --git a/README.md b/README.md index 3c477d30..a8e9cdee 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,10 @@ npm type definitions -npm bundle size -NPM version -NPM downloads -

+ npm bundle size + NPM version + NPM downloads +

@@ -18,6 +18,8 @@ A component's library helping us build great products for our customers. +[Storybook (live demo)](https://qvant-lab.github.io/qui-max/) + What is it? - 🔩 30+ Vue 3 components diff --git a/stories/intro.stories.mdx b/stories/intro.stories.mdx new file mode 100644 index 00000000..4892eb06 --- /dev/null +++ b/stories/intro.stories.mdx @@ -0,0 +1,163 @@ +import { Meta, Story } from '@storybook/addon-docs/blocks'; + + + +

+ + +
+ + + npm type definitions + + npm bundle size + NPM version + NPM downloads + +
+ +
+ +# Qui Max is a Vue 3 Design System for Web + +A component's library helping us build great products for our customers. + +What is it? + +- 🔩 30+ Vue 3 components +- 🔥 Fully written with Composition API +- 🔑 Typescript +- 📦 icons pack +- 🏳️‍🌈 colors & grid +- 🥷 neumorphism styles +- 📚 storybook sandbox + +Some examples below: + +![buttons](https://github.com/Qvant-lab/qui/raw/master/.readme-assets/buttons.jpg) +![inputs](https://github.com/Qvant-lab/qui/raw/master/.readme-assets/inputs.gif) +![icons](https://github.com/Qvant-lab/qui/raw/master/.readme-assets/icons.gif) +![tables](https://github.com/Qvant-lab/qui/raw/master/.readme-assets/tables.jpg) +![other](https://github.com/Qvant-lab/qui/raw/master/.readme-assets/other.jpg) + +## Install + +```bash +npm install @qvant/qui-max -S +yarn add @qvant/qui-max +``` + +You can import Qui entirely, or just import what you need. Let's start with fully import. + +## Quick setup + +In main.js: + +```js +import { createApp } from 'vue'; +import Qui from '@qvant/qui-max'; +import '@qvant/qui-max/styles'; + +const app = createApp(App); +// Setup all components +app.use(Qui, { useAllComponents: true }); +// that's it! All components will be imported with styles +``` + +in YourComponent.vue: (Example) + +```vue + + +``` + +Configure setup: + +- import styles separately to avoid unused css +- set customI18nMessages to support any language for components +- change zIndex of appeared components (e.g Dialogs, Notifications, Dropdowns etc.) +- control setup of components + +In main.js: + +```js +import { createApp } from 'vue'; +import Qui, { QButton } from '@qvant/qui-max'; + +// import required styles +import '@qvant/qui-max/css/main'; +import '@qvant/qui-max/fonts'; +import '@qvant/qui-max/icons'; + +// import the only styles of component you gonna use +import '@qvant/qui-max/css/q-button'; + +app.use(Qui, { + useAllComponents: false, + localization: { + locale: 'en', // Russian language by default, you can set `en` for English + customI18nMessages: { + // rewrite default texts, see the source: src/qComponents/constants/locales + en: { + QDatepicker: { + placeholder: 'Pick your birthday!' + } + } + }, + zIndexCounter: 3000 // zIndexCounter is being used by some components, (e.g QPopover, QSelect, QDialog ...etc), 2000 by default + } +}); + +app.use(QButton); +``` + +Now you have implemented Vue and Qui Max to your project, and it's time to write your code. +Please refer to each component's [Stories](https://qvant-lab.github.io/qui-max/) to learn how to use them. + +## Supported languages + +- Russian ✅ +- English ✅ +- Also you can use any language by setting texts for components via 'customI18nMessages' property in the Qui instance. See the example above. + +## Browser Support + +Modern browsers are recomended + +- safari: >11 +- chrome: >=61 +- firefox: >=58 +- opera: >=62 +- edge: >=16 +- yandex: >=18 +- ie: ? (we don't know :) and will not support it) + +## Development + +Clone repository and run storybook + +```bash +yarn storybook +npm run storybook +``` + +## LICENSE + +MIT \ No newline at end of file