@colorffy/ui

A modern Nuxt / Vue 3 component library built with TypeScript. Features a comprehensive collection of unstyled, headless UI components with full TypeScript support. Designed to work seamlessly with Colorffy CSS (optional) or your own custom styles.

✨ Features

• ✨ 70+ Vue 3 Components - Accordion, Alerts, Buttons, Cards, Dialogs, Forms, Navigation, and more
• 🎨 Style-Agnostic - Use with Colorffy CSS or bring your own styles
• 📘 Full TypeScript Support - Complete type definitions for all components
• 🔌 Flexible Installation - Use globally or import individually
• 🚀 Tree-shakeable - Import only what you need
• ⚡ Nuxt 3 Compatible - Works seamlessly with Nuxt applications
• 🎯 Headless Architecture - Full control over styling and behavior

📦 Installation

Install Colorffy UI

# npm
npm install @colorffy/ui

# yarn
yarn add @colorffy/ui

# pnpm
pnpm add @colorffy/ui

Install Peer Dependencies

Colorffy UI requires the following peer dependencies:

npm install @vueuse/components floating-vue vue

Install Colorffy CSS (Optional, Recommended)

For pre-built, beautiful styling that works out of the box:

npm install @colorffy/css

Note: Colorffy UI components are unstyled by default. You can use Colorffy CSS for instant styling, or provide your own custom styles.

🎨 Styling Options

Option 1: Use Colorffy CSS (Recommended)

Import the compiled CSS in your main.ts:

import ColorffyUI from '@colorffy/ui'
import { createApp } from 'vue'
import App from './App.vue'
import '@colorffy/css' // Import styles

const app = createApp(App)
app.use(ColorffyUI)
app.mount('#app')

Option 2: Customize Colorffy CSS with SCSS

For full customization, use SCSS to override variables:

// src/assets/variables.scss
// Override Colorffy CSS variables
@forward '@colorffy/css/scss/abstracts/variables' with (
  $primary: #4f46e5,
  $secondary: #ec4899,
  $accent: #0ea5e9,
);

// Import the framework
@use '@colorffy/css/scss/main';

// src/assets/main.scss
@use 'variables' as *;

// Your custom styles
:root {
  --custom-var: value;
}

import ColorffyUI from '@colorffy/ui'
// main.ts
import { createApp } from 'vue'
import App from './App.vue'
import './assets/main.scss' // Import customized styles

const app = createApp(App)
app.use(ColorffyUI)
app.mount('#app')

Option 3: Custom Styles

Use Colorffy UI components without any styling framework. Components use semantic class names like .btn, .card, .alert, etc. that you can style however you want:

/* your-custom-styles.css */
.btn {
  padding: 0.5rem 1rem;
  border-radius: 0.25rem;
  /* Your custom button styles */
}

.card {
  background: white;
  border: 1px solid #e5e7eb;
  /* Your custom card styles */
}

For more details on Colorffy CSS customization, see the Colorffy CSS README.

🚀 Usage

Option 1: Global Registration (Recommended for most cases)

Register all components globally in your main.ts:

import ColorffyUI from '@colorffy/ui'
import { createApp } from 'vue'
import App from './App.vue'

const app = createApp(App)
app.use(ColorffyUI)
app.mount('#app')

Then use components anywhere without imports:

<template>
  <div>
    <UiButton variant="filled" color="primary" text="Click me!" />
    <UiCard>
      <template #body>
        <h2>Card Content</h2>
      </template>
    </UiCard>
  </div>
</template>

Option 2: Individual Component Imports (Better for tree-shaking)

Import only the components you need:

<script setup lang="ts">
import { UiAlert, UiButton, UiCard } from '@colorffy/ui'
</script>

<template>
  <div>
    <UiButton variant="filled" color="primary" text="Click me!" />
    <UiCard>
      <template #body>
        <h2>Card Content</h2>
      </template>
    </UiCard>
    <UiAlert
      type="banner"
      variant="success"
      message="Operation successful!"
    />
  </div>
