Nuxt API reference

Source information

Package: @pikacss/nuxt-pikacss
Generated from the exported surface and JSDoc in packages/nuxt/src/index.ts.
Source files: packages/nuxt/src/index.ts

Package summary

Nuxt module for PikaCSS

Use Nuxt integration when you need conceptual usage guidance instead of exact symbol lookup.

Types

default

PikaCSS Nuxt module.

Integrates PikaCSS into a Nuxt application by registering a Vite plugin (with enforce: 'pre') and a Nuxt plugin template that imports the generated pika.css stylesheet.

Configure options under the pikacss key in nuxt.config. When no options are provided, the module scans **\/*.{js,ts,jsx,tsx,vue} by default.

ModuleOptions

Configuration options for the PikaCSS Nuxt module.

Remarks:

Mirrors the unplugin PluginOptions with currentPackageName omitted because the Nuxt module supplies it automatically.

// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@pikacss/nuxt-pikacss'],
  pikacss: {
    config: './pika.config.ts',
    scan: { include: ['**\/*.vue'] },
  },
})

Module augmentations

NuxtConfig (@nuxt/schema)

Property	Type	Description	Default
`pikacss?`	`ModuleOptions`	PikaCSS module options used during Nuxt configuration merging.	`undefined`

NuxtOptions (@nuxt/schema)

Property	Type	Description	Default
`pikacss?`	`ModuleOptions`	Resolved PikaCSS module options available at runtime on `nuxt.options`.	`undefined`

Nuxt API reference ​

Package summary ​

Types ​

default ​

ModuleOptions ​

Module augmentations ​

NuxtConfig (@nuxt/schema) ​

NuxtOptions (@nuxt/schema) ​