@nxgt/material 1.0.4 → 1.1.0

package/dist/lib/components/index.d.ts

@@ -2,6 +2,9 @@ export * from './ui/accordion';
 export * from './ui/accordion-card';
 export * from './ui/action-card';
 export * from './ui/activity';
+export * from './ui/anchor-heading';
+export * from './ui/api-endpoint';
+export * from './ui/api-operation';
 export * from './ui/app-bar';
 export * from './ui/app-shell';
 export * from './ui/attributes';
@@ -16,6 +19,7 @@ export * from './ui/breadcrumb';
 export * from './ui/buttons';
 export * from './ui/calendar';
 export * from './ui/card';
+export * from './ui/cards';
 export * from './ui/carousel';
 export * from './ui/charts';
 export * from './ui/chat';
@@ -42,6 +46,7 @@ export * from './ui/date-range-field';
 export * from './ui/description';
 export * from './ui/dialog';
 export * from './ui/dnd';
+export * from './ui/doc';
 export * from './ui/drawer';
 export * from './ui/dropdown-menu';
 export * from './ui/duration-field';
@@ -53,12 +58,15 @@ export * from './ui/event-chip';
 export * from './ui/extended-label';
 export * from './ui/feedback';
 export * from './ui/field';
+export * from './ui/figure';
 export * from './ui/file-list';
 export * from './ui/filter';
 export * from './ui/forms';
 export * from './ui/galleries';
 export * from './ui/helper-text';
+export * from './ui/hero';
 export * from './ui/hidrate-loading';
+export * from './ui/highlight-text';
 export * from './ui/hover-card';
 export * from './ui/icon';
 export * from './ui/image-cropper';
@@ -76,12 +84,15 @@ export * from './ui/layout';
 export * from './ui/list-tile';
 export * from './ui/load-more-button';
 export * from './ui/menubar';
+export * from './ui/metrics';
 export * from './ui/navigation-rail';
 export * from './ui/notifications';
 export * from './ui/number-field';
 export * from './ui/opening-hours';
 export * from './ui/otp-field';
+export * from './ui/pager';
 export * from './ui/pagination';
+export * from './ui/param-table';
 export * from './ui/password-field';
 export * from './ui/pdf-viewer';
 export * from './ui/percent-field';
@@ -97,6 +108,7 @@ export * from './ui/responsive-grid';
 export * from './ui/rich-text-editor';
 export * from './ui/scroll-to-top';
 export * from './ui/search-field';
+export * from './ui/see-also';
 export * from './ui/select';
 export * from './ui/select-card-field';
 export * from './ui/select-chip-field';
@@ -105,11 +117,13 @@ export * from './ui/separator';
 export * from './ui/sheet';
 export * from './ui/sidebar';
 export * from './ui/skeleton';
+export * from './ui/skip-link';
 export * from './ui/slider';
 export * from './ui/sortable-list';
 export * from './ui/stat-card';
 export * from './ui/status-indicator';
 export * from './ui/stepper';
+export * from './ui/steps';
 export * from './ui/stx-player';
 export * from './ui/summary-data';
 export * from './ui/switch';
@@ -124,6 +138,7 @@ export * from './ui/time-field';
 export * from './ui/time-picker';
 export * from './ui/timeline';
 export * from './ui/timezone-field';
+export * from './ui/toc';
 export * from './ui/toggle';
 export * from './ui/toggle-group';
 export * from './ui/tooltip';

package/dist/lib/components/ui/anchor-heading.d.ts

@@ -0,0 +1,9 @@
+import { ComponentProps, ReactNode } from 'react';
+export { headingText } from './anchor-heading.utils';
+export type AnchorHeadingProps = {
+    level?: 1 | 2 | 3 | 4;
+    id?: string;
+    children?: ReactNode;
+    className?: string;
+} & Omit<ComponentProps<'h2'>, 'children'>;
+export declare function AnchorHeading({ level, id, children, className, ...props }: AnchorHeadingProps): import("react").JSX.Element;

