PikaCSS

Appearance

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. Re-exports the public surface of @pikacss/unplugin-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 the optional project config path under the pikacss key in nuxt.config. Nuxt always anchors the adapter at nuxt.options.rootDir; source semantics and generated outputs remain owned by Integration.

Type: NuxtModule<ModuleOptions>



ModuleOptions ​

Configuration options for the PikaCSS Nuxt module.

PropertyTypeDescriptionDefault
config?stringExplicit PikaCSS project config path resolved from Nuxt's project root.—

Remarks:

The Nuxt module accepts only an explicit project config path. Nuxt supplies the project root from nuxt.options.rootDir to the host adapter.

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


Module augmentations ​

NuxtConfig (@nuxt/schema) ​

PropertyTypeDescriptionDefault
pikacss?ModuleOptionsPikaCSS module options used during Nuxt configuration merging.undefined

NuxtOptions (@nuxt/schema) ​

PropertyTypeDescriptionDefault
pikacss?ModuleOptionsResolved PikaCSS module options available at runtime on nuxt.options.undefined

Next ​