</template>

Option 3: Selective Global Registration

Register only specific components globally:

import { UiAlert, UiButton, UiCard } from '@colorffy/ui'
import { createApp } from 'vue'
import App from './App.vue'

const app = createApp(App)

// Register only needed components
app.component('UiButton', UiButton)
app.component('UiCard', UiCard)
app.component('UiAlert', UiAlert)

app.mount('#app')

🚀 Nuxt 3 Usage

Install Dependencies

npm install @colorffy/ui @colorffy/css

Setup with Colorffy CSS

Add Colorffy CSS to your nuxt.config.ts:

export default defineNuxtConfig({
  css: ['@colorffy/css']
})

Global Registration with Nuxt Plugin

Create a plugin file plugins/colorffy-ui.ts:

import ColorffyUI from '@colorffy/ui'

export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.vueApp.use(ColorffyUI)
})

Customize with SCSS (Advanced)

For full SCSS customization in Nuxt:

// nuxt.config.ts
export default defineNuxtConfig({
  css: ['~/assets/scss/main.scss'],
  vite: {
    css: {
      preprocessorOptions: {
        scss: {
          additionalData: '@use "~/assets/scss/variables.scss" as *;'
        }
      }
    }
  }
})

// assets/scss/variables.scss
@forward '@colorffy/css/scss/abstracts/variables' with (
  $primary: #4f46e5,
  $secondary: #ec4899,
  $accent: #0ea5e9,
);

@use '@colorffy/css/scss/main';

Then use components anywhere in your Nuxt app:

<template>
  <div>
    <UiButton variant="filled" color="primary" text="Click me!" />
    <UiCard>
      <template #body>
        <h2>Card Content</h2>
      </template>
    </UiCard>
  </div>
</template>

Individual Component Imports in Nuxt

Import components directly in your pages/components:

<script setup lang="ts">
import { UiAlert, UiButton, UiCard } from '@colorffy/ui'
</script>

<template>
  <div>
    <UiButton variant="filled" color="primary" text="Click me!" />
    <UiCard>
      <template #body>
        <h2>Card Content</h2>
      </template>
    </UiCard>
  </div>
</template>

Auto-imports (Optional)

To enable auto-imports in Nuxt, add to your nuxt.config.ts:

export default defineNuxtConfig({
  components: [
    {
      path: 'node_modules/@colorffy/ui/dist',
      pattern: '**/*.vue',
      pathPrefix: false
    }
  ]
})

💻 Component Categories

Layout Components

• UiHeaderContent - Page header with title and subtitle
• UiPaneContent - Content container/pane

UI Components

Accordion

• UiAccordion - Single accordion item
• UiAccordionGroup - Group of accordion items

Alerts

• UiAlert - Alert/notification component
• UiAlertToast - Toast notification

Badges

• UiBadge - Badge/tag component
• UiBadgeGroup - Group of badges

Buttons

• UiButton - Standard button
• UiButtonMenu - Button with dropdown menu
• UiButtonMenuDivider - Menu divider
• UiButtonMenuItem - Menu item
• UiButtonMenuSubmenu - Dropdown submenu item
• UiButtonMenuText - Menu text item
• UiButtonToggleGroup - Toggle button group
• UiButtonTooltip - Button with tooltip

Cards

• UiCard - Card container

Chips

• UiChip - Interactive chip (filter, input, or plain)
• UiChipGroup - Chip group with single/multiple selection (v-model)

Dialogs

• UiModal - Modal dialog
• UiConfirmModal - Confirmation modal

Dividers

• UiDivider - Horizontal, labelled, or vertical separator

Icons

• UiIconMaterial - Material Symbols (icon font glyph via iconCode)
• UiIconShapes - Decorative geometric shapes
• UiIconSvg - Wrapper for any inline SVG (paste into the slot, or pass content)

Images

• UiAvatar - Avatar component
• UiAvatarGroup - Stacks avatars with overlapping ring, max collapses overflow into "+N"

