@comitor/ui 2.0.0 → 3.0.0

package/dist/components/ui/tour-constants.js

@@ -0,0 +1,6 @@
+import { tourEn } from "../../i18n/namespaces/tour.js";
+const DEFAULT_TOUR_LABELS = { ...tourEn };
+export {
+  DEFAULT_TOUR_LABELS
+};
+//# sourceMappingURL=tour-constants.js.map

package/dist/components/ui/tour-constants.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/components/ui/tour-constants.ts"],"sourcesContent":["/**\n * Nhãn mặc định của `Tour`.\n *\n * Module **CỐ Ý không có `\"use client\"`**: mọi export của một file `\"use client\"` tới Server\n * Component là client-reference proxy, đọc ra `undefined` mà KHÔNG throw — xem\n * `src/chart/chart-colors.ts`. Barrel xuất module này TRỰC TIẾP; `tour.tsx` chỉ `import`.\n */\n\nimport { tourEn } from \"../../i18n/namespaces/tour.js\";\n\n/**\n * Chuỗi hiển thị và chuỗi a11y của `Tour`. Theo `ComitorLocaleProvider` (mặc định tiếng Anh, bảng\n * tiếng Việt dựng sẵn); truyền `labels` cho `Tour` để ghi đè từng khoá.\n *\n * ⚠ Thượng nguồn (Dice UI) chôn cứng chuỗi tiếng Anh trong từng nút (\"Previous\", \"Next\",\n * \"Finish\", \"Skip\", \"Close tour\") và bộ đếm `1 / 5`. Gói dùng chung cho MỌI app Comitor nên\n * chuỗi cứng là ngõ cụt cho app đa ngôn ngữ.\n *\n * Từng chỗ vẫn ghi đè riêng được: `children` của `TourPrev`/`TourNext`/`TourSkip`/`TourClose`,\n * `aria-label` của `TourClose`, `format` của `TourStepCounter`. `labels` là để đổi NGÔN NGỮ một\n * lần cho cả tour.\n */\nexport interface TourLabels {\n  /** `aria-label` của `TourClose` — nút chỉ có icon X, nên đây là tên DUY NHẤT của nó. */\n  close: string;\n  /** Chữ mặc định của `TourPrev` khi không có `children`. */\n  prev: string;\n  /** Chữ mặc định của `TourNext` ở mọi bước trừ bước cuối. */\n  next: string;\n  /** Chữ mặc định của `TourNext` ở bước CUỐI — bấm là kết thúc tour. */\n  finish: string;\n  /** Chữ mặc định của `TourSkip` khi không có `children`. */\n  skip: string;\n  /**\n   * Nội dung mặc định của `TourStepCounter`. `current` đếm từ 1.\n   * Là HÀM vì có số chèn vào giữa câu.\n   */\n  stepCounter: (current: number, total: number) => string;\n}\n\n/**\n * Nhãn TIẾNG ANH mặc định (từ `3.0.0`; trước đó là tiếng Việt). Bảng tiếng Việt:\n * `comitorMessagesVi.tour`. Component không đọc thẳng hằng này — nó đọc bảng của\n * `ComitorLocaleProvider`; hằng ở đây để app trải ra khi tự dựng nhãn.\n */\nexport const DEFAULT_TOUR_LABELS: TourLabels = { ...tourEn };\n"],"mappings":"AAQA,SAAS,cAAc;AAqChB,MAAM,sBAAkC,EAAE,GAAG,OAAO;","names":[]}

package/dist/components/ui/tour.d.ts

