@rimelight/ui 0.0.32 → 0.0.33

package/src/types/components/sidebar.ts

@@ -1,37 +1,72 @@
-export interface SidebarItem {
-  label: string
-  href?: string
-  icon?: string
-  badge?: string | number
-  active?: boolean
-  children?: SidebarItem[]
-}
-
-export interface SidebarProps {
-  /**
-   * The navigation links array.
-   */
-  items?: SidebarItem[]
-  /**
-   * Side of the page.
-   */
-  side?: "left" | "right"
-  /**
-   * Collapsible mode.
-   */
-  collapsible?: "icon" | "offcanvas" | "none"
-  /**
-   * Header logo or text.
-   */
-  logo?: string
-  /**
-   * Slot-specific CSS class overrides.
-   */
-  ui?: any
-  /**
-   * Additional CSS classes to apply to the root element.
-   */
-  class?: any
-  [key: string]: unknown
-}
-
+export interface BadgeConfig {
+  text: string
+  color?: string
+  variant?: 'solid' | 'outline' | 'soft' | 'note' | 'tip' | 'caution' | 'danger' | 'success' | 'default'
+  class?: string
+}
+
+export interface SidebarItem {
+  label: string
+  href?: string
+  icon?: string
+  badge?: string | BadgeConfig
+  active?: boolean
+  children?: SidebarItem[]
+  order?: number
+  autogenerate?: {
+    directory: string
+    collapsed?: boolean
+  }
+  collapsed?: boolean
+}
+
+export interface SidebarScope {
+  id: string
+  label: string
+  href: string
+  icon?: string
+  items?: SidebarItem[]
+}
+
+export interface TableOfContentsConfig {
+  minHeadingLevel?: number
+  maxHeadingLevel?: number
+}
+
+export interface EditLinkConfig {
+  baseUrl: string
+}
+
+export interface DocsConfig {
+  sidebar: (SidebarItem | SidebarScope)[]
+  editLink?: EditLinkConfig
+  tableOfContents?: false | TableOfContentsConfig
+}
+
+export interface SidebarProps {
+  /**
+   * The navigation links array.
+   */
+  items?: SidebarItem[]
+  /**
+   * Side of the page.
+   */
+  side?: "left" | "right"
+  /**
+   * Collapsible mode.
+   */
+  collapsible?: "icon" | "offcanvas" | "none"
+  /**
+   * Header logo or text.
+   */
+  logo?: string
+  /**
+   * Slot-specific CSS class overrides.
+   */
+  ui?: any
+  /**
+   * Additional CSS classes to apply to the root element.
+   */
+  class?: any
+  [key: string]: unknown
+}

package/src/types/components/slideover.ts

@@ -1,32 +1,31 @@
-export interface SlideoverProps {
-  /**
-   * The edge the sheet slides in from.
-   */
-  side?: "top" | "right" | "bottom" | "left"
-  /**
-   * Controlled open state.
-   */
-  open?: boolean
-  /**
-   * Title of the sheet.
-   */
-  title?: string
-  /**
-   * Description of the sheet contents.
-   */
-  description?: string
-  /**
-   * Label of the trigger button.
-   */
-  triggerLabel?: string
-  /**
-   * Slot-specific CSS class overrides.
-   */
-  ui?: any
-  /**
-   * Additional CSS classes to apply to the root element.
-   */
-  class?: any
-  [key: string]: unknown
-}
-
+export interface SlideoverProps {
+  /**
+   * The edge the sheet slides in from.
+   */
+  side?: "top" | "right" | "bottom" | "left"
+  /**
+   * Controlled open state.
+   */
+  open?: boolean
+  /**
+   * Title of the sheet.
+   */
+  title?: string
+  /**
+   * Description of the sheet contents.
+   */
+  description?: string
+  /**
+   * Label of the trigger button.
+   */
+  triggerLabel?: string
+  /**
+   * Slot-specific CSS class overrides.
+   */
+  ui?: any
+  /**
+   * Additional CSS classes to apply to the root element.
+   */
+  class?: any
+  [key: string]: unknown
+}