package/dist/lib/components/ui/anchor-heading.stories.d.ts

@@ -0,0 +1,13 @@
+import { StoryObj } from '@storybook/react';
+import { AnchorHeading } from '..';
+declare const meta: {
+    title: string;
+    component: typeof AnchorHeading;
+    parameters: {
+        layout: string;
+    };
+    tags: string[];
+};
+export default meta;
+type Story = StoryObj<typeof meta>;
+export declare const Default: Story;

package/dist/lib/components/ui/anchor-heading.utils.d.ts

@@ -0,0 +1,2 @@
+import { ReactNode } from 'react';
+export declare function headingText(node: ReactNode): string;

package/dist/lib/components/ui/api-endpoint.d.ts

@@ -0,0 +1,9 @@
+import { ReactNode } from 'react';
+export type ApiEndpointMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
+export type ApiEndpointProps = {
+    method: ApiEndpointMethod;
+    path: string;
+    children?: ReactNode;
+    className?: string;
+};
+export declare function ApiEndpoint({ method, path, children, className, }: ApiEndpointProps): import("react").JSX.Element;

package/dist/lib/components/ui/api-endpoint.stories.d.ts

@@ -0,0 +1,14 @@
+import { StoryObj } from '@storybook/react';
+import { ApiEndpoint } from '..';
+declare const meta: {
+    title: string;
+    component: typeof ApiEndpoint;
+    parameters: {
+        layout: string;
+    };
+    tags: string[];
+};
+export default meta;
+type Story = StoryObj<typeof meta>;
+export declare const Get: Story;
+export declare const Dark: Story;

package/dist/lib/components/ui/api-operation.d.ts

@@ -0,0 +1,13 @@
+import { ReactNode } from 'react';
+import { ApiEndpointMethod } from './api-endpoint';
+import { CodeGroupTab } from './code/code-group';
+import { ParamTableRow } from './param-table';
+export type ApiOperationProps = {
+    method: ApiEndpointMethod;
+    path: string;
+    params?: ParamTableRow[];
+    examples?: CodeGroupTab[];
+    children?: ReactNode;
+    className?: string;
+};
+export declare function ApiOperation({ method, path, params, examples, children, className, }: ApiOperationProps): import("react").JSX.Element;

package/dist/lib/components/ui/api-operation.stories.d.ts

@@ -0,0 +1,13 @@
+import { StoryObj } from '@storybook/react';
+import { ApiOperation } from '..';
+declare const meta: {
+    title: string;
+    component: typeof ApiOperation;
+    parameters: {
+        layout: string;
+    };
+    tags: string[];
+};
+export default meta;
+type Story = StoryObj<typeof meta>;
+export declare const Get: Story;

package/dist/lib/components/ui/cards/cards.stories.d.ts

@@ -0,0 +1,20 @@
+import { StoryObj } from '@storybook/react';
+declare const meta: {
+    title: string;
+    parameters: {
+        layout: string;
+    };
+};
+export default meta;
+type Story = StoryObj<typeof meta>;
+export declare const Feature: Story;
+export declare const Media: Story;
+export declare const Pricing: Story;
+export declare const Profile: Story;
+export declare const Quote: Story;
+export declare const Overlay: Story;
+export declare const Spotlight: Story;
+export declare const Crew: Story;
+export declare const Gallery: Story;
+export declare const Phone: Story;
+export declare const Dark: Story;

package/dist/lib/components/ui/cards/cards.stories.data.d.ts

@@ -0,0 +1,8 @@
+export declare function FeatureDemo(): import("react").JSX.Element;
+export declare function MediaDemo(): import("react").JSX.Element;
+export declare function PricingDemo(): import("react").JSX.Element;
+export declare function ProfileDemo(): import("react").JSX.Element;
+export declare function QuoteDemo(): import("react").JSX.Element;
+export declare function OverlayDemo(): import("react").JSX.Element;
+export declare function SpotlightDemo(): import("react").JSX.Element;
+export declare function CrewDemo(): import("react").JSX.Element;