@@ -0,0 +1,125 @@
+import * as React from 'react';
+import { Button } from './button.js';
+import { TourLabels } from './tour-constants.js';
+import 'class-variance-authority/types';
+import 'class-variance-authority';
+
+declare const SIDE_OPTIONS: readonly ["top", "right", "bottom", "left"];
+declare const ALIGN_OPTIONS: readonly ["start", "center", "end"];
+type Side = (typeof SIDE_OPTIONS)[number];
+type Align = (typeof ALIGN_OPTIONS)[number];
+type Direction = "ltr" | "rtl";
+interface ScrollOffset {
+    top?: number;
+    bottom?: number;
+    left?: number;
+    right?: number;
+}
+type Boundary = Element | null;
+type StepTarget = string | React.RefObject<HTMLElement | null> | HTMLElement;
+interface DivProps extends React.ComponentProps<"div"> {
+    asChild?: boolean;
+}
+type PointerDownOutsideEvent = CustomEvent<{
+    originalEvent: PointerEvent;
+}>;
+type InteractOutsideEvent = CustomEvent<{
+    originalEvent: PointerEvent | FocusEvent;
+}>;
+type OpenAutoFocusEvent = CustomEvent<Record<string, never>>;
+type CloseAutoFocusEvent = CustomEvent<Record<string, never>>;
+interface TourProps extends DivProps {
+    open?: boolean;
+    defaultOpen?: boolean;
+    onOpenChange?: (open: boolean) => void;
+    value?: number;
+    defaultValue?: number;
+    onValueChange?: (step: number) => void;
+    onComplete?: () => void;
+    onSkip?: () => void;
+    onEscapeKeyDown?: (event: KeyboardEvent) => void;
+    onPointerDownOutside?: (event: PointerDownOutsideEvent) => void;
+    onInteractOutside?: (event: InteractOutsideEvent) => void;
+    onOpenAutoFocus?: (event: OpenAutoFocusEvent) => void;
+    onCloseAutoFocus?: (event: CloseAutoFocusEvent) => void;
+    dir?: Direction;
+    alignOffset?: number;
+    sideOffset?: number;
+    spotlightPadding?: number;
+    autoScroll?: boolean;
+    /** Mặc định `"smooth"`, hoặc `"auto"` khi người dùng bật `prefers-reduced-motion`. */
+    scrollBehavior?: ScrollBehavior;
+    scrollOffset?: ScrollOffset;
+    dismissible?: boolean;
+    modal?: boolean;
+    stepFooter?: React.ReactElement;
+    /**
+     * Ghi đè chuỗi hiển thị/a11y — xem `TourLabels`. Không truyền thì theo namespace `tour` của
+     * `ComitorLocaleProvider` (mặc định tiếng Anh).
+     * ⚠ Thêm so với thượng nguồn: bản gốc chôn cứng chuỗi tiếng Anh trong từng nút.
+     */
+    labels?: Partial<TourLabels>;
+}
+declare function Tour(props: TourProps): React.JSX.Element;
+interface TourStepProps extends DivProps {
+    target: StepTarget;
+    side?: Side;
+    sideOffset?: number;
+    align?: Align;
+    alignOffset?: number;
+    collisionBoundary?: Boundary | Boundary[];
+    collisionPadding?: number | Partial<Record<Side, number>>;
+    arrowPadding?: number;
+    sticky?: "partial" | "always";
+    hideWhenDetached?: boolean;
+    avoidCollisions?: boolean;
+    required?: boolean;
+    forceMount?: boolean;
+    onStepEnter?: () => void;
+    onStepLeave?: () => void;
+}
+declare function TourStep(props: TourStepProps): React.JSX.Element | null;
+interface TourSpotlightProps extends DivProps {
+    forceMount?: boolean;
+}
+declare function TourSpotlight(props: TourSpotlightProps): React.JSX.Element | null;
+interface TourSpotlightRingProps extends DivProps {
+    forceMount?: boolean;
+}
+declare function TourSpotlightRing(props: TourSpotlightRingProps): React.JSX.Element | null;
+interface TourPortalProps {
+    children?: React.ReactNode;
+    container?: HTMLElement | null;
+}
+declare function TourPortal(props: TourPortalProps): React.ReactPortal | null;
+interface TourArrowProps extends React.ComponentProps<"svg"> {
+    width?: number;
+    height?: number;
+    asChild?: boolean;
+}
+declare function TourArrow(props: TourArrowProps): React.JSX.Element;
+type TourHeaderProps = DivProps;
+declare function TourHeader(props: TourHeaderProps): React.JSX.Element;
+type TourTitleProps = DivProps;
+declare function TourTitle(props: TourTitleProps): React.JSX.Element;
+type TourDescriptionProps = DivProps;
+declare function TourDescription(props: TourDescriptionProps): React.JSX.Element;
+interface TourCloseProps extends React.ComponentProps<"button"> {
+    asChild?: boolean;
+}
+declare function TourClose(props: TourCloseProps): React.JSX.Element;
+type TourPrevProps = React.ComponentProps<typeof Button>;
+declare function TourPrev(props: TourPrevProps): React.JSX.Element;
+type TourNextProps = React.ComponentProps<typeof Button>;
+declare function TourNext(props: TourNextProps): React.JSX.Element;
+type TourSkipProps = React.ComponentProps<typeof Button>;
+declare function TourSkip(props: TourSkipProps): React.JSX.Element;
+interface TourStepCounterProps extends DivProps {
+    /** Mặc định `labels.stepCounter` của `Tour` — "Step 2 of 5". */
+    format?: (current: number, total: number) => string;
+}
+declare function TourStepCounter(props: TourStepCounterProps): React.JSX.Element;
+type TourFooterProps = DivProps;
+declare function TourFooter(props: TourFooterProps): React.JSX.Element;
+
+export { Tour, TourArrow, type TourArrowProps, TourClose, type TourCloseProps, TourDescription, type TourDescriptionProps, TourFooter, type TourFooterProps, TourHeader, type TourHeaderProps, TourNext, type TourNextProps, TourPortal, type TourPortalProps, TourPrev, type TourPrevProps, type TourProps, TourSkip, type TourSkipProps, TourSpotlight, type TourSpotlightProps, TourSpotlightRing, type TourSpotlightRingProps, TourStep, TourStepCounter, type TourStepCounterProps, type TourStepProps, TourTitle, type TourTitleProps };