@gamecrafters/base-ui 0.0.23 → 0.0.25

package/build/components/tour/Tour.types.d.ts

@@ -0,0 +1,143 @@
+import type * as React from "react";
+import type { ButtonVariant, ButtonVisual } from "../button";
+import type { CaretProps } from "../caret";
+import type { AnchorAlignment, AnchorSide } from "../tooltip/anchoredPosition";
+export type TourStepType = "dialog" | "tooltip" | "floating";
+export type TourFloatingPlacement = "top-start" | "top-end" | "bottom-start" | "bottom-end";
+export type TourActionKind = "next" | "prev" | "dismiss";
+export type TourAction = {
+    label: string;
+    action: TourActionKind | ((tour: TourApi) => void);
+};
+export type TourStepUpdate = {
+    title?: React.ReactNode;
+    description?: React.ReactNode;
+    actions?: TourAction[];
+};
+export type TourStepEffectArgs = {
+    next: () => void;
+    prev: () => void;
+    goto: (stepId: string) => void;
+    dismiss: () => void;
+    show: () => void;
+    update: (details: TourStepUpdate) => void;
+    target: () => HTMLElement | null;
+};
+export type TourStepEffectCleanup = (() => void) | void;
+export type TourStep = {
+    id: string;
+    type?: TourStepType;
+    title?: React.ReactNode;
+    description?: React.ReactNode;
+    target?: () => HTMLElement | null;
+    side?: AnchorSide;
+    align?: AnchorAlignment;
+    placement?: TourFloatingPlacement;
+    actions?: TourAction[];
+    backdrop?: boolean;
+    arrow?: boolean;
+    effect?: (args: TourStepEffectArgs) => TourStepEffectCleanup;
+};
+export type TourStatus = "started" | "completed" | "dismissed";
+export type TourStatusChangeDetails = {
+    status: TourStatus;
+};
+export type TourStepChangeDetails = {
+    stepId: string | null;
+    stepIndex: number;
+    count: number;
+};
+export type TourRect = {
+    top: number;
+    left: number;
+    width: number;
+    height: number;
+};
+export type TourApi = {
+    open: boolean;
+    step: TourStep | null;
+    stepIndex: number;
+    steps: TourStep[];
+    start: (stepId?: string) => void;
+    next: () => void;
+    prev: () => void;
+    goto: (stepId: string) => void;
+    dismiss: () => void;
+    progressText: string;
+    progressPercent: number;
+    hasNext: boolean;
+    hasPrev: boolean;
+};
+export type TourContextValue = TourApi & {
+    titleId: string;
+    descriptionId: string;
+    stepType: TourStepType;
+    ready: boolean;
+    targetRect: TourRect | null;
+    getTarget: () => HTMLElement | null;
+    spotlightOffset: number;
+    spotlightRadius: number;
+    contentRef: React.RefObject<HTMLDivElement | null>;
+};
+export type TourPositionerContextValue = {
+    side: AnchorSide;
+    align: AnchorAlignment;
+};
+export type TourProps = {
+    steps: TourStep[];
+    step?: string | null;
+    defaultStep?: string | null;
+    onStepChange?: (details: TourStepChangeDetails) => void;
+    open?: boolean;
+    defaultOpen?: boolean;
+    onOpenChange?: (open: boolean) => void;
+    onStatusChange?: (details: TourStatusChangeDetails) => void;
+    keyboardNavigation?: boolean;
+    closeOnEscape?: boolean;
+    closeOnInteractOutside?: boolean;
+    spotlightOffset?: number;
+    spotlightRadius?: number;
+    id?: string;
+    children?: React.ReactNode;
+};
+export type TourBackdropProps = React.ComponentPropsWithoutRef<"div"> & {
+    portalContainerName?: string;
+    className?: string;
+};
+export type TourSpotlightProps = TourBackdropProps;
+export type TourPositionerProps = React.ComponentPropsWithoutRef<"div"> & {
+    side?: AnchorSide;
+    align?: AnchorAlignment;
+    placement?: TourFloatingPlacement;
+    portalContainerName?: string;
+    className?: string;
+};
+export type TourContentProps = React.ComponentPropsWithoutRef<"div"> & {
+    className?: string;
+};
+export type TourArrowProps = Omit<CaretProps, "location">;
+export type TourCloseTriggerProps = Omit<React.ComponentPropsWithoutRef<"button">, "aria-labelledby"> & {
+    icon?: NonNullable<ButtonVisual>;
+    className?: string;
+};
+export type TourTitleProps = React.ComponentPropsWithoutRef<"h2"> & {
+    className?: string;
+};
+export type TourDescriptionProps = React.ComponentPropsWithoutRef<"div"> & {
+    className?: string;
+};
+export type TourProgressTextProps = React.ComponentPropsWithoutRef<"div"> & {
+    className?: string;
+};
+export type TourControlProps = React.ComponentPropsWithoutRef<"div"> & {
+    className?: string;
+};
+export type TourActionsProps = {
+    children: (actions: TourAction[]) => React.ReactNode;
+};
+export type TourActionTriggerProps = Omit<React.ComponentPropsWithoutRef<"button">, "action" | "children"> & {
+    action: TourAction;
+    variant?: ButtonVariant;
+    children?: React.ReactNode;
+    className?: string;
+};

package/build/components/tour/TourActionTrigger.d.ts

@@ -0,0 +1,8 @@
+import * as React from "react";
+declare const _default: (props: Omit<Omit<React.DetailedHTMLProps<React.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref">, "children" | "action"> & {
+    action: import("./Tour.types").TourAction;
+    variant?: import("..").ButtonVariant;
+    children?: React.ReactNode;
+    className?: string;
+} & React.RefAttributes<any>) => React.ReactNode;
+export default _default;

package/build/components/tour/TourActions.d.ts

@@ -0,0 +1,7 @@
+import * as React from "react";
+import type { TourActionsProps } from "./Tour.types";
+declare function TourActions(props: TourActionsProps): React.JSX.Element;
+declare namespace TourActions {
+    var displayName: string;
+}
+export default TourActions;

package/build/components/tour/TourArrow.d.ts

@@ -0,0 +1,4 @@
+import * as React from "react";
+import type { TourArrowProps } from "./Tour.types";
+declare const _default: (props: TourArrowProps & React.RefAttributes<any>) => React.ReactNode;
+export default _default;

package/build/components/tour/TourBackdrop.d.ts

@@ -0,0 +1,6 @@
+import * as React from "react";
+declare const _default: (props: Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+    portalContainerName?: string;
+    className?: string;
+} & React.RefAttributes<any>) => React.ReactNode;
+export default _default;

package/build/components/tour/TourCloseTrigger.d.ts

@@ -0,0 +1,6 @@
+import * as React from "react";
+declare const _default: (props: Omit<Omit<React.DetailedHTMLProps<React.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref">, "aria-labelledby"> & {
+    icon?: NonNullable<import("..").ButtonVisual>;
+    className?: string;
+} & React.RefAttributes<any>) => React.ReactNode;
+export default _default;

package/build/components/tour/TourContent.d.ts

@@ -0,0 +1,5 @@
+import * as React from "react";
+declare const _default: (props: Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+    className?: string;
+} & React.RefAttributes<any>) => React.ReactNode;
+export default _default;

package/build/components/tour/TourContext.d.ts

@@ -0,0 +1,3 @@
+import type { TourContextValue, TourPositionerContextValue } from "./Tour.types";
+export declare const TourContext: import("react").Context<TourContextValue | null>;
+export declare const TourPositionerContext: import("react").Context<TourPositionerContextValue | null>;

package/build/components/tour/TourControl.d.ts

@@ -0,0 +1,5 @@
+import * as React from "react";
+declare const _default: (props: Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+    className?: string;
+} & React.RefAttributes<any>) => React.ReactNode;
+export default _default;

package/build/components/tour/TourDescription.d.ts

@@ -0,0 +1,5 @@
+import * as React from "react";
+declare const _default: (props: Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+    className?: string;
+} & React.RefAttributes<any>) => React.ReactNode;
+export default _default;

package/build/components/tour/TourPositioner.d.ts

@@ -0,0 +1,9 @@
+import * as React from "react";
+declare const _default: (props: Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+    side?: import("..").AnchorSide;
+    align?: import("..").AnchorAlignment;
+    placement?: import("./Tour.types").TourFloatingPlacement;
+    portalContainerName?: string;
+    className?: string;
+} & React.RefAttributes<any>) => React.ReactNode;
+export default _default;

package/build/components/tour/TourProgressText.d.ts

@@ -0,0 +1,5 @@
+import * as React from "react";
+declare const _default: (props: Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+    className?: string;
+} & React.RefAttributes<any>) => React.ReactNode;
+export default _default;

package/build/components/tour/TourSpotlight.d.ts

@@ -0,0 +1,6 @@
+import * as React from "react";
+declare const _default: (props: Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+    portalContainerName?: string;
+    className?: string;
+} & React.RefAttributes<any>) => React.ReactNode;
+export default _default;

package/build/components/tour/TourTitle.d.ts

@@ -0,0 +1,5 @@
+import * as React from "react";
+declare const _default: (props: Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement>, "ref"> & {
+    className?: string;
+} & React.RefAttributes<any>) => React.ReactNode;
+export default _default;

package/build/components/tour/index.d.ts

@@ -0,0 +1,64 @@
+import TourBase, { DEFAULT_SPOTLIGHT_OFFSET, DEFAULT_SPOTLIGHT_RADIUS } from "./Tour";
+import TourActions from "./TourActions";
+import TourActionTrigger from "./TourActionTrigger";
+import TourArrow from "./TourArrow";
+import TourBackdrop from "./TourBackdrop";
+import TourCloseTrigger from "./TourCloseTrigger";
+import TourContent from "./TourContent";
+import TourControl from "./TourControl";
+import TourDescription from "./TourDescription";
+import TourPositioner from "./TourPositioner";
+import TourProgressText from "./TourProgressText";
+import TourSpotlight from "./TourSpotlight";
+import TourTitle from "./TourTitle";
+export declare const Tour: typeof TourBase & {
+    Backdrop: (props: Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+        portalContainerName?: string;
+        className?: string;
+    } & import("react").RefAttributes<any>) => React.ReactNode;
+    Spotlight: (props: Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+        portalContainerName?: string;
+        className?: string;
+    } & import("react").RefAttributes<any>) => React.ReactNode;
+    Positioner: (props: Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+        side?: import("..").AnchorSide;
+        align?: import("..").AnchorAlignment;
+        placement?: import("./Tour.types").TourFloatingPlacement;
+        portalContainerName?: string;
+        className?: string;
+    } & import("react").RefAttributes<any>) => React.ReactNode;
+    Content: (props: Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+        className?: string;
+    } & import("react").RefAttributes<any>) => React.ReactNode;
+    Arrow: (props: import("./Tour.types").TourArrowProps & import("react").RefAttributes<any>) => React.ReactNode;
+    CloseTrigger: (props: Omit<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref">, "aria-labelledby"> & {
+        icon?: NonNullable<import("..").ButtonVisual>;
+        className?: string;
+    } & import("react").RefAttributes<any>) => React.ReactNode;
+    ProgressText: (props: Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+        className?: string;
+    } & import("react").RefAttributes<any>) => React.ReactNode;
+    Title: (props: Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement>, "ref"> & {
+        className?: string;
+    } & import("react").RefAttributes<any>) => React.ReactNode;
+    Description: (props: Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+        className?: string;
+    } & import("react").RefAttributes<any>) => React.ReactNode;
+    Control: (props: Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+        className?: string;
+    } & import("react").RefAttributes<any>) => React.ReactNode;
+    Actions: typeof TourActions;
+    ActionTrigger: (props: Omit<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref">, "children" | "action"> & {
+        action: import("./Tour.types").TourAction;
+        variant?: import("..").ButtonVariant;
+        children?: React.ReactNode;
+        className?: string;
+    } & import("react").RefAttributes<any>) => React.ReactNode;
+};
+export { TourBackdrop, TourSpotlight, TourPositioner, TourContent, TourArrow, TourCloseTrigger, TourProgressText, TourTitle, TourDescription, TourControl, TourActions, TourActionTrigger, };
+export { DEFAULT_SPOTLIGHT_OFFSET, DEFAULT_SPOTLIGHT_RADIUS };
+export { TourContext, TourPositionerContext } from "./TourContext";
+export { useTour } from "./useTour";
+export { waitForElement, waitForElementValue, waitForEvent } from "./waitFor";
+export type { TourWait, TourWaitOptions, TourWaitForEventOptions } from "./waitFor";
+export * from "./Tour.types";

package/build/components/tour/useTour.d.ts

@@ -0,0 +1,2 @@
+import type { TourApi } from "./Tour.types";
+export declare const useTour: () => TourApi;

package/build/components/tour/waitFor.d.ts

@@ -0,0 +1,10 @@
+export type TourWait<T> = [Promise<T | null>, () => void];
+export type TourWaitOptions = {
+    timeout?: number;
+};
+export type TourWaitForEventOptions = AddEventListenerOptions & {
+    predicate?: (element: HTMLElement) => boolean;
+};
+export declare const waitForEvent: <K extends keyof HTMLElementEventMap>(target: (() => HTMLElement | null) | undefined, event: K, options?: TourWaitForEventOptions) => TourWait<HTMLElementEventMap[K]>;
+export declare const waitForElement: (query: () => HTMLElement | null, options?: TourWaitOptions) => TourWait<HTMLElement>;
+export declare const waitForElementValue: (query: () => HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement | null, value: string, options?: TourWaitOptions) => TourWait<HTMLElement>;