@storefront-ui/nuxt
TypeScript icon, indicating that this package has built-in type declarations

2.5.1 • Public • Published

Install all dependencies

With Nuxt 3, the fastest way to get started is to use the @storefront-ui/nuxt module. The Storefront-io Nuxt module will automatically install @nuxtjs/tailwindcss inside nuxt and storefront-ui tailwindcss presets.

# npm
npm i -D @storefront-ui/nuxt

# yarn
yarn add -D @storefront-ui/nuxt

# pnpm
pnpm add -D @storefront-ui/nuxt

Add the Nuxt Tailwind module to your nuxt.config.ts

// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@storefront-ui/nuxt']
})

Tailwind configuration

Since we use @nuxtjs/tailwindcss under the hood, there is possibility to use tailwindcss property in nuxt.config.ts file. Other than that there is default tailwind way to create config via tailwind.config.ts file.

Internally, @nuxtjs/tailwindcss will merge the three places that you can add configurations. In order of priority, the options are:

  1. tailwind.config.ts file
  2. nuxt.config.ts file with tailwindcss property
  3. Storefront UI default configuration

::tip Add a path to your installed package In order for Tailwind to properly detect the utility classes used in Storefront UI components, you need to add a path to wherever your node_modules folder is located to the content property. In the example below, we're using the default location for node_modules, but this may change if you're working in a monorepo. ::

// tailwind.config.ts
import type { Config } from 'tailwindcss';

export default <Config>{
  content: ['./**/*.vue', './node_modules/@storefront-ui/vue/**/*.{js,mjs}'],
};

Custom tailwind.css file

If you're going to create your own Tailwind CSS file, make sure to add the @tailwind directives for each of Tailwind’s layer types (base, components, and utilities).

/* ~/assets/css/tailwind.css */
@tailwind base;
@tailwind components;
@tailwind utilities;

You're ready to go

Now, you can import Storefront UI components in your app and all the Tailwind utilities from the @storefront-ui/vue library will be available in your project. Because storefront-ui is served as well from module, @storefront-ui/vue is available from Nuxt autoimport.

Readme

Keywords

none

Package Sidebar

Install

npm i @storefront-ui/nuxt

Weekly Downloads

860

Version

2.5.1

License

MIT

Unpacked Size

12.9 kB

Total Files

10

Last publish

Collaborators

  • mtokarskivsf
  • dzalewski
  • frsgit
  • aniamusial
  • filrak
  • adampawlinski