@unocss/nuxt
Version:
Nuxt module for UnoCSS
123 lines (122 loc) • 3.3 kB
text/typescript
import * as _nuxt_schema0 from "@nuxt/schema";
import { UserConfig } from "@unocss/core";
import { AttributifyOptions } from "@unocss/preset-attributify";
import { IconsOptions } from "@unocss/preset-icons";
import { TagifyOptions } from "@unocss/preset-tagify";
import { TypographyOptions } from "@unocss/preset-typography";
import { WebFontsOptions } from "@unocss/preset-web-fonts";
import { PresetWind3Options } from "@unocss/preset-wind3";
import { PresetWind4Options } from "@unocss/preset-wind4";
import { VitePluginConfig } from "@unocss/vite";
//#region src/types.d.ts
interface UnocssNuxtOptions extends UserConfig {
/**
* CSS Generation mode. Only work with Vite.
*
* @see https://unocss.dev/integrations/vite#modes
*/
mode?: VitePluginConfig['mode'];
/**
* Injecting `uno.css` entry
*
* @default true
*/
autoImport?: boolean;
/**
* Injecting `@unocss/reset/tailwind.css` entry
*
* @default false
*/
preflight?: boolean;
/**
* Set Nuxt's `features.inlineStyle` to `false` by default to make it work with UnoCSS.
*
* @default true
*/
disableNuxtInlineStyle?: boolean;
/**
* Automatically merge UnoCSS configs from Nuxt layers.
*
* @default false
*/
nuxtLayers?: boolean;
/**
* Adjust the position of the `uno.css` injection. (Depends on `mode`)
*
* @default 'first'
* @deprecated Temporarily removed, will be added back in the future.
*/
injectPosition?: 'first' | 'last' | number | {
after?: string;
};
/**
* Installing UnoCSS components
* - `<UnoIcon>`
*
* @default true
*/
components?: boolean;
/**
* Enable attributify mode and the options of it
* Only works when `presets` is not specified
* @default false
*/
attributify?: boolean | AttributifyOptions;
/**
* Enable tagify mode and the options of it
* Only works when `presets` is not specified
* @default false
*/
tagify?: boolean | TagifyOptions;
/**
* Enable icons preset and the options of it
* Only works when `presets` is not specified
* @default false
*/
icons?: boolean | IconsOptions;
/**
* Enable web fonts preset and the options of it
* Only works when `presets` is not specified
* @default false
*/
webFonts?: boolean | WebFontsOptions;
/**
* Enable typography preset and the options of it
* Only works when `presets` is not specified
* @default false
*/
typography?: boolean | TypographyOptions;
/**
* Enable the wind3 preset
* Only works when `presets` is not specified
* @default true
*/
wind3?: boolean | PresetWind3Options;
/**
* Enable the wind4 preset
* Only works when `presets` is not specified
* @default false
*/
wind4?: boolean | PresetWind4Options;
}
declare module '@nuxt/schema' {
interface NuxtHooks {
/**
* When UnoCSS load config completed.
*/
'unocss:config': (config: UserConfig) => void;
}
}
//#endregion
//#region src/index.d.ts
declare const _default: _nuxt_schema0.NuxtModule<UnocssNuxtOptions, UnocssNuxtOptions, false>;
declare module '@nuxt/schema' {
interface NuxtConfig {
unocss?: UnocssNuxtOptions;
}
interface NuxtOptions {
unocss?: UnocssNuxtOptions;
}
}
//#endregion
export { UnocssNuxtOptions, _default as default };