---
title: "Getting Started"
description: "Build Vue and Nuxt applications faster with maz-ui - 50+ components, themes, icons and translations, tree-shakable and typed"
package: "maz-ui"
url: "https://maz-ui.com/guide/getting-started"
---

# Getting Started

> Build Vue and Nuxt applications faster with maz-ui - 50+ components, themes, icons and translations, tree-shakable and typed

- Package: `maz-ui`
- Web: https://maz-ui.com/guide/getting-started

maz-ui gives you 50+ Vue 3 components, with composables, directives and plugins, and the packages around them: themes, icons, translations, helpers, a Nuxt module and the tools for AI agents. Import only what you use, everything is typed.

**Tip: Migrating from v4?**

Run `npx @maz-ui/upgrade ./` for the mechanical part of the migration, then follow the [v5 migration guide](./migration-v5.md).

## Choose your framework

- [Install maz-ui with Vue](./vue.md)
- [Install maz-ui with Nuxt](https://maz-ui.com/ecosystem/nuxt.md)

## A first form

```vue
<script setup lang="ts">
import MazBtn from 'maz-ui/components/MazBtn'
import MazInput from 'maz-ui/components/MazInput'
import { useToast } from 'maz-ui/composables/useToast'

const email = ref('')
const toast = useToast()

function signUp() {
  toast.success(`Welcome ${email.value}`)
}
</script>

<template>
  <MazInput v-model="email" label="Email" type="email" start-icon="envelope" />
  <MazBtn color="primary" end-icon="arrow-right" size="lg" @click="signUp">
    Sign up
  </MazBtn>
</template>
```

Each component, composable and helper has its own import (`maz-ui/components/MazBtn`, `@maz-ui/utils/helpers/debounce`): only what you import is bundled. The icons are used by name, with [`MazUi()`](https://maz-ui.com/ecosystem/vite-plugin.md) or [`@maz-ui/nuxt`](https://maz-ui.com/ecosystem/nuxt.md).

## Ecosystem

- [Theming](https://maz-ui.com/ecosystem/themes.md)
- [@maz-ui/icons](https://maz-ui.com/ecosystem/icons/index.md)
- [Translations (i18n)](https://maz-ui.com/ecosystem/translations.md)
- [@maz-ui/utils](https://maz-ui.com/ecosystem/utils/index.md)
- [Vite plugin](https://maz-ui.com/ecosystem/vite-plugin.md)
- [AI agents](./ai-agents.md)

### Keep the packages on the same version

`maz-ui` and its packages are released together, on the same version: keep them on it. Two versions of a package install two copies, a heavier bundle, and two copies of `maz-ui` do not share their configuration.

**Details: Group their updates in one pull request**

With Dependabot (`.github/dependabot.yml`):

```yaml
version: 2
updates:
  - package-ecosystem: npm
    directory: /
    schedule:
      interval: weekly
    groups:
      maz-ui:
        patterns:
          - maz-ui
          - '@maz-ui/*'
```

With Renovate (`renovate.json`):

```json
{
  "packageRules": [
    {
      "groupName": "maz-ui",
      "matchPackageNames": ["maz-ui", "@maz-ui/*"]
    }
  ]
}
```

## Next steps

- [Components](../components/maz-btn.md): live examples and API of each component
- [Tailwind CSS](./tailwind.md): the theme tokens of maz-ui in your Tailwind classes
- [MazUiProvider](./maz-ui-provider.md): load maz-ui only on the pages that use it
- [GitHub discussions](https://github.com/LouisMazel/maz-ui/discussions) and [issues](https://github.com/LouisMazel/maz-ui/issues) for help