package/src/types/components/speed-dial.ts

@@ -1,11 +1,11 @@
-export interface SpeedDialProps {
-  /**
-   * Slot-specific CSS class overrides.
-   */
-  ui?: any
-  /**
-   * Additional CSS classes to apply to the root element.
-   */
-  class?: any
-  [key: string]: unknown
-}
+export interface SpeedDialProps {
+  /**
+   * Slot-specific CSS class overrides.
+   */
+  ui?: any
+  /**
+   * Additional CSS classes to apply to the root element.
+   */
+  class?: any
+  [key: string]: unknown
+}

package/src/types/components/spinner.ts

@@ -1,26 +1,25 @@
-import type { Theme } from "../theme"
-
-export interface SpinnerProps {
-  /**
-   * The size scale of the spinner.
-   */
-  size?: "xs" | "sm" | "md" | "lg" | "xl"
-  /**
-   * The color theme.
-   */
-  color?: "primary" | "secondary" | "success" | "warning" | "error" | "info" | "current"
-  /**
-   * Theme mode override — pins colors to flat, light, or dark mode.
-   */
-  theme?: Theme
-  /**
-   * Slot-specific CSS class overrides.
-   */
-  ui?: any
-  /**
-   * Additional CSS classes to apply to the root element.
-   */
-  class?: any
-  [key: string]: unknown
-}
-
+import type { Theme } from "../theme"
+
+export interface SpinnerProps {
+  /**
+   * The size scale of the spinner.
+   */
+  size?: "xs" | "sm" | "md" | "lg" | "xl"
+  /**
+   * The color theme.
+   */
+  color?: "primary" | "secondary" | "success" | "warning" | "error" | "info" | "current"
+  /**
+   * Theme mode override — pins colors to flat, light, or dark mode.
+   */
+  theme?: Theme
+  /**
+   * Slot-specific CSS class overrides.
+   */
+  ui?: any
+  /**
+   * Additional CSS classes to apply to the root element.
+   */
+  class?: any
+  [key: string]: unknown
+}

package/src/types/components/splitter.ts

@@ -1,20 +1,19 @@
-export interface SplitterProps {
-  /**
-   * Resizing orientation.
-   */
-  direction?: "horizontal" | "vertical"
-  /**
-   * Panel sizes array in percentage.
-   */
-  defaultSizes?: number[]
-  /**
-   * Slot-specific CSS class overrides.
-   */
-  ui?: any
-  /**
-   * Additional CSS classes to apply to the root element.
-   */
-  class?: any
-  [key: string]: unknown
-}
-
+export interface SplitterProps {
+  /**
+   * Resizing orientation.
+   */
+  direction?: "horizontal" | "vertical"
+  /**
+   * Panel sizes array in percentage.
+   */
+  defaultSizes?: number[]
+  /**
+   * Slot-specific CSS class overrides.
+   */
+  ui?: any
+  /**
+   * Additional CSS classes to apply to the root element.
+   */
+  class?: any
+  [key: string]: unknown
+}

package/src/types/components/spoiler.ts

@@ -1,11 +1,11 @@
-export interface SpoilerProps {
-  /**
-   * Slot-specific CSS class overrides.
-   */
-  ui?: any
-  /**
-   * Additional CSS classes to apply to the root element.
-   */
-  class?: any
-  [key: string]: unknown
-}
+export interface SpoilerProps {
+  /**
+   * Slot-specific CSS class overrides.
+   */
+  ui?: any
+  /**
+   * Additional CSS classes to apply to the root element.
+   */
+  class?: any
+  [key: string]: unknown
+}

package/src/types/components/stepper.ts

@@ -1,11 +1,11 @@
-export interface StepperProps {
-  /**
-   * Slot-specific CSS class overrides.
-   */
-  ui?: any
-  /**
-   * Additional CSS classes to apply to the root element.
-   */
-  class?: any
-  [key: string]: unknown
-}
+export interface StepperProps {
+  /**
+   * Slot-specific CSS class overrides.
+   */
+  ui?: any
+  /**
+   * Additional CSS classes to apply to the root element.
+   */
+  class?: any
+  [key: string]: unknown
+}