package/dist/lib/components/ui/cards/index.d.ts

@@ -0,0 +1,9 @@
+export { CrewCard } from './partials/crew-card';
+export { FeatureCard } from './partials/feature-card';
+export { MediaCard } from './partials/media-card';
+export { OverlayCard } from './partials/overlay-card';
+export { PricingCard } from './partials/pricing-card';
+export { ProfileCard } from './partials/profile-card';
+export { QuoteCard } from './partials/quote-card';
+export { SpotlightCard } from './partials/spotlight-card';
+export type { CrewCardProps, FeatureCardProps, MediaCardProps, OverlayCardProps, PricingCardProps, ProfileCardProps, QuoteCardProps, SpotlightCardProps, } from './types';

package/dist/lib/components/ui/cards/partials/crew-card.d.ts

@@ -0,0 +1,2 @@
+import { CrewCardProps } from '../types';
+export declare function CrewCard({ title, description, people, actions, className, ...props }: CrewCardProps): import("react").JSX.Element;

package/dist/lib/components/ui/cards/partials/feature-card.d.ts

@@ -0,0 +1,2 @@
+import { FeatureCardProps } from '../types';
+export declare function FeatureCard({ eyebrow, title, description, icon, actions, className, ...props }: FeatureCardProps): import("react").JSX.Element;

package/dist/lib/components/ui/cards/partials/media-card.d.ts

@@ -0,0 +1,2 @@
+import { MediaCardProps } from '../types';
+export declare function MediaCard({ title, description, media, footer, className, ...props }: MediaCardProps): import("react").JSX.Element;

package/dist/lib/components/ui/cards/partials/overlay-card.d.ts

@@ -0,0 +1,2 @@
+import { OverlayCardProps } from '../types';
+export declare function OverlayCard({ title, description, media, eyebrow, actions, className, ...props }: OverlayCardProps): import("react").JSX.Element;

package/dist/lib/components/ui/cards/partials/pricing-card.d.ts

@@ -0,0 +1,2 @@
+import { PricingCardProps } from '../types';
+export declare function PricingCard({ name, price, period, description, features, actions, highlighted, className, ...props }: PricingCardProps): import("react").JSX.Element;

package/dist/lib/components/ui/cards/partials/profile-card.d.ts

@@ -0,0 +1,2 @@
+import { ProfileCardProps } from '../types';
+export declare function ProfileCard({ name, subtitle, meta, avatar, actions, className, ...props }: ProfileCardProps): import("react").JSX.Element;

package/dist/lib/components/ui/cards/partials/quote-card.d.ts

@@ -0,0 +1,2 @@
+import { QuoteCardProps } from '../types';
+export declare function QuoteCard({ quote, author, subtitle, avatar, className, ...props }: QuoteCardProps): import("react").JSX.Element;

package/dist/lib/components/ui/cards/partials/spotlight-card.d.ts

@@ -0,0 +1,2 @@
+import { SpotlightCardProps } from '../types';
+export declare function SpotlightCard({ eyebrow, title, description, icon, className, ...props }: SpotlightCardProps): import("react").JSX.Element;

package/dist/lib/components/ui/cards/types.d.ts