Form Inputs

• UiInputCheck - Checkbox input
• UiInputColorPicker - Color picker
• UiInputFile - File upload
• UiInputOtp - Segmented OTP/PIN code input
• UiInputPhoneNumber - Phone number input
• UiInputRadio - Radio button
• UiInputRange - Range slider
• UiInputSelect - Select dropdown
• UiInputText - Text input
• UiInputTextarea - Textarea input

Links

• UiLinkTooltip - Link with tooltip

Tooltips

• UiTooltip - Generic tooltip wrapper for any trigger element

Lists

• UiListGroup - List container
• UiListItem - List item

Navigation

• UiBreadcrumb - SEO-friendly breadcrumb trail (JSON-LD)
• UiNavbarLink - Navbar link
• UiNavigationBar - Navigation bar
• UiPopoverMenu - Popover menu
• UiSegmentedControls - Segmented control
• UiTabs - Tab navigation

Sidebar (Navigation Drawer)

• UiSidebar - Drawer container (compact rail + responsive open)
• UiSidebarHeader / UiSidebarBody / UiSidebarFooter - Drawer regions
• UiSidebarGroup - Grouped links (optionally collapsible)
• UiSidebarLink - Drawer navigation link (polymorphic as)
• UiSidebarText - Section label
• UiSidebarDropdown - Header/footer dropdown

Steppers

• UiStepper - Horizontal/vertical step progress indicator (upcoming/current/completed, optional linear mode)

Tables

• UiDatatable - Data table component

Timeline

• UiTimeline - Chronological event feed (dot/icon/image markers + connector line)

State Components

• UiBaseSkeleton - Basic skeleton loader
• UiEmpty - Empty state
• UiExpressiveLoading - Expressive loading animation
• UiGridSkeleton - Grid skeleton loader
• UiLoading - Loading spinner
• UiShapeLoading - Shape loading animation
• UiTableSkeleton - Table skeleton loader

💻 Composables

The library also exports useful composables:

import { useDateUtils, useTextUtils, useToast } from '@colorffy/ui'
import { ref } from 'vue'

// Show toast notifications - pass a ref to a mounted UiAlertToast
const toastRef = ref(null)
const toast = useToast(toastRef)
toast.success('Success!')
toast.warning('Careful!')
toast.danger('Something went wrong.')
toast.info('Heads up.')
toast.primary('Welcome back!')

// Date utilities
const dateUtils = useDateUtils()

// Text utilities
const textUtils = useTextUtils()

💻 Component Examples

Button

<template>
  <!-- Filled buttons -->
  <UiButton variant="filled" text="Primary" />
  <UiButton variant="filled" color="success" text="Success" />
  <UiButton variant="filled" color="danger" text="Danger" />

  <!-- Tonal buttons -->
  <UiButton variant="tonal" color="primary" text="Tonal" />

  <!-- Outline buttons -->
  <UiButton variant="outline" text="Outline" />

  <!-- With icon -->
  <UiButton variant="filled" text="With Icon">
    <template #icon>
      <UiIconMaterial icon-code="&#xe000;" />
    </template>
  </UiButton>

  <!-- Sizes -->
  <UiButton variant="filled" size="sm" text="Small" />
  <UiButton variant="filled" size="md" text="Medium" />
  <UiButton variant="filled" size="lg" text="Large" />

  <!-- Loading state -->
  <UiButton variant="filled" :loading="true" text="Loading" />
</template>

Alert

<template>
  <UiAlert
    type="banner"
    variant="success"
    title="Success!"
    message="Your operation completed successfully."
  />

  <UiAlert
    type="snackbar"
    variant="warning"
    message="Warning message"
  />

  <UiAlert
    type="tonal"
    variant="danger"
    title="Error"
    message="Something went wrong."
    :critical="true"
  />
</template>

Card

<template>
  <UiCard variant="pane">
    <template #body>
      <h3>Card Title</h3>
      <p>Card content goes here...</p>
    </template>
  </UiCard>