package/src/types/components/sticky-surface.ts

@@ -1,20 +1,19 @@
-export interface StickySurfaceProps {
-  /**
-   * Pixels offset from top when sticky.
-   */
-  offsetTop?: number
-  /**
-   * Z-index layer depth.
-   */
-  zIndex?: number
-  /**
-   * Slot-specific CSS class overrides.
-   */
-  ui?: any
-  /**
-   * Additional CSS classes to apply to the root element.
-   */
-  class?: any
-  [key: string]: unknown
-}
-
+export interface StickySurfaceProps {
+  /**
+   * Pixels offset from top when sticky.
+   */
+  offsetTop?: number
+  /**
+   * Z-index layer depth.
+   */
+  zIndex?: number
+  /**
+   * Slot-specific CSS class overrides.
+   */
+  ui?: any
+  /**
+   * Additional CSS classes to apply to the root element.
+   */
+  class?: any
+  [key: string]: unknown
+}

package/src/types/components/switch.ts

@@ -1,42 +1,41 @@
-import type { Theme } from "../theme"
-
-export interface SwitchProps {
-  /**
-   * Controlled checked state.
-   */
-  checked?: boolean
-  /**
-   * Disabled state.
-   */
-  disabled?: boolean
-  /**
-   * Input element name.
-   */
-  name?: string
-  /**
-   * Label descriptor.
-   */
-  label?: string
-  /**
-   * Size scale.
-   */
-  size?: "sm" | "md" | "lg"
-  /**
-   * Color theme.
-   */
-  color?: "primary" | "secondary" | "success" | "warning" | "error" | "info"
-  /**
-   * Theme mode override — pins colors to flat, light, or dark mode.
-   */
-  theme?: Theme
-  /**
-   * Slot-specific CSS class overrides.
-   */
-  ui?: any
-  /**
-   * Additional CSS classes to apply to the root element.
-   */
-  class?: any
-  [key: string]: unknown
-}
-
+import type { Theme } from "../theme"
+
+export interface SwitchProps {
+  /**
+   * Controlled checked state.
+   */
+  checked?: boolean
+  /**
+   * Disabled state.
+   */
+  disabled?: boolean
+  /**
+   * Input element name.
+   */
+  name?: string
+  /**
+   * Label descriptor.
+   */
+  label?: string
+  /**
+   * Size scale.
+   */
+  size?: "sm" | "md" | "lg"
+  /**
+   * Color theme.
+   */
+  color?: "primary" | "secondary" | "success" | "warning" | "error" | "info"
+  /**
+   * Theme mode override — pins colors to flat, light, or dark mode.
+   */
+  theme?: Theme
+  /**
+   * Slot-specific CSS class overrides.
+   */
+  ui?: any
+  /**
+   * Additional CSS classes to apply to the root element.
+   */
+  class?: any
+  [key: string]: unknown
+}

package/src/types/components/table-of-contents.ts

@@ -1,11 +1,17 @@
-export interface TableOfContentsProps {
-  /**
-   * Slot-specific CSS class overrides.
-   */
-  ui?: any
-  /**
-   * Additional CSS classes to apply to the root element.
-   */
-  class?: any
-  [key: string]: unknown
-}
+export interface TableOfContentsProps {
+  /**
+   * The component the root element should render as.
+   *
+   * @default "div"
+   */
+  as?: any
+  /**
+   * Slot-specific CSS class overrides.
+   */
+  ui?: any
+  /**
+   * Additional CSS classes to apply to the root element.
+   */
+  class?: any
+  [key: string]: unknown
+}

package/src/types/components/theme-selector.ts

