Package Exports

@maz-ui/themes
@maz-ui/themes/build
@maz-ui/themes/build/index
@maz-ui/themes/composables
@maz-ui/themes/composables/index
@maz-ui/themes/composables/useTheme
@maz-ui/themes/plugin
@maz-ui/themes/presets
@maz-ui/themes/presets/index
@maz-ui/themes/presets/mazUi
@maz-ui/themes/presets/obsidian
@maz-ui/themes/presets/ocean
@maz-ui/themes/presets/pristine
@maz-ui/themes/utils
@maz-ui/themes/utils/color-utils
@maz-ui/themes/utils/cookie-storage
@maz-ui/themes/utils/css-generator
@maz-ui/themes/utils/get-color-mode
@maz-ui/themes/utils/get-preset
@maz-ui/themes/utils/index
@maz-ui/themes/utils/no-transition
@maz-ui/themes/utils/preset-merger
@maz-ui/themes/utils/update-document-class

Readme

@maz-ui/themes

High-performance and typed theme system for Maz-UI.

Features

🎨 HSL CSS Variables - Uses HSL CSS variables for maximum flexibility
🌓 Automatic dark mode - Native dark mode support with prefers-color-scheme
🚀 Automatic generation - Automatically generates color variants (50-950)
⚡ Flexible strategies - Runtime, build-time or hybrid
🛡️ Strict TypeScript - Complete types for optimal DX
🎯 Zero FOUC - Critical CSS injected inline
🔧 Configurable presets - Ready-to-use and customizable presets

Installation

npm install @maz-ui/themes

Basic usage

1. Plugin installation

// main.ts
import { MazUiTheme } from '@maz-ui/themes/plugin'
import { mazUi } from '@maz-ui/themes/presets/mazUi'
import { createApp } from 'vue'

const app = createApp(App)

app.use(MazUiTheme, {
  preset: mazUi,
  strategy: 'hybrid',
  darkModeStrategy: 'class'
})

2. Usage in components

<script setup>
import { useTheme } from '@maz-ui/themes'

const { toggleDarkMode, isDark } = useTheme()
</script>

<template>
  <div class="maz-bg-background maz-text-foreground">
    <button
      class="maz-bg-primary maz-text-primary-foreground maz-rounded-[var(--radius)]"
      @click="toggleDarkMode"
    >
      Toggle Dark Mode
    </button>
  </div>
</template>

Available presets

Default

import { mazUi } from '@maz-ui/themes/presets/mazUi'

Pristine

import { pristine } from '@maz-ui/themes/presets/pristine'

Ocean

import { ocean } from '@maz-ui/themes/presets/ocean'

Obsidian

import { obsidian } from '@maz-ui/themes/presets/obsidian'

Creating custom presets

import { definePreset, mazUi } from '@maz-ui/themes'

const myPreset = definePreset({
  base: mazUi,
  overrides: {
    name: 'my-theme',
    radius: '0.75rem',
    colors: {
      light: {
        primary: '220 100% 50%',
        secondary: '210 40% 96%'
      },
      dark: {
        primary: '220 100% 70%',
        secondary: '210 40% 15%'
      }
    }
  }
})

Composable API

import { useTheme } from '@maz-ui/themes'

const {
  preset, // ComputedRef<ThemePreset>
  presetName, // ComputedRef<string>
  colorMode, // Ref<'light' | 'dark' | 'auto'>
  isDark, // ComputedRef<boolean>
  strategy, // ComputedRef<'runtime' | 'build' | 'hybrid'>
  updateTheme, // (preset: ThemePreset | ThemePresetName | ThemePresetOverrides) => void
  setColorMode, // (mode: 'light' | 'dark' | 'auto') => void
  toggleDarkMode, // () => void
} = useTheme()

Strategies

Runtime

CSS generated and injected dynamically on the client side.

Build

CSS generated at build-time and included in the bundle.

Hybrid (recommended)

Critical CSS injected inline, complete CSS loaded asynchronously.

Generated CSS variables

The system automatically generates:

Base color variables: --primary, --secondary, etc.
Color scales: --primary-50 to --primary-950
Design variables: --radius, --font-family
Dark mode support via .dark or @media (prefers-color-scheme: dark)

Build-time

import { buildThemeCSS, generateThemeBundle } from '@maz-ui/themes'

// CSS for a preset
const css = buildThemeCSS({
  preset: myPreset,
  darkModeStrategy: 'class',
  critical: true
})

// Bundle for multiple presets
const bundle = generateThemeBundle([mazUi, darkPreset], {
  darkModeStrategy: 'class'
})