Skip to content

Optional features

So-called "optional features" are disabled by default in Nuxt Ignis. You can turn them on via environment variables.

Presets

Some of the optional solutions are meant to be alternatives. Nuxt Ignis defines simplified configuration "presets" for such cases. Learn more about this concept in presets section.

However, you are not limited to presets only. Every optional module or feature can be enabled individually.

Optional modules

Currently, following modules are optional to use:

  • @nuxt/ui - set NUXT_PUBLIC_IGNIS_UI_UI to true | false
  • @nuxtjs/tailwindcss - set NUXT_PUBLIC_IGNIS_UI_TAILWIND to true | false (ignored if NUXT_PUBLIC_IGNIS_UI_UI=true)
  • nuxt-neon - set NUXT_PUBLIC_IGNIS_DB_NEON_ENABLED to true | false
  • @nuxtjs/supabase - set NUXT_PUBLIC_IGNIS_DB_SUPABASE_ENABLED to true | false
  • @vueform/nuxt - set NUXT_PUBLIC_IGNIS_FORMS_VUEFORM_ENABLED to true | false
  • @formkit/nuxt - set NUXT_PUBLIC_IGNIS_FORMS_FORMKIT_ENABLED to true | false
  • @nuxt/content - set NUXT_PUBLIC_IGNIS_CONTENT_CONTENT_ENABLED to true | false
  • @nuxtjs/i18n - set NUXT_PUBLIC_IGNIS_CONTENT_I18N_ENABLED to true | false
  • @nuxtjs/seo - set NUXT_PUBLIC_IGNIS_CONTENT_SEO_ENABLED to true | false
  • @stefanobartoletti/nuxt-social-share - set NUXT_PUBLIC_IGNIS_CONTENT_SOCIAL_ENABLED to true | false
  • magic-regexp - set NUXT_PUBLIC_IGNIS_UTILS_REGEXP_ENABLED to true | false
  • nuxt-charts - set NUXT_PUBLIC_IGNIS_UI_CHARTS to true | false

Default values are false (not included) for all optional modules.

Extra features

Currently, following extra features (not using separate Nuxt Modules) are optional:

  • zod - set NUXT_PUBLIC_IGNIS_VALIDATION_ZOD to true | false
  • valibot - set NUXT_PUBLIC_IGNIS_VALIDATION_VALIBOT to true | false
  • Open Props CSS - set NUXT_PUBLIC_IGNIS_UI_OPENPROPS to true | false
  • Vue Equipment - set NUXT_PUBLIC_IGNIS_UTILS_EQUIPMENT_ENABLED to true | false
  • elrh-pslo - set NUXT_PUBLIC_IGNIS_CONTENT_PSLO_ENABLED to true | false

Default values are false (not included) for all optional features.

nuxt.config.ts equivalent

All of the env variables above can equivalently be expressed via the ignis key in nuxt.config.ts:

nuxt.config.ts
ts
export default defineNuxtConfig({
  extends: ['nuxt-ignis'],
  ignis: {
    ui: {
      ui: true,
      tailwind: true,
      openprops: true,
      charts: true,
    },
    db: {
      neon: { enabled: true },
      supabase: { enabled: true },
    },
    forms: {
      vueform: { enabled: true },
      formkit: { enabled: true },
    },
    validation: {
      zod: true,
      valibot: true,
    },
    content: {
      content: { enabled: true },
      i18n: { enabled: true },
      seo: { enabled: true },
      social: { enabled: true },
      pslo: { enabled: true },
    },
    utils: {
      equipment: { enabled: true },
      regexp: { enabled: true },
    },
  },
})

More info