</template>

Accordion

<template>
  <UiAccordionGroup>
    <UiAccordion title="Section 1" name="accordion-demo">
      <template #content>
        <p>Content for section 1</p>
      </template>
    </UiAccordion>

    <UiAccordion title="Section 2" name="accordion-demo">
      <template #content>
        <p>Content for section 2</p>
      </template>
    </UiAccordion>
  </UiAccordionGroup>
</template>

Form Inputs

<template>
  <UiInputText
    v-model="name"
    label="Name"
    placeholder="Enter your name"
  />

  <UiInputSelect
    v-model="selected"
    :options="options"
    label="Choose option"
  />

  <UiInputCheck
    v-model="agree"
    label="I agree to terms"
  />
</template>

Datatable

Columns are defined explicitly. Each column's key is the data field on every row object, the cell slot (cell-<key>), and the sort key; label is the text shown in the header — keeping them separate makes i18n and runtime label changes trivial. Per-column sortable, hidden, and align replace the older parallel unsortableColumns / hiddenColumns arrays.

<script setup lang="ts">
import type { IDatatableColumn } from '@colorffy/ui'

const columns: IDatatableColumn[] = [
  { key: 'id', label: 'ID', hidden: true }, // starts hidden, toggleable via column manager
  { key: 'name', label: 'Name' },
  { key: 'email', label: 'Email' },
  { key: 'role', label: 'Role' },
  { key: 'total', label: 'Total', align: 'end' },
  { key: 'actions', label: 'Actions', sortable: false }
]

const items = [
  { id: 1, name: 'John Doe', email: '[email protected]', role: 'Admin', total: 1280 },
  { id: 2, name: 'Jane Smith', email: '[email protected]', role: 'User', total: 940 }
]
</script>

<template>
  <UiDatatable
    :columns="columns"
    :items="items"
    default-sort-key="name"
    table-class="table-bordered"
    column-manager
  >
    <!-- Custom cell rendering: the slot name is `cell-<key>` -->
    <template #cell-actions="{ item }">
      <UiButton variant="outline" size="sm" :text="`Edit ${item.name}`" />
    </template>
  </UiDatatable>
</template>

Key props: columns (IDatatableColumn[]), items, sortable, default-sort-key (a column key), column-manager, is-loading / skeleton-rows (built-in loading state), caption, row-key, selectable / selected (v-model:selected, row-selection checkbox column), sticky-header (sticks the header while the body scrolls), and empty-state-* (built-in empty state).

Breadcrumb

SEO-friendly breadcrumb trail. Pass an ordered items list (root → current); the last item is auto-marked as the current page (aria-current="page", rendered as plain text). By default it emits a schema.org BreadcrumbList as inline JSON-LD for rich results — set base-url so the URLs are absolute. Long trails collapse with max-items (visual only; the JSON-LD keeps the full trail).

<script setup lang="ts">
import type { IBreadcrumbItem } from '@colorffy/ui'
import { NuxtLink } from '#components'

const items: IBreadcrumbItem[] = [
  { label: 'Home', to: '/', icon: '&#xe88a;' },
  { label: 'Projects', to: '/projects' },
  { label: 'Atlas' } // no `to` → current page
]
</script>

<template>
  <UiBreadcrumb
    :as="NuxtLink"
    :items="items"
    base-url="https://example.com"
    separator-icon="&#xe5cc;"
  />
</template>

Key props: items (IBreadcrumbItem[] — { label, to?, href?, icon?, current? }), as (polymorphic link: 'a' / NuxtLink / router-link), separator / separatorIcon, base-url (absolute URLs for the JSON-LD), structured-data (default true; disable to feed your own useHead), max-items (collapse long trails), and ariaLabel. Emits: itemClick(item, index). Slots: #item="{ item, index, isCurrent }", #separator.

Sidebar (Navigation Drawer)

The sidebar separates two independent states:

