@nori-ui/core 0.0.5 → 1.0.2

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

@@ -0,0 +1,186 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode, ComponentType } from 'react';
+
+/** Where the ellipsis sends the user when tapped/clicked. */
+type BreadcrumbExpandBehavior = 
+/** Replace `…` with all hidden items inline (MUI). Web default. */
+'inline'
+/** Open a popover/sheet listing the hidden items (Primer / iOS). Native default. */
+ | 'menu'
+/** Don't collapse — fall back to a horizontal scroll container. Useful for IDE-style file paths. */
+ | 'scroll'
+/** Render `…` but don't react to interaction. Pure visual hint. */
+ | 'none';
+type BreadcrumbSeparatorContext = {
+    /** Index of the item PRECEDING this separator. */
+    fromIndex: number;
+    /** Total visible items. */
+    visibleCount: number;
+    /** Reading direction at render time. */
+    dir: 'ltr' | 'rtl';
+};
+type BreadcrumbSeparatorValue = string | ReactNode | ((ctx: BreadcrumbSeparatorContext) => ReactNode);
+type BreadcrumbIcon = ComponentType<{
+    size?: number;
+    color?: string;
+}>;
+type BreadcrumbSibling = {
+    /** Visible label. */
+    label: ReactNode;
+    /** Link target. Omit for an `onSelect`-driven sibling. */
+    href?: string;
+    /** Optional leading icon. */
+    icon?: BreadcrumbIcon;
+    /** Click / tap handler. */
+    onSelect?: () => void;
+    /** Render as inactive in the sibling menu. */
+    disabled?: boolean;
+};
+type BreadcrumbItemData = {
+    /** Visible label. Strings are wrapped in `<Text>`; ReactNode passes through. */
+    label: ReactNode;
+    /** Link target. When omitted and not `current`, the item renders as a button (use with `onSelect`). */
+    href?: string;
+    /** Leading icon component (lucide, custom, …). Sized to the line height. */
+    icon?: BreadcrumbIcon;
+    /** Marks this item as the current page. The last item is auto-flagged when no item is explicitly current. */
+    current?: boolean;
+    /** Sibling list — when provided, the item gets a chevron and opens a popover menu of siblings on tap. */
+    siblings?: BreadcrumbSibling[];
+    /** Render a skeleton instead of the label — useful while async paths resolve. */
+    loading?: boolean;
+    /** Click / tap handler when `href` is absent. */
+    onSelect?: () => void;
+    /** Stable key for React's reconciler. Defaults to the item index. */
+    key?: string | number;
+    /** Override per-item label truncation in characters. 0 disables truncation. */
+    maxLabelLength?: number;
+};
+type BreadcrumbProps = {
+    /** Items-array mode. When provided, `children` is ignored. */
+    items?: ReadonlyArray<BreadcrumbItemData>;
+    /**
+     * Visual separator between items. Strings render as plain text; nodes
+     * render as-is; functions receive `(ctx)` and return a node.
+     * @defaultValue a chevron glyph (auto-flips for RTL)
+     */
+    separator?: BreadcrumbSeparatorValue;
+    /**
+     * Maximum number of visible items. The middle is collapsed into a
+     * single ellipsis; the first / last items are kept by default.
+     * Pass `0` or `undefined` to disable count-based collapse.
+     */
+    maxItems?: number;
+    /** How many items at the START of the list stay visible when the middle collapses. @defaultValue 1 */
+    itemsBeforeCollapse?: number;
+    /** How many items at the END of the list stay visible when the middle collapses. @defaultValue 1 */
+    itemsAfterCollapse?: number;
+    /**
+     * Width-based collapse using `onLayout` (works on RN-Web via the
+     * built-in ResizeObserver shim and on native via the layout system).
+     * The library renders a hidden measurement copy of every item, then
+     * shows only the items that fit the container — middle items are
+     * folded into the ellipsis. Pass `false` to opt out and let the row
+     * grow to its natural width (it will overflow its parent if the
+     * parent does not provide its own scroll/clip handling).
+     * @defaultValue true
+     */
+    collapseOnOverflow?: boolean;
+    /**
+     * What the ellipsis does when tapped/clicked.
+     * @defaultValue 'inline' on web, 'menu' on native
+     */
+    expandBehavior?: BreadcrumbExpandBehavior;
+    /** Override the default i18n string for the "show full path" SR label. */
+    expandLabel?: string;
+    /** Override the default i18n string for the ellipsis SR label. */
+    ellipsisLabel?: string;
+    /**
+     * Visually-hidden prefix announced before the current page's label.
+     * Helps screen readers convey "Current page: Settings" instead of "Settings".
+     */
+    currentPageLabel?: string;
+    /** Override the SR label for sibling menus opened from a crumb. */
+    siblingMenuLabel?: string;
+    /** Visible aria-label on the wrapping `<nav>`. @defaultValue translated "Breadcrumb" */
+    ariaLabel?: string;
+    /**
+     * Emit JSON-LD `BreadcrumbList` structured data for SEO + LLM
+     * ingest. Web only; ignored on native.
+     * @defaultValue true (only when `items` is provided AND on web)
+     */
+    schemaOrg?: boolean;
+    /**
+     * Reading direction. RTL flips the default chevron separator and the
+     * collapse logic so the start/end stay anchored to the right edge.
+     * @defaultValue 'ltr'
+     */
+    dir?: 'ltr' | 'rtl';
+    /**
+     * Truncate each item's label after this many characters. Per-item
+     * `maxLabelLength` overrides this. @defaultValue 0 (no truncation)
+     */
+    maxLabelLength?: number;
+    children?: ReactNode;
+    className?: string;
+    testID?: string;
+};
+/**
+ * Build a JSON-LD `BreadcrumbList` document from a list of items. Use it
+ * with your framework's metadata API for SSR-time emission:
+ *
+ * ```tsx
+ * // Next.js App Router metadata
+ * export async function generateMetadata() {
+ *   return { other: { 'application/ld+json': getBreadcrumbJsonLd(items) } };
+ * }
+ * ```
+ *
+ * The component renders this client-side via `document.head` injection
+ * automatically — but framework-driven SSR is preferred for reliable
+ * search-engine pickup, hence this exported helper.
+ */
+declare function getBreadcrumbJsonLd(items: ReadonlyArray<BreadcrumbItemData>): string;
+type BreadcrumbListProps = {
+    children?: ReactNode;
+    className?: string;
+    testID?: string;
+};
+type BreadcrumbItemProps = {
+    children?: ReactNode;
+    className?: string;
+    testID?: string;
+};
+type BreadcrumbLinkProps = {
+    href?: string;
+    onPress?: () => void;
+    asChild?: boolean;
+    children?: ReactNode;
+    className?: string;
+    testID?: string;
+};
+type BreadcrumbPageProps = {
+    children?: ReactNode;
+    className?: string;
+    testID?: string;
+};
+type BreadcrumbSeparatorProps = {
+    children?: ReactNode;
+    className?: string;
+    testID?: string;
+};
+type BreadcrumbEllipsisProps = {
+    ellipsisLabel?: string;
+    className?: string;
+    testID?: string;
+};
+declare const Breadcrumb: (({ items, separator, maxItems, itemsBeforeCollapse, itemsAfterCollapse, collapseOnOverflow, expandBehavior, expandLabel, ellipsisLabel, currentPageLabel, siblingMenuLabel, ariaLabel, schemaOrg, dir, maxLabelLength, children, className, testID, }: BreadcrumbProps) => react_jsx_runtime.JSX.Element) & {
+    List: ({ children, className, testID }: BreadcrumbListProps) => react_jsx_runtime.JSX.Element;
+    Item: ({ children, className, testID }: BreadcrumbItemProps) => react_jsx_runtime.JSX.Element;
+    Link: ({ href, onPress, asChild, children, className, testID }: BreadcrumbLinkProps) => react_jsx_runtime.JSX.Element;
+    Page: ({ children, className, testID }: BreadcrumbPageProps) => react_jsx_runtime.JSX.Element;
+    Separator: ({ children, className, testID }: BreadcrumbSeparatorProps) => react_jsx_runtime.JSX.Element;
+    Ellipsis: ({ ellipsisLabel, className, testID }: BreadcrumbEllipsisProps) => react_jsx_runtime.JSX.Element;
+};
+
+export { Breadcrumb, type BreadcrumbEllipsisProps, type BreadcrumbExpandBehavior, type BreadcrumbIcon, type BreadcrumbItemData, type BreadcrumbItemProps, type BreadcrumbLinkProps, type BreadcrumbListProps, type BreadcrumbPageProps, type BreadcrumbProps, type BreadcrumbSeparatorContext, type BreadcrumbSeparatorProps, type BreadcrumbSeparatorValue, type BreadcrumbSibling, getBreadcrumbJsonLd };

package/dist/components/Breadcrumb/index.js

@@ -0,0 +1,11 @@
+export { Breadcrumb, getBreadcrumbJsonLd } from '../../chunk-LVWNMQGR.js';
+import '../../chunk-YNKKEO2A.js';
+import '../../chunk-RFW5SRZA.js';
+import '../../chunk-FT2XBBQJ.js';
+import '../../chunk-ZIBNLXIV.js';
+import '../../chunk-5A2QOOVN.js';
+import '../../chunk-CHXHRJNZ.js';
+import '../../chunk-R5JMDDCB.js';
+import '../../chunk-WCQVDF3K.js';
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/components/Breadcrumb/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}