@@ -1,15 +1,15 @@
 export interface ThemeSelectorProps {
-    /**
-     * The size of the button.
-     */
-    size?: "xs" | "sm" | "md" | "lg" | "xl";
-    /**
-     * Slot-specific CSS class overrides.
-     */
-    ui?: any
-    /**
-     * Additional CSS classes to apply to the root element.
-     */
-    class?: any
-    [key: string]: unknown
+  /**
+   * The size of the button.
+   */
+  size?: "xs" | "sm" | "md" | "lg" | "xl"
+  /**
+   * Slot-specific CSS class overrides.
+   */
+  ui?: any
+  /**
+   * Additional CSS classes to apply to the root element.
+   */
+  class?: any
+  [key: string]: unknown
 }

package/src/types/components/timeline.ts

@@ -1,11 +1,11 @@
-export interface TimelineProps {
-  /**
-   * Slot-specific CSS class overrides.
-   */
-  ui?: any
-  /**
-   * Additional CSS classes to apply to the root element.
-   */
-  class?: any
-  [key: string]: unknown
-}
+export interface TimelineProps {
+  /**
+   * Slot-specific CSS class overrides.
+   */
+  ui?: any
+  /**
+   * Additional CSS classes to apply to the root element.
+   */
+  class?: any
+  [key: string]: unknown
+}

package/src/types/components/tooltip.ts

@@ -1,24 +1,23 @@
-export interface TooltipProps {
-  /**
-   * The text content to display inside the tooltip.
-   */
-  content?: string
-  /**
-   * Controlled open state.
-   */
-  open?: boolean
-  /**
-   * Placement of the tooltip relative to the trigger.
-   */
-  placement?: "top" | "bottom" | "left" | "right"
-  /**
-   * Slot-specific CSS class overrides.
-   */
-  ui?: any
-  /**
-   * Additional CSS classes to apply to the root element.
-   */
-  class?: any
-  [key: string]: unknown
-}
-
+export interface TooltipProps {
+  /**
+   * The text content to display inside the tooltip.
+   */
+  content?: string
+  /**
+   * Controlled open state.
+   */
+  open?: boolean
+  /**
+   * Placement of the tooltip relative to the trigger.
+   */
+  placement?: "top" | "bottom" | "left" | "right"
+  /**
+   * Slot-specific CSS class overrides.
+   */
+  ui?: any
+  /**
+   * Additional CSS classes to apply to the root element.
+   */
+  class?: any
+  [key: string]: unknown
+}

package/src/types/components/tour.ts

@@ -1,11 +1,11 @@
-export interface TourProps {
-  /**
-   * Slot-specific CSS class overrides.
-   */
-  ui?: any
-  /**
-   * Additional CSS classes to apply to the root element.
-   */
-  class?: any
-  [key: string]: unknown
-}
+export interface TourProps {
+  /**
+   * Slot-specific CSS class overrides.
+   */
+  ui?: any
+  /**
+   * Additional CSS classes to apply to the root element.
+   */
+  class?: any
+  [key: string]: unknown
+}

package/src/types/components/tree.ts

@@ -1,11 +1,11 @@
-export interface TreeProps {
-  /**
-   * Slot-specific CSS class overrides.
-   */
-  ui?: any
-  /**
-   * Additional CSS classes to apply to the root element.
-   */
-  class?: any
-  [key: string]: unknown
-}
+export interface TreeProps {
+  /**
+   * Slot-specific CSS class overrides.
+   */
+  ui?: any
+  /**
+   * Additional CSS classes to apply to the root element.
+   */
+  class?: any
+  [key: string]: unknown
+}

package/src/types/components/user.ts

@@ -1,11 +1,11 @@
-export interface UserProps {
-  /**
-   * Slot-specific CSS class overrides.
-   */
-  ui?: any
-  /**
-   * Additional CSS classes to apply to the root element.
-   */
-  class?: any
-  [key: string]: unknown
-}
+export interface UserProps {
+  /**
+   * Slot-specific CSS class overrides.
+   */
+  ui?: any
+  /**
+   * Additional CSS classes to apply to the root element.
+   */
+  class?: any
+  [key: string]: unknown
+}