Overview
Qui is a Neumorphic design system for building web applications. It is written in TypeScript with Composition API and is specifically designed for Vue 3.x. The library includes over 30 components, all fully written with the Composition API and utilizes TypeScript for type safety. Qui also includes an icon pack, colors & grid support, and neumorphic styles. It provides a Storybook Sandbox for easy exploration and a documentation site for reference. Qui also offers support for different languages through its localization feature.
Features
- 30+ Vue 3 components: A comprehensive library of components for building web applications with Vue 3.
- Fully written with Composition API: Makes use of the Composition API, the new recommended way of writing Vue 3 components.
- Typescript: Provides type safety for a better development experience.
- Icons Pack: Includes a collection of icons that can be easily used in Vue 3 applications.
- Colors & Grid: Supports customizable colors and a grid system for designing UI layouts.
- Neumorphism Styles: Provides neumorphic styles, a popular design trend, for a modern and sleek look.
- Storybook Sandbox: Offers a live demo of the components in action for easy exploration and testing.
- Documentation: Provides a documentation website for a reference on how to use the components effectively.
Fully Import
To fully import Qui, follow these steps:
- In your
main.jsfile, import Qui:
- Vite
Vite is a build tool that aims to provide a faster and leaner development experience for modern web projects
- Vue
Vue.js is a lightweight and flexible JavaScript framework that allows developers to easily build dynamic and reactive user interfaces. Its intuitive syntax, modular architecture, and focus on performance make it a popular choice for modern web development.
- SCSS
SCSS is a preprocessor scripting language that extends the capabilities of CSS by adding features such as variables, nesting, and mixins. It allows developers to write more efficient and maintainable CSS code, and helps to streamline the development process by reducing repetition and increasing reusability.
- UI Kits & Components
A UI kit provides developers with a set of reusable components that can be easily integrated into a website or application. These components are pre-designed with consistent styling and functionality, allowing developers to save time and effort in the design and development process. UI kits can be either custom-built or third-party, and often include components for buttons, forms, typography, icons, and more.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- Stylelint
Stylelint is a modern linter for CSS that helps you avoid errors and enforce consistent styling conventions. It provides rules for detecting errors and warnings, and can be configured to match your specific project's requirements.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.