• rail — compact, icons-only mode (a desktop concern). One-way; the parent controls it (e.g. from a UiNavbarToggle), so it has no update:rail emit.
• open — the responsive mobile slide-in. On desktop the drawer is always visible, so open only drives the show/hide on small screens. Supports v-model:open; the dimmed overlay renders while open and emits update:open when dismissed.

<script setup lang="ts">
import { NuxtLink } from '#components'
import { ref } from 'vue'

const rail = ref(false) // compact (desktop)
const open = ref(false) // mobile drawer (responsive)
</script>

<template>
  <UiSidebar
    bordered
    :rail="rail"
    v-model:open="open"
    aria-label="Main navigation"
  >
    <UiSidebarHeader>
      <UiSidebarDropdown title="Acme" subtitle="Workspace" />
    </UiSidebarHeader>

    <UiSidebarBody>
      <UiSidebarText text="Platform" />
      <UiSidebarLink :as="NuxtLink" to="/" text="Home" icon="&#xe88a;" tooltip-text="Home" />
      <UiSidebarLink :as="NuxtLink" to="/projects" text="Projects" icon="&#xe8ef;" />

      <!-- Collapsible group of nested (child) links -->
      <UiSidebarGroup text="Account" collapsible :default-open="true" icon="&#xe853;">
        <UiSidebarLink :as="NuxtLink" to="/account" text="Profile" icon="&#xe853;" child />
        <UiSidebarLink :as="NuxtLink" to="/notifications" text="Notifications" icon="&#xe7f4;" child />
      </UiSidebarGroup>
    </UiSidebarBody>

    <UiSidebarFooter>
      <UiBadge text="v1.0.0" variant="outline" size="sm" />
    </UiSidebarFooter>
  </UiSidebar>
</template>

Wire open to a toggle (e.g. in the navbar) for the mobile drawer:

<UiNavbarToggle :collapsed="open" @toggle="open = !open" />

UiSidebar props: bordered, rail (compact, one-way), open (v-model:open), width (sets --theme-nav-drawer-width), ariaLabel (landmark name), customClass. Emits: update:open.

🏗️ TypeScript Support

All components come with full TypeScript support. Import types as needed:

import type {
  AlertType,
  AlertVariant,
  ButtonColor,
  ButtonVariant
} from '@colorffy/ui'

// Use in your components
const variant: ButtonVariant = 'filled'
const color: ButtonColor = 'primary'

🎨 Styling

With Colorffy CSS (Recommended)

Colorffy UI is designed to work seamlessly with Colorffy CSS, which provides:

• Modern, responsive design system
• Consistent color palette with tonal variants
• Pre-built component styles
• Utility classes for rapid development
• Customizable themes with SCSS variables

Install Colorffy CSS and import it in your app:

npm install @colorffy/css

// main.ts
import '@colorffy/css'

Custom Styling

All components use semantic class names that you can style:

/* Component classes */
.btn { /* Button styles */ }
.btn.btn-filled { /* Filled variant */ }
.btn.btn-primary { /* Primary color */ }

.card { /* Card styles */ }
.card.card-pane { /* Pane variant */ }

.alert { /* Alert styles */ }
.alert.alert-success { /* Success variant */ }

/* And more... */

CSS Variable Overrides

Override CSS custom properties for runtime theming:

:root {
  /* Theme colors */
  --theme-primary-base: #4f46e5;
  --theme-secondary-base: #ec4899;

  /* Component variables */
  --_btn-radius: 50px;
  --_card-bg-color: #ffffff;
}

For complete styling documentation, see the Colorffy CSS README.

🔍 Browser Support

• Chrome (latest)
• Firefox (latest)
• Safari (latest)
• Edge (latest)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

📄 License

MIT © Giancarlos Garza

Author

Giancarlos Garza

⭐ Show your support

• Colorffy UI
• Colorffy CSS

Give a ⭐️ if this project helped you!

Made with ❤️ by Giancarlos Garza using Vue 3 and TypeScript.

Powered by Colorffy 🎨