Skip to content

Commit

Permalink
feat(module): add option to disable global css styles (#1266)
Browse files Browse the repository at this point in the history
  • Loading branch information
cernymatej authored Jan 23, 2024
1 parent 865c492 commit f96eb5e
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 8 deletions.
13 changes: 7 additions & 6 deletions docs/content/1.getting-started/2.installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,12 +227,13 @@ You can also add the following to your `.vscode/settings.json` to enable Intelli

## Options

| Key | Default | Description |
| ------------------------ | ---------------------- | ------------------------------------------------ |
| `prefix` | `u` | Define the prefix of the imported components. |
| `global` | `false` | Expose components globally. |
| `icons` | `['heroicons']` | Icon collections to load. |
| `safelistColors` | `['primary']` | Force safelisting of colors to need be purged. |
| Key | Default | Description |
|-----------------------|-----------------|-------------------------------------------------------------------------------------------------------------|
| `prefix` | `u` | Define the prefix of the imported components. |
| `global` | `false` | Expose components globally. |
| `icons` | `['heroicons']` | Icon collections to load. |
| `safelistColors` | `['primary']` | Force safelisting of colors to need be purged. |
| `disableGlobalStyles` | `false` | Disable [global CSS styles](https://github.com/nuxt/ui/blob/dev/src/runtime/ui.css) injected by the module. |

Configure options in your `nuxt.config.ts` as such:

Expand Down
11 changes: 9 additions & 2 deletions src/module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,10 @@ export interface ModuleOptions {
icons: CollectionNames[] | 'all' | IconsPluginOptions

safelistColors?: string[]
/**
* Disables the global css styles added by the module.
*/
disableGlobalStyles?: boolean
}

export default defineNuxtModule<ModuleOptions>({
Expand All @@ -68,7 +72,8 @@ export default defineNuxtModule<ModuleOptions>({
defaults: {
prefix: 'U',
icons: ['heroicons'],
safelistColors: ['primary']
safelistColors: ['primary'],
disableGlobalStyles: false
},
async setup (options, nuxt) {
const { resolve } = createResolver(import.meta.url)
Expand All @@ -80,7 +85,9 @@ export default defineNuxtModule<ModuleOptions>({

nuxt.options.alias['#ui'] = runtimeDir

nuxt.options.css.push(resolve(runtimeDir, 'ui.css'))
if (!options.disableGlobalStyles) {
nuxt.options.css.push(resolve(runtimeDir, 'ui.css'))
}

// @ts-ignore
nuxt.hook('tailwindcss:config', function (tailwindConfig) {
Expand Down

1 comment on commit f96eb5e

@vercel
Copy link

@vercel vercel bot commented on f96eb5e Jan 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

ui – ./

ui.nuxt.com
ui-git-dev-nuxt-js.vercel.app
ui-nuxt-js.vercel.app

Please sign in to comment.