@@ -0,0 +1,56 @@
+import { ComponentProps, ReactNode } from 'react';
+import { Card } from '../card';
+export type FeatureCardProps = Omit<ComponentProps<typeof Card>, 'title'> & {
+    eyebrow?: ReactNode;
+    title: ReactNode;
+    description?: ReactNode;
+    icon?: ReactNode;
+    actions?: ReactNode;
+};
+export type MediaCardProps = Omit<ComponentProps<typeof Card>, 'title'> & {
+    title: ReactNode;
+    description?: ReactNode;
+    media?: ReactNode;
+    footer?: ReactNode;
+};
+export type PricingCardProps = Omit<ComponentProps<typeof Card>, 'title'> & {
+    name: ReactNode;
+    price: ReactNode;
+    period?: ReactNode;
+    description?: ReactNode;
+    features?: ReactNode[];
+    actions?: ReactNode;
+    highlighted?: boolean;
+};
+export type ProfileCardProps = Omit<ComponentProps<typeof Card>, 'title'> & {
+    name: ReactNode;
+    subtitle?: ReactNode;
+    meta?: ReactNode;
+    avatar?: ReactNode;
+    actions?: ReactNode;
+};
+export type QuoteCardProps = Omit<ComponentProps<typeof Card>, 'title'> & {
+    quote: ReactNode;
+    author: ReactNode;
+    subtitle?: ReactNode;
+    avatar?: ReactNode;
+};
+export type OverlayCardProps = Omit<ComponentProps<typeof Card>, 'title'> & {
+    title: ReactNode;
+    description?: ReactNode;
+    media?: ReactNode;
+    eyebrow?: ReactNode;
+    actions?: ReactNode;
+};
+export type SpotlightCardProps = Omit<ComponentProps<typeof Card>, 'title'> & {
+    eyebrow?: ReactNode;
+    title: ReactNode;
+    description?: ReactNode;
+    icon?: ReactNode;
+};
+export type CrewCardProps = Omit<ComponentProps<typeof Card>, 'title'> & {
+    title: ReactNode;
+    description?: ReactNode;
+    people?: ReactNode;
+    actions?: ReactNode;
+};

package/dist/lib/components/ui/code/code-group.d.ts

@@ -0,0 +1,13 @@
+import { ReactNode } from 'react';
+export type CodeGroupTab = {
+    label: string;
+    code: string;
+    language?: string;
+    filename?: ReactNode;
+};
+export type CodeGroupProps = {
+    tabs: CodeGroupTab[];
+    showLineNumbers?: boolean;
+    className?: string;
+};
+export declare function CodeGroup({ tabs, showLineNumbers, className, }: CodeGroupProps): import("react").JSX.Element | null;

package/dist/lib/components/ui/code/code-group.stories.d.ts

@@ -0,0 +1,14 @@
+import { StoryObj } from '@storybook/react';
+import { CodeGroup } from '../..';
+declare const meta: {
+    title: string;
+    component: typeof CodeGroup;
+    parameters: {
+        layout: string;
+    };
+    tags: string[];
+};
+export default meta;
+type Story = StoryObj<typeof meta>;
+export declare const Default: Story;
+export declare const Dark: Story;

package/dist/lib/components/ui/code/index.d.ts

@@ -2,6 +2,8 @@ export type { CodeBlockProps } from './code-block';
 export { CodeBlock } from './code-block';
 export type { CodeDiffProps } from './code-diff';
 export { CodeDiff } from './code-diff';
+export type { CodeGroupProps, CodeGroupTab } from './code-group';
+export { CodeGroup } from './code-group';
 export { highlightCode } from './highlight';
 export type { JsonViewerProps } from './json-viewer';
 export { JsonViewer } from './json-viewer';

package/dist/lib/components/ui/copy-button/copy-button.d.ts

@@ -1,7 +1,9 @@
+import { ReactNode } from 'react';
 import { IconButtonProps } from '../buttons';
-export type CopyButtonProps = Omit<IconButtonProps, 'onClick' | 'children' | 'tooltip'> & {
-    value: string;
+export type CopyButtonProps = Omit<IconButtonProps, 'onClick' | 'children' | 'tooltip' | 'value'> & {
+    value: string | (() => string);
     label?: string;
     copiedLabel?: string;
+    icon?: ReactNode;
 };
-export declare function CopyButton({ value, label, copiedLabel, variant, color, ...props }: CopyButtonProps): import("react").JSX.Element;
+export declare function CopyButton({ value, label, copiedLabel, icon, variant, color, ...props }: CopyButtonProps): import("react").JSX.Element;

package/dist/lib/components/ui/doc/doc-api.stories.d.ts

@@ -0,0 +1,13 @@
+import { StoryObj } from '@storybook/react';
+import { Doc } from '../..';
+declare const meta: {
+    title: string;
+    component: typeof Doc;
+    parameters: {
+        layout: string;
+    };
+};
+export default meta;
+type Story = StoryObj<typeof meta>;
+export declare const Default: Story;
+export declare const Dark: Story;

package/dist/lib/components/ui/doc/doc-blocks.stories.d.ts

@@ -0,0 +1,13 @@
+import { StoryObj } from '@storybook/react';
+import { Doc } from '../..';
+declare const meta: {
+    title: string;
+    component: typeof Doc;
+    parameters: {
+        layout: string;
+    };
+};
+export default meta;
+type Story = StoryObj<typeof meta>;
+export declare const Gallery: Story;
+export declare const Dark: Story;

package/dist/lib/components/ui/doc/doc-context.d.ts

@@ -0,0 +1,61 @@
+import { ReactNode } from 'react';
+import { DocModel } from './use-doc';
+export type DocContextValue = DocModel;
+export declare function DocProvider({ value, children, }: {
+    value: DocContextValue;
+    children: ReactNode;
+}): import("react").JSX.Element;
+export declare function useDocContext(): {
+    items: import('./types').DocNavItem[];
+    pathname: string;
+    toc: import('./types').DocTocItem[];
+    brand: ReactNode;
+    actions: ReactNode;
+    searchable: boolean;
+    linkComponent: import('./types').DocLinkComponent | undefined;
+    chrome: import('./types').DocChromeState;
+    chromeActions: {
+        setSidebarOpen: (payload: boolean) => void;
+        setSearchOpen: (payload: boolean) => void;
+        setQuery: (payload: string) => void;
+        setActiveHeadingId: (payload: string | null) => void;
+        toggleCollapsed: (payload: string) => void;
+        setCollapsedIds: (payload: string[]) => void;
+    };
+    navigate: (href: string) => void;
+    onNavigate: ((href: string) => void) | undefined;
+    pager: {
+        previous?: import('./types').DocPagerLink;
+        next?: import('./types').DocPagerLink;
+    };
+    hits: import('./types').DocSearchHit[];
+    activeHref: string | undefined;
+    articleRef: import('react').RefObject<HTMLElement | null>;
+};
+export declare function useOptionalDocContext(): {
+    items: import('./types').DocNavItem[];
+    pathname: string;
+    toc: import('./types').DocTocItem[];
+    brand: ReactNode;
+    actions: ReactNode;
+    searchable: boolean;
+    linkComponent: import('./types').DocLinkComponent | undefined;
+    chrome: import('./types').DocChromeState;
+    chromeActions: {
+        setSidebarOpen: (payload: boolean) => void;
+        setSearchOpen: (payload: boolean) => void;
+        setQuery: (payload: string) => void;
+        setActiveHeadingId: (payload: string | null) => void;
+        toggleCollapsed: (payload: string) => void;
+        setCollapsedIds: (payload: string[]) => void;
+    };
+    navigate: (href: string) => void;
+    onNavigate: ((href: string) => void) | undefined;
+    pager: {
+        previous?: import('./types').DocPagerLink;
+        next?: import('./types').DocPagerLink;
+    };
+    hits: import('./types').DocSearchHit[];
+    activeHref: string | undefined;
+    articleRef: import('react').RefObject<HTMLElement | null>;
+} | null;

package/dist/lib/components/ui/doc/doc.d.ts

@@ -0,0 +1,11 @@
+import { ReactNode } from 'react';
+import { UseDocOptions } from './use-doc';
+export type DocProps = UseDocOptions & {
+    children?: ReactNode;
+    className?: string;
+};
+/**
+ * Documentation site shell. Layout is CSS-first, matching the usual docs
+ * breakpoints: one column below `md`, sidebar from `md`, TOC rail from `xl`.
+ */
+export declare function Doc({ children, className, ...options }: DocProps): import("react").JSX.Element;

package/dist/lib/components/ui/doc/doc.keyboard.d.ts

@@ -0,0 +1,20 @@
+export type DocKeyboardActions = {
+    openSearch: () => void;
+    closeOverlays: () => void;
+    goPrevious?: () => void;
+    goNext?: () => void;
+};
+export declare function isTypingTarget(target: unknown): boolean;
+export declare function isDocSearchHotkey(event: {
+    key: string;
+    metaKey: boolean;
+    ctrlKey: boolean;
+}): boolean;
+export declare function handleDocKeyDown(event: {
+    key: string;
+    metaKey: boolean;
+    ctrlKey: boolean;
+    altKey?: boolean;
+    target?: unknown;
+    preventDefault: () => void;
+}, actions: DocKeyboardActions): void;

package/dist/lib/components/ui/doc/doc.keyboard.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/lib/components/ui/doc/doc.slice.d.ts

@@ -0,0 +1,97 @@
+import { PayloadAction } from '@reduxjs/toolkit';
+import { DocChromeState } from './types';
+export declare const docSlice: import('@reduxjs/toolkit').Slice<DocChromeState, {
+    setSidebarOpen: (state: {
+        sidebarOpen: boolean;
+        searchOpen: boolean;
+        query: string;
+        activeHeadingId: string | null;
+        collapsedIds: string[];
+    }, action: PayloadAction<boolean>) => void;
+    setSearchOpen: (state: {
+        sidebarOpen: boolean;
+        searchOpen: boolean;
+        query: string;
+        activeHeadingId: string | null;
+        collapsedIds: string[];
+    }, action: PayloadAction<boolean>) => void;
+    setQuery: (state: {
+        sidebarOpen: boolean;
+        searchOpen: boolean;
+        query: string;
+        activeHeadingId: string | null;
+        collapsedIds: string[];
+    }, action: PayloadAction<string>) => void;
+    setActiveHeadingId: (state: {
+        sidebarOpen: boolean;
+        searchOpen: boolean;
+        query: string;
+        activeHeadingId: string | null;
+        collapsedIds: string[];
+    }, action: PayloadAction<string | null>) => void;
+    toggleCollapsed: (state: {
+        sidebarOpen: boolean;
+        searchOpen: boolean;
+        query: string;
+        activeHeadingId: string | null;
+        collapsedIds: string[];
+    }, action: PayloadAction<string>) => void;
+    setCollapsedIds: (state: {
+        sidebarOpen: boolean;
+        searchOpen: boolean;
+        query: string;
+        activeHeadingId: string | null;
+        collapsedIds: string[];
+    }, action: PayloadAction<string[]>) => void;
+}, "doc", "doc", import('@reduxjs/toolkit').SliceSelectors<DocChromeState>>;
+export declare const docActions: import('@reduxjs/toolkit').CaseReducerActions<{
+    setSidebarOpen: (state: {
+        sidebarOpen: boolean;
+        searchOpen: boolean;
+        query: string;
+        activeHeadingId: string | null;
+        collapsedIds: string[];
+    }, action: PayloadAction<boolean>) => void;
+    setSearchOpen: (state: {
+        sidebarOpen: boolean;
+        searchOpen: boolean;
+        query: string;
+        activeHeadingId: string | null;
+        collapsedIds: string[];
+    }, action: PayloadAction<boolean>) => void;
+    setQuery: (state: {
+        sidebarOpen: boolean;
+        searchOpen: boolean;
+        query: string;
+        activeHeadingId: string | null;
+        collapsedIds: string[];
+    }, action: PayloadAction<string>) => void;
+    setActiveHeadingId: (state: {
+        sidebarOpen: boolean;
+        searchOpen: boolean;
+        query: string;
+        activeHeadingId: string | null;
+        collapsedIds: string[];
+    }, action: PayloadAction<string | null>) => void;
+    toggleCollapsed: (state: {
+        sidebarOpen: boolean;
+        searchOpen: boolean;
+        query: string;
+        activeHeadingId: string | null;
+        collapsedIds: string[];
+    }, action: PayloadAction<string>) => void;
+    setCollapsedIds: (state: {
+        sidebarOpen: boolean;
+        searchOpen: boolean;
+        query: string;
+        activeHeadingId: string | null;
+        collapsedIds: string[];
+    }, action: PayloadAction<string[]>) => void;
+}, "doc">;
+export declare const docSelectors: {
+    selectSidebarOpen: (state: DocChromeState) => boolean;
+    selectSearchOpen: (state: DocChromeState) => boolean;
+    selectQuery: (state: DocChromeState) => string;
+    selectActiveHeadingId: (state: DocChromeState) => string | null;
+    selectIsCollapsed: (state: DocChromeState, id: string) => boolean;
+};

package/dist/lib/components/ui/doc/doc.stories.d.ts

@@ -0,0 +1,15 @@
+import { StoryObj } from '@storybook/react';
+import { Doc } from '../..';
+declare const meta: {
+    title: string;
+    component: typeof Doc;
+    parameters: {
+        layout: string;
+    };
+};
+export default meta;
+type Story = StoryObj<typeof meta>;
+export declare const Default: Story;
+export declare const Phone: Story;
+export declare const Dark: Story;
+export declare const NotFound: Story;

package/dist/lib/components/ui/doc/doc.stories.data.d.ts

@@ -0,0 +1,7 @@
+import { DocNavItem, DocTocItem } from './types';
+export declare const ITEMS: DocNavItem[];
+export declare const TOC: Record<string, DocTocItem[]>;
+export declare const PAGES: Record<string, {
+    title: string;
+    description: string;
+}>;

package/dist/lib/components/ui/doc/doc.utils.d.ts

@@ -0,0 +1,29 @@
+import { slugify } from '../../../lib/string.utils';
+import { headingText } from '../anchor-heading.utils';
+import { DocNavItem, DocPagerLink, DocSearchHit } from './types';
+export { headingText, slugify };
+export declare function navLabel(item: DocNavItem): string;
+/**
+ * Whether `href` covers `pathname` — an exact match, or a whole-segment prefix.
+ * `/docs` covers `/docs/install` but not `/docs-old`.
+ */
+export declare function isDocPathActive(pathname: string, href: string): boolean;
+export declare function flattenDocNav(items: DocNavItem[], group?: string): DocSearchHit[];
+/**
+ * The nav href to light for the current path: the longest one that covers it.
+ */
+export declare function findActiveDocHref(items: DocNavItem[], pathname: string): string | undefined;
+export declare function findDocPager(items: DocNavItem[], pathname: string): {
+    previous?: DocPagerLink;
+    next?: DocPagerLink;
+};
+export { isExternalHref } from '../../../lib/url.utils';
+/** Child pages of the nav entry whose href is exactly `pathname`. */
+export declare function findDocChildren(items: DocNavItem[], pathname: string): DocNavItem[];
+/** Other href children of the parent that contains `pathname`. */
+export declare function findDocSiblings(items: DocNavItem[], pathname: string): DocNavItem[];
+/**
+ * Keep items whose label matches `query`, plus ancestors.
+ * A matching parent keeps its full subtree.
+ */
+export declare function filterDocNav(items: DocNavItem[], query: string): DocNavItem[];

package/dist/lib/components/ui/doc/doc.utils.test.d.ts

@@ -0,0 +1 @@
+export {};