@gv-tech/ui-core 2.15.2 → 2.17.0

package/README.md

@@ -5,7 +5,7 @@ Shared component contracts, property types, and variants for the GV Tech design
 ## Installation
 
 ```bash
-yarn add @gv-tech/ui-core
+bun add @gv-tech/ui-core
 ```
 
 ## Usage

package/dist/index.d.ts

@@ -555,6 +555,12 @@ export declare interface FormMessageBaseProps {
     children?: React_2.ReactNode;
 }
 
+export declare interface HeadingItem {
+    id: string;
+    text: string;
+    level: number;
+}
+
 export declare interface HoverCardBaseProps {
     children?: React_2.ReactNode;
     open?: boolean;
@@ -859,6 +865,32 @@ export declare interface ScrollBarBaseProps {
     forceMount?: true;
 }
 
+export declare interface ScrollToTopBaseProps {
+    /**
+     * Number of pixels that must be scrolled before the control appears.
+     *
+     * @default 240
+     */
+    threshold?: number;
+    /**
+     * Delay in milliseconds before the page scroll-to-top is triggered,
+     * allowing the exit animation to complete first.
+     *
+     * @default 450
+     */
+    exitDuration?: number;
+    /**
+     * Scroll behavior used when returning to the top.
+     *
+     * @default 'smooth'
+     */
+    behavior?: ScrollBehavior;
+    /** Optional className for custom positioning and styling. */
+    className?: string;
+    /** Accessible label for the control. */
+    label?: string;
+}
+
 export declare interface SearchBaseProps {
     children?: React_2.ReactNode;
     open?: boolean;
@@ -1082,6 +1114,45 @@ export declare interface TableHeaderBaseProps {
     children?: React_2.ReactNode;
 }
 
+export declare interface TableOfContentsBaseProps {
+    /**
+     * Optional custom class name.
+     */
+    className?: string;
+    /**
+     * Optional currently active heading ID to override the intersection observer.
+     */
+    activeId?: string;
+    /**
+     * Optional minimum heading level to include.
+     * Default: 1 (h1)
+     */
+    minLevel?: number;
+    /**
+     * Optional maximum heading level to include.
+     * Default: 3 (h3)
+     */
+    maxLevel?: number;
+    /**
+     * The selector used to query the DOM for headings.
+     * Default: "h1, h2, h3, h4, h5, h6"
+     */
+    selector?: string;
+}
+
+export declare interface TableOfContentsContentBaseProps {
+    children: React_2.ReactNode;
+    className?: string;
+}
+
+export declare interface TableOfContentsListBaseProps {
+    className?: string;
+}
+
+export declare interface TableOfContentsRootBaseProps extends TableOfContentsBaseProps {
+    children: React_2.ReactNode;
+}
+
 export declare interface TableRowBaseProps {
     className?: string;
     children?: React_2.ReactNode;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gv-tech/ui-core",
-  "version": "2.15.2",
+  "version": "2.17.0",
   "description": "Shared component contracts (props, variants, sizes) for the GV Tech design system",
   "repository": {
     "type": "git",

package/src/contracts/scroll-to-top.ts

@@ -0,0 +1,25 @@
+export interface ScrollToTopBaseProps {
+  /**
+   * Number of pixels that must be scrolled before the control appears.
+   *
+   * @default 240
+   */
+  threshold?: number;
+  /**
+   * Delay in milliseconds before the page scroll-to-top is triggered,
+   * allowing the exit animation to complete first.
+   *
+   * @default 450
+   */
+  exitDuration?: number;
+  /**
+   * Scroll behavior used when returning to the top.
+   *
+   * @default 'smooth'
+   */
+  behavior?: ScrollBehavior;
+  /** Optional className for custom positioning and styling. */
+  className?: string;
+  /** Accessible label for the control. */
+  label?: string;
+}

package/src/contracts/table-of-contents.ts

@@ -0,0 +1,50 @@
+import * as React from 'react';
+
+export interface TableOfContentsBaseProps {
+  /**
+   * Optional custom class name.
+   */
+  className?: string;
+
+  /**
+   * Optional currently active heading ID to override the intersection observer.
+   */
+  activeId?: string;
+
+  /**
+   * Optional minimum heading level to include.
+   * Default: 1 (h1)
+   */
+  minLevel?: number;
+
+  /**
+   * Optional maximum heading level to include.
+   * Default: 3 (h3)
+   */
+  maxLevel?: number;
+
+  /**
+   * The selector used to query the DOM for headings.
+   * Default: "h1, h2, h3, h4, h5, h6"
+   */
+  selector?: string;
+}
+
+export interface TableOfContentsRootBaseProps extends TableOfContentsBaseProps {
+  children: React.ReactNode;
+}
+
+export interface TableOfContentsListBaseProps {
+  className?: string;
+}
+
+export interface TableOfContentsContentBaseProps {
+  children: React.ReactNode;
+  className?: string;
+}
+
+export interface HeadingItem {
+  id: string;
+  text: string;
+  level: number;
+}

package/src/index.ts

@@ -230,6 +230,9 @@ export type {
 // Scroll Area
 export type { ScrollAreaBaseProps, ScrollBarBaseProps } from './contracts/scroll-area';
 
+// Scroll To Top
+export type { ScrollToTopBaseProps } from './contracts/scroll-to-top';
+
 // Search
 export type { SearchBaseProps, SearchTriggerBaseProps } from './contracts/search';
 
@@ -325,3 +328,12 @@ export type { ThemeToggleBaseProps } from './contracts/theme-toggle';
 
 // Toaster
 export type { ToasterBaseProps } from './contracts/toaster';
+
+// TableOfContents
+export type {
+  HeadingItem,
+  TableOfContentsBaseProps,
+  TableOfContentsContentBaseProps,
+  TableOfContentsListBaseProps,
+  TableOfContentsRootBaseProps,
+} from './contracts/table-of-contents';