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.

Installation

To install Qui, you have two options: import the entire library or import specific components as needed.

Fully Import

To fully import Qui, follow these steps:

1. In your main.js file, import Qui:

import Qui from 'qui';

2. In your Vue component, import the specific component(s) you want to use:

import { Button, Input } from 'qui';

3. Configure the setup according to your requirements. For example, you can:

• Import styles separately to avoid unused CSS:

import 'qui/dist/styles.css';

• Set localization messages to support any language for the components:

Qui.localization.messages = {
  en: {
    button: 'Click me',
    input: 'Type something',
  },
  fr: {
    button: 'Cliquez ici',
    input: 'Entrez quelque chose',
  },
};

• Control the setup of components:

Qui.setup({
  zIndex: 100,
  // other options
});

Code Examples

To learn how to use each component, refer to the component’s stories in the Storybook Sandbox.

Using with Nuxt 3

To use Qui with Nuxt 3, follow these steps:

1. Create a file in your plugins folder, e.g., qui.js.

2. Add the following configuration to your nuxt.config.ts file:

export default {
  plugins: [
    { src: '~/plugins/qui.js', mode: 'client' },
  ],
}

Summary

Qui is a powerful Neumorphic design system specifically designed for Vue 3. Its extensive library of components, written with the Composition API and TypeScript, makes it easy to build great products for customers. With features like icons pack, neumorphic styles, and localization support, Qui is a comprehensive solution for designing and developing web applications. Its intuitive documentation and the Storybook Sandbox further facilitate the use and exploration of its components. Whether you are a beginner or an experienced developer, Qui provides the tools needed to create modern and visually appealing user interfaces.