orizon 0.2.0 → 0.2.2

package/dist/components/affix/Affix.d.ts

@@ -1,4 +1,23 @@
 import { AffixProps } from './types';
+/**
+ * @file Affix Component
+ *
+ * Pins its children to the viewport when the scroll position crosses
+ * a configurable offset. Supports both top and bottom pinning, and
+ * a custom scroll container via the `target` prop.
+ *
+ * Key props: `offsetTop`, `offsetBottom`, `target`, `onChange`.
+ *
+ * @example
+ * ```tsx
+ * <Affix offsetTop={80}>
+ *   <nav>Sticky toolbar</nav>
+ * </Affix>
+ * ```
+ *
+ * @see {@link ./types.ts} — prop definitions
+ * @see {@link ./index.ts} — barrel export
+ */
 import * as React from "react";
 declare const Affix: React.FC<AffixProps>;
 export { Affix };

package/dist/components/affix/Affix.stories.d.ts

@@ -0,0 +1,9 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { Affix } from './index';
+declare const meta: Meta<typeof Affix>;
+export default meta;
+type Story = StoryObj<typeof Affix>;
+export declare const Playground: Story;
+export declare const OffsetTop: Story;
+export declare const OffsetBottom: Story;
+export declare const OnChange: Story;

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

@@ -1,2 +1,25 @@
+/**
+ * @file Affix — Public Barrel Export
+ *
+ * Re-exports the `<Affix>` component that pins content to the viewport
+ * on scroll.
+ */
+/**
+ * Affix component that pins its children to the viewport when scrolling.
+ *
+ * Supports `offsetTop` / `offsetBottom` for threshold control, a custom
+ * `target` scroll container, and an `onChange` callback.
+ *
+ * @example
+ * ```tsx
+ * <Affix offsetTop={64}>
+ *   <div>I stick 64px from top</div>
+ * </Affix>
+ *
+ * <Affix offsetBottom={20}>
+ *   <button>Floating action</button>
+ * </Affix>
+ * ```
+ */
 export { Affix } from './Affix';
 export type { AffixProps } from './types';

package/dist/components/alert/Alert.d.ts

@@ -1,4 +1,25 @@
 import { AlertProps } from './types';
+/**
+ * @file Alert Component
+ *
+ * Renders a feedback alert banner with semantic colouring for
+ * success, info, warning, and error states. Supports closable
+ * behaviour (with animation), an action slot, custom icons,
+ * and a full-width banner mode.
+ *
+ * Key props: `type`, `message`, `description`, `closable`, `showIcon`,
+ * `banner`, `action`.
+ *
+ * @example
+ * ```tsx
+ * <Alert type="success" message="Saved!" showIcon />
+ * <Alert type="error" message="Failed" description="Details..." closable />
+ * ```
+ *
+ * @see {@link ./types.ts} — prop definitions
+ * @see {@link ./ErrorBoundary.tsx} — error boundary sub-component
+ * @see {@link ./index.ts} — barrel export
+ */
 import * as React from "react";
 declare const InternalAlert: React.ForwardRefExoticComponent<AlertProps & React.RefAttributes<HTMLDivElement>>;
 export { InternalAlert };

package/dist/components/alert/Alert.stories.d.ts

@@ -0,0 +1,13 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { Alert } from './index';
+declare const meta: Meta<typeof Alert>;
+export default meta;
+type Story = StoryObj<typeof Alert>;
+export declare const Playground: Story;
+export declare const Types: Story;
+export declare const WithIcon: Story;
+export declare const Closable: Story;
+export declare const Description: Story;
+export declare const Banner: Story;
+export declare const Actions: Story;
+export declare const ErrorBoundaryStory: Story;

package/dist/components/alert/ErrorBoundary.d.ts

@@ -1,4 +1,14 @@
 import { AlertErrorBoundaryProps } from './types';
