Shuriken UI Nuxt Template

This is an extendable Nuxt Layer built on top of @shuriken-ui/nuxt, designed to provide a streamlined and customizable collection of components and templates for Nuxt 3 projects.

Installation

1pnpm install -D @almsomnia/shuriken-ui-nuxt-template

Usage

1// nuxt.config.ts
2export default defineNuxtConfig({
3   extends: [
4      '@almsomnia/shuriken-ui-nuxt-template'
5   ]
6})

Note: This is a layer and not a module, so you must extend your config with it.

Configuration

See Shuriken UI documentation for more details.

1// app.config.ts
2export default defineAppConfig({
3   /**
4    * Shuriken UI layer configuration
5    */
6   nui: {
7      /**
8       * Set default properties for BaseButton component
9       */
10      BaseButton: {
11         variant: 'pastel',
12         rounded: 'md'
13      },
14
15      // ...
16   }
17})

Contributing

Contributions are welcome! To contribute:

• Clone this repository.
• Install dependencies.

  1pnpm install

• Make changes and ensure compability.
• Submit a pull request.

License

This package is licensed under the MIT License

Acknowledgement

This package is built on amazing Shuriken UI. Special thanks to the contributors and the community for their support.