An open API service indexing awesome lists of open source software.

https://github.com/LouisMazel/maz-ui

Vue & Nuxt library of standalone components & tools to build interfaces
https://github.com/LouisMazel/maz-ui

component css javascript library maz-ui nuxt standalone tailwindcss typescript ui vue vue-components

Last synced: 4 months ago
JSON representation

Vue & Nuxt library of standalone components & tools to build interfaces

Awesome Lists containing this project

README

          


Maz UI Logo

Maz UI




Lightweight and efficient library for Vue 3 & Nuxt 3



vue 3
nuxt 3
npm
types
Downloads


maintainability
test coverage
github actions test unit


Documentation
ยท
Getting Started
ยท
Showcase




Maz UI Demo Dashboard



Example of a dashboard built with Maz UI components

## โœจ Features

- ๐ŸŽฏ **Cherry-pick components** - Use only what you need
- ๐ŸŒ™ **Dark mode** - Built-in dark mode support
- ๐ŸŽจ **Themeable** - Easy to customize with CSS variables
- ๐Ÿ“ฑ **Responsive** - Mobile-first design approach
- ๐Ÿ”ง **TypeScript** - Full type support included
- โšก๏ธ **Lightweight** - Tree-shakeable, no bloat
- ๐Ÿ” **SSR** - Server-side rendering ready

## ๐Ÿš€ Quick Start

```bash
npm install maz-ui
```

### Vue 3

```ts
// main.ts
import 'maz-ui/styles'
```

#### ๐Ÿ’ก Usage

Then, import and use only the components, composables, and more you need:

```vue

Click me!

import MazBtn from 'maz-ui/components/MazBtn'

```

Use provided resolvers to enjoy auto-imports and TypeScript support: [Resolvers documentation](https://maz-ui.com/guide/getting-started#recommendations)

### Nuxt 3

The Nuxt module automatically:

- Imports all components, plugins, composables and directives on-demand (auto-imports)
- Includes required styles
- Provides TypeScript support out of the box

[See options and more in the documentation](https://maz-ui.com/guide/nuxt)

```ts
// nuxt.config.ts
export default defineNuxtConfig({
modules: ['maz-ui/nuxt'],
})
```

#### ๐Ÿ’ก Usage

No need to import components, plugins, composables or directives, they are all auto-imported.

```vue

Click me!

const toast = useToast()

```

## ๐ŸŽจ Theming Made Easy

Customize Maz UI to match your brand with our dedicated CLI tool:

```bash
# Install the CLI
npm install -g @mazui/cli

# Generate your theme
maz generate-css-vars
```

The CLI will automatically:

- Generate all color variations
- Create dark mode variables
- Output a ready-to-use CSS file

To know how configure the CLI, check [theming options](https://maz-ui.com/guide/theme) in our documentation.

## ๐Ÿงฐ What's included?

- ๐Ÿงฉ [Components](https://maz-ui.com/components/maz-btn) - Beautiful, accessible UI components
- ๐Ÿ”Œ [Plugins](https://maz-ui.com/plugins/dialog) - Powerful plugins for common use cases
- ๐ŸŽฃ [Composables](https://maz-ui.com/composables/use-form-validator) - Reusable composition functions
- ๐Ÿ“ [Directives](https://maz-ui.com/directives/fullscreen-img) - Useful Vue directives
- ๐Ÿ› ๏ธ [Helpers](https://maz-ui.com/helpers/currency) - Useful utilities for common tasks

## ๐Ÿค Contributing

We're always looking for contributors! Check out our [contribution guide](./CONTRIBUTING.md) to get started.

## ๐Ÿ“„ License

[MIT](./LICENSE)


Built with โค๏ธ by Louis Mazel