+/**
+ * @file Alert Error Boundary
+ *
+ * A React class-based error boundary that catches render errors
+ * in its children and displays them as an error `<Alert>`. Used
+ * via `Alert.ErrorBoundary`.
+ *
+ * @see {@link ./Alert.tsx} — main Alert component
+ * @see {@link ./types.ts} — prop definitions
+ */
 import * as React from "react";
 interface ErrorBoundaryState {
     hasError: boolean;

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

@@ -3,6 +3,26 @@ import { AlertErrorBoundary } from './ErrorBoundary';
 type AlertComponent = typeof InternalAlert & {
     ErrorBoundary: typeof AlertErrorBoundary;
 };
+/**
+ * Alert component for feedback messages.
+ *
+ * Supports `type` (success / info / warning / error), `closable`,
+ * `banner` mode, custom `icon`, and an `action` slot.
+ *
+ * Use `Alert.ErrorBoundary` to catch React errors and display
+ * them as an alert.
+ *
+ * @example
+ * ```tsx
+ * <Alert type="success" message="Done!" />
+ * <Alert type="warning" message="Watch out" description="Details here" closable />
+ * <Alert type="info" message="Tip" showIcon banner />
+ *
+ * <Alert.ErrorBoundary message="Oops">
+ *   <SomeComponent />
+ * </Alert.ErrorBoundary>
+ * ```
+ */
 declare const Alert: AlertComponent;
 export { Alert };
 export type { AlertProps, AlertType, AlertClosableConfig, AlertErrorBoundaryProps, } from './types';

package/dist/components/anchor/Anchor.d.ts

@@ -1,4 +1,27 @@
 import { AnchorProps } from './types';
+/**
+ * @file Anchor Component
+ *
+ * A scroll-spy navigation component that highlights the current
+ * section in view and smooth-scrolls to anchor targets on click.
+ * Supports vertical / horizontal layout, nested items, affix
+ * (sticky) positioning, and a sliding active indicator.
+ *
+ * Key props: `items`, `direction`, `affix`, `targetOffset`, `onChange`.
+ *
+ * @example
+ * ```tsx
+ * <Anchor
+ *   items={[
+ *     { key: "1", href: "#section-1", title: "Introduction" },
+ *     { key: "2", href: "#section-2", title: "Usage" },
+ *   ]}
+ * />
+ * ```
+ *
+ * @see {@link ./types.ts} — prop definitions
+ * @see {@link ./index.ts} — barrel export
+ */
 import * as React from "react";
 declare const Anchor: React.ForwardRefExoticComponent<AnchorProps & React.RefAttributes<HTMLDivElement>>;
 export { Anchor };

package/dist/components/anchor/Anchor.stories.d.ts

@@ -0,0 +1,9 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { Anchor } from './index';
+declare const meta: Meta<typeof Anchor>;
+export default meta;
+type Story = StoryObj<typeof Anchor>;
+export declare const Playground: Story;
+export declare const Vertical: Story;
+export declare const Horizontal: Story;
+export declare const NestedItems: Story;

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

@@ -1,2 +1,26 @@
+/**
+ * @file Anchor — Public Barrel Export
+ *
+ * Re-exports the `<Anchor>` scroll-spy navigation component.
+ */
+/**
+ * Anchor component for scroll-spy navigation.
+ *
+ * Highlights the active section as the user scrolls and smooth-scrolls
+ * to targets on click. Supports `direction` (vertical / horizontal),
+ * `affix` mode, nested `items`, and custom `getContainer`.
+ *
+ * @example
+ * ```tsx
+ * <Anchor
+ *   items={[
+ *     { key: "intro", href: "#intro", title: "Introduction" },
+ *     { key: "api", href: "#api", title: "API" },
+ *   ]}
+ *   direction="vertical"
+ *   offsetTop={80}
+ * />
+ * ```
+ */
 export { Anchor } from './Anchor';
 export type { AnchorProps, AnchorItem, AnchorDirection } from './types';

package/dist/components/app/App.d.ts

@@ -2,6 +2,31 @@ import { MessageAPI } from '../message/types';
 import { NotificationAPI } from '../notification/types';
 import { ModalHookAPI } from '../modal/types';
 import { AppProps } from './types';
+/**
+ * @file App Component
+ *
+ * Top-level provider that makes imperative `message`, `notification`,
+ * and `modal` APIs available via `App.useApp()`. Wrap your application
+ * (or a subtree) with `<App>` and call `const { message } = App.useApp()`
+ * to show feedback without prop-drilling.
+ *
+ * Key props: `children`, `component`, `className`, `style`.
+ *
+ * @example
+ * ```tsx
+ * <App>
+ *   <MyPage />
+ * </App>
+ *
+ * function MyPage() {
+ *   const { message } = App.useApp();
+ *   return <button onClick={() => message.success("Saved!")}>Save</button>;
+ * }
+ * ```
+ *
+ * @see {@link ./types.ts} — prop definitions
+ * @see {@link ./index.ts} — barrel export
+ */
 import * as React from "react";
 interface AppContextValue {
     message: MessageAPI;

package/dist/components/app/App.stories.d.ts

@@ -0,0 +1,8 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { App } from './index';
+declare const meta: Meta<typeof App>;
+export default meta;
+type Story = StoryObj<typeof App>;
+export declare const Playground: Story;
+export declare const CustomComponent: Story;
+export declare const NoWrapper: Story;

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

@@ -2,6 +2,24 @@ import { InternalApp, useApp } from './App';
 type AppComponent = typeof InternalApp & {
     useApp: typeof useApp;
 };
+/**
+ * App provider component for imperative feedback APIs.
+ *
+ * Wrap your application with `<App>` to gain access to
+ * `message`, `notification`, and `modal` via the `App.useApp()` hook.
+ *
+ * @example
+ * ```tsx
+ * <App>
+ *   <MyPage />
+ * </App>
+ *
+ * function MyPage() {
+ *   const { message, notification, modal } = App.useApp();
+ *   return <button onClick={() => message.info("Hello!")}>Greet</button>;
+ * }
+ * ```
+ */
 declare const App: AppComponent;
 export { App };
 export type { AppProps } from './types';

package/dist/components/auto-complete/AutoComplete.d.ts

@@ -1,4 +1,26 @@
 import { AutoCompleteProps } from './types';
+/**
+ * @file AutoComplete Component
+ *
+ * An input field with a filterable dropdown suggestion list.
+ * Supports keyboard navigation, controlled / uncontrolled value,
+ * custom filter functions, backfill, allow-clear, and three
+ * visual variants (outlined, borderless, filled).
+ *
+ * Key props: `options`, `value`, `onChange`, `onSelect`, `onSearch`,
+ * `filterOption`, `size`, `status`, `variant`, `allowClear`.
+ *
+ * @example
+ * ```tsx
+ * <AutoComplete
+ *   options={[{ value: "React" }, { value: "Vue" }, { value: "Angular" }]}
+ *   placeholder="Search frameworks"
+ * />
+ * ```
+ *
+ * @see {@link ./types.ts} — prop definitions
+ * @see {@link ./index.ts} — barrel export
+ */
 import * as React from "react";
 declare const InternalAutoComplete: React.ForwardRefExoticComponent<AutoCompleteProps & React.RefAttributes<HTMLDivElement>>;
 export { InternalAutoComplete };

package/dist/components/auto-complete/AutoComplete.stories.d.ts

@@ -0,0 +1,12 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { AutoComplete } from './index';
+declare const meta: Meta<typeof AutoComplete>;
+export default meta;
+type Story = StoryObj<typeof AutoComplete>;
+export declare const Playground: Story;
+export declare const Sizes: Story;
+export declare const Variants: Story;
+export declare const Status: Story;
+export declare const AllowClear: Story;
+export declare const Disabled: Story;
+export declare const CustomFilter: Story;

package/dist/components/auto-complete/index.d.ts

@@ -1,3 +1,25 @@
+/**
+ * @file AutoComplete — Public Barrel Export
+ *
+ * Re-exports the `<AutoComplete>` input component with dropdown
+ * suggestions.
+ */
+/**
+ * AutoComplete input with filterable dropdown suggestions.
+ *
+ * Supports `options`, controlled / uncontrolled `value`, custom
+ * `filterOption`, `allowClear`, `size`, `status`, and `variant`.
+ *
+ * @example
+ * ```tsx
+ * <AutoComplete
+ *   options={[{ value: "React" }, { value: "Vue" }]}
+ *   placeholder="Search..."
+ *   onSelect={(val) => console.log(val)}
+ * />
+ * <AutoComplete size="large" variant="filled" allowClear />
+ * ```
+ */
 declare const AutoComplete: import('react').ForwardRefExoticComponent<import('./types').AutoCompleteProps & import('react').RefAttributes<HTMLDivElement>>;
 export { AutoComplete };
 export type { AutoCompleteProps, AutoCompleteOption, AutoCompleteSize, AutoCompleteStatus, AutoCompleteVariant, } from './types';

package/dist/components/avatar/Avatar.d.ts

@@ -1,4 +1,28 @@
 import { AvatarProps, AvatarGroupProps } from './types';
+/**
+ * @file Avatar Component
+ *
+ * Renders a user avatar as an image, icon, or auto-scaled text
+ * initials. Supports circle / square shapes, three preset sizes
+ * (plus custom numeric), and grouped display via `Avatar.Group`.
+ *
+ * Key props: `src`, `size`, `shape`, `icon`, `alt`, `gap`.
+ *
+ * @example
+ * ```tsx
+ * <Avatar src="/user.jpg" alt="Jane" />
+ * <Avatar icon={<UserIcon />} shape="square" size="large" />
+ * <Avatar.Group max={{ count: 3 }}>
+ *   <Avatar src="/a.jpg" />
+ *   <Avatar src="/b.jpg" />
+ *   <Avatar src="/c.jpg" />
+ *   <Avatar src="/d.jpg" />
+ * </Avatar.Group>
+ * ```
+ *
+ * @see {@link ./types.ts} — prop definitions
+ * @see {@link ./index.ts} — barrel export
+ */
 import * as React from "react";
 declare const InternalAvatar: React.ForwardRefExoticComponent<AvatarProps & React.RefAttributes<HTMLSpanElement>>;
 declare const InternalAvatarGroup: React.FC<AvatarGroupProps>;

package/dist/components/avatar/Avatar.stories.d.ts

@@ -0,0 +1,10 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { Avatar } from './index';
+declare const meta: Meta<typeof Avatar>;
+export default meta;
+type Story = StoryObj<typeof Avatar>;
+export declare const Playground: Story;
+export declare const Sizes: Story;
+export declare const Shapes: Story;
+export declare const Fallbacks: Story;
+export declare const Group: Story;

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

@@ -2,6 +2,27 @@ import { InternalAvatar, InternalAvatarGroup } from './Avatar';
 type AvatarComponent = typeof InternalAvatar & {
     Group: typeof InternalAvatarGroup;
 };
+/**
+ * Avatar component for user profile images, icons, or text initials.
+ *
+ * Supports `src` image, `icon` fallback, text `children` with
+ * auto-scaling, `shape` (circle / square), and `size`.
+ *
+ * Use `Avatar.Group` to display a stacked group with overflow count.
+ *
+ * @example
+ * ```tsx
+ * <Avatar src="/photo.jpg" alt="User" />
+ * <Avatar shape="square" size={48}>AB</Avatar>
+ *
+ * <Avatar.Group max={{ count: 3 }}>
+ *   <Avatar src="/a.jpg" />
+ *   <Avatar src="/b.jpg" />
+ *   <Avatar src="/c.jpg" />
+ *   <Avatar src="/d.jpg" />
+ * </Avatar.Group>
+ * ```
+ */
 declare const Avatar: AvatarComponent;
 export { Avatar };
 export type { AvatarProps, AvatarGroupProps, AvatarSize, AvatarShape, AvatarGroupMaxConfig } from './types';

package/dist/components/badge/Badge.d.ts

@@ -1,4 +1,23 @@
 import { BadgeProps, BadgeRibbonProps } from './types';
+/**
+ * @file Badge Component
+ *
+ * Displays a numeric count, dot, or status indicator on its children.
+ * Includes `Badge.Ribbon` for corner ribbon decorations on cards.
+ *
+ * Key props: `count`, `dot`, `status`, `color`, `size`, `overflowCount`,
+ * `showZero`, `offset`.
+ *
+ * @example
+ * ```tsx
+ * <Badge count={5}><Avatar /></Badge>
+ * <Badge dot status="success" />
+ * <Badge.Ribbon text="New"><Card>...</Card></Badge.Ribbon>
+ * ```
+ *
+ * @see {@link ./types.ts} — prop definitions
+ * @see {@link ./index.ts} — barrel export
+ */
 import * as React from "react";
 declare const InternalBadge: React.ForwardRefExoticComponent<BadgeProps & React.RefAttributes<HTMLSpanElement>>;
 declare const BadgeRibbon: React.FC<BadgeRibbonProps>;

package/dist/components/badge/Badge.stories.d.ts

@@ -0,0 +1,12 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { Badge } from './index';
+declare const meta: Meta<typeof Badge>;
+export default meta;
+type Story = StoryObj<typeof Badge>;
+export declare const Playground: Story;
+export declare const Count: Story;
+export declare const Dot: Story;
+export declare const StatusBadges: Story;
+export declare const Colors: Story;
+export declare const Overflow: Story;
+export declare const Ribbon: Story;

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

@@ -2,6 +2,25 @@ import { InternalBadge, BadgeRibbon } from './Badge';
 type BadgeComponent = typeof InternalBadge & {
     Ribbon: typeof BadgeRibbon;
 };
+/**
+ * Badge component for numeric counts, dots, and status indicators.
+ *
+ * Supports `count`, `dot`, `status`, preset / custom `color`,
+ * `overflowCount`, `size`, and `showZero`.
+ *
+ * Use `Badge.Ribbon` for corner ribbon decorations on cards.
+ *
+ * @example
+ * ```tsx
+ * <Badge count={5}><button>Notifications</button></Badge>
+ * <Badge dot status="processing"><span>Online</span></Badge>
+ * <Badge status="success" text="Completed" />
+ *
+ * <Badge.Ribbon text="Hot" color="red">
+ *   <Card>Content</Card>
+ * </Badge.Ribbon>
+ * ```
+ */
 declare const Badge: BadgeComponent;
 export { Badge };
 export type { BadgeProps, BadgeRibbonProps, BadgeStatus, BadgeSize, PresetColor, RibbonPlacement, } from './types';

package/dist/components/breadcrumb/Breadcrumb.d.ts

@@ -1,4 +1,28 @@
 import { BreadcrumbProps } from './types';
+/**
+ * @file Breadcrumb Component
+ *
+ * Renders a breadcrumb trail from an `items` array. Each item can
+ * optionally include an `href` for linking, a dropdown `menu` for
+ * sub-navigation, and an `onClick` handler. The last item is
+ * automatically rendered as the current page.
+ *
+ * Key props: `items`, `separator`.
+ *
+ * @example
+ * ```tsx
+ * <Breadcrumb
+ *   items={[
+ *     { title: "Home", href: "/" },
+ *     { title: "Products", href: "/products" },
+ *     { title: "Widget" },
+ *   ]}
+ * />
+ * ```
+ *
+ * @see {@link ./types.ts} — prop definitions
+ * @see {@link ./index.ts} — barrel export
+ */
 import * as React from "react";
 declare const Breadcrumb: React.ForwardRefExoticComponent<BreadcrumbProps & React.RefAttributes<HTMLElement>>;
 export { Breadcrumb };

package/dist/components/breadcrumb/Breadcrumb.stories.d.ts

@@ -0,0 +1,9 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { Breadcrumb } from './index';
+declare const meta: Meta<typeof Breadcrumb>;
+export default meta;
+type Story = StoryObj<typeof Breadcrumb>;
+export declare const Playground: Story;
+export declare const Basic: Story;
+export declare const CustomSeparator: Story;
+export declare const WithMenu: Story;

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

@@ -1,2 +1,27 @@
+/**
+ * @file Breadcrumb — Public Barrel Export
+ *
+ * Re-exports the `<Breadcrumb>` navigation component.
+ */
+/**
+ * Breadcrumb navigation trail.
+ *
+ * Renders a list of `items` as linked crumbs with an automatic
+ * separator. Supports dropdown `menu` per item and a custom
+ * `separator` node.
+ *
+ * @example
+ * ```tsx
+ * <Breadcrumb
+ *   items={[
+ *     { title: "Home", href: "/" },
+ *     { title: "Settings", href: "/settings" },
+ *     { title: "Profile" },
+ *   ]}
+ * />
+ *
+ * <Breadcrumb separator=">" items={[{ title: "A" }, { title: "B" }]} />
+ * ```
+ */
 export { Breadcrumb } from './Breadcrumb';
 export type { BreadcrumbProps, BreadcrumbItemType, BreadcrumbMenuItemType } from './types';

package/dist/components/button/Button.d.ts

@@ -1,4 +1,28 @@
 import { ButtonProps } from './types';
+/**
+ * @file Button Component
+ *
+ * Public `<Button>` with an Ant-Design-compatible API.
+ * Wraps the low-level `primitives/button` and maps friendly props
+ * (`type`, `danger`, `ghost`, `loading`, `shape`, `hint`, …) onto
+ * CVA variant classes.
+ *
+ * Ant-Design `type` → Primitive `variant` mapping:
+ *   primary  → "default"  (solid primary bg)
+ *   default  → "outline"  (bordered)
+ *   dashed   → "outline"  + border-dashed class
+ *   text     → "ghost"    (transparent)
+ *   link     → "link"     (underline on hover)
+ *
+ * When `danger` is true the variant is overridden to "destructive".
+ *
+ * Tooltip: pass a `hint` string and the button is automatically
+ * wrapped in a `<TooltipProvider> → <Tooltip> → <TooltipTrigger>`.
+ *
+ * @see {@link ../../primitives/button.tsx}  — underlying styled primitive
+ * @see {@link ./types.ts}                  — prop definitions
+ * @see {@link ./ButtonGroup.tsx}           — grouped buttons
+ */
 import * as React from "react";
 declare const InternalButton: React.ForwardRefExoticComponent<ButtonProps & React.RefAttributes<HTMLButtonElement>>;
 export { InternalButton };

package/dist/components/button/Button.stories.d.ts

@@ -0,0 +1,20 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { Button } from './index';
+declare const meta: Meta<typeof Button>;
+export default meta;
+type Story = StoryObj<typeof Button>;
+export declare const Playground: Story;
+export declare const AllTypes: Story;
+export declare const AllSizes: Story;
+export declare const AllShapes: Story;
+export declare const WithIcons: Story;
+export declare const Danger: Story;
+export declare const Ghost: Story;
+export declare const Loading: Story;
+export declare const Disabled: Story;
+export declare const Block: Story;
+export declare const HoverActiveTest: Story;
+export declare const CompleteMatrix: Story;
+export declare const Hint: Story;
+export declare const IconOnlySizes: Story;
+export declare const Group: Story;

package/dist/components/button/ButtonGroup.d.ts

@@ -1,4 +1,27 @@
 import { ButtonGroupProps } from './types';
+/**
+ * @file ButtonGroup Component
+ *
+ * Renders adjacent `<Button>` children as a visually connected group:
+ *   - Collapsed borders via `-ml-px` on non-first children
+ *   - First child keeps left rounding, last child keeps right rounding,
+ *     middle children have no rounding
+ *   - Hovered / focused children are promoted via `z-10` so their
+ *     border/ring sits above neighbours
+ *
+ * An optional `size` prop overrides every child button's size.
+ *
+ * @example
+ * ```tsx
+ * <Button.Group size="small">
+ *   <Button>Left</Button>
+ *   <Button>Center</Button>
+ *   <Button>Right</Button>
+ * </Button.Group>
+ * ```
+ *
+ * @see {@link ./types.ts} — `ButtonGroupProps`
+ */
 import * as React from "react";
 declare const ButtonGroup: React.FC<ButtonGroupProps>;
 export { ButtonGroup };