@nuxt/ui-pro/types/index.d.ts

Ship beautiful web applications at the speed of light with Nuxt UI Pro.

import type { Link as ULink, Avatar, Badge, Chip, Command, Tooltip } from '#ui/types'

export interface Link extends ULink {
  label: string
  class?: string
  click?: (...args: any[]) => void
}

export interface AsideLink extends Link {
  icon?: string
  iconClass?: string
}

export interface HeaderPopoverLink extends Link {
  description?: string
  icon?: string
  iconClass?: string
}

export interface HeaderLink extends Link {
  children?: HeaderPopoverLink[]
}

export interface FooterLink extends Link {
}

export interface PageLink extends Link {
  icon?: string
  iconClass?: string
  avatar?: Avatar
  avatarClass?: string
}

export interface NavigationLink extends Link {
  icon?: string
  iconClass?: string
  badge?: string | Badge
}

export interface NavigationTree extends NavigationLink {
  children?: NavigationTree[]
}

export interface NavigationGroup {
  type?: 'link' | 'accordion'
  defaultOpen?: boolean
  children: NavigationTree[]
}

export interface ContentSearchLink extends Link, Omit<Command, 'id'> {
}

export interface DashboardSidebarLink extends Link {
  labelClass?: string
  icon?: string
  iconClass?: string
  avatar?: Avatar
  avatarClass?: string
  chip?: string | Chip
  chipClass?: string
  badge?: string | number | Badge
  tooltip?: Tooltip
  defaultOpen?: boolean
  // Only applicable to links with children
  draggable?: boolean
  collapsible?: boolean
  children?: DashboardSidebarLink[]
}