@ostack.tech/ui 0.1.0

package/dist/types/components/Toast/Toast.d.ts

@@ -0,0 +1,79 @@
+import { Toast as ToastPrimitive } from "radix-ui";
+import * as React from "react";
+import { CloseButton } from "../CloseButton";
+import { Icon, type IconProp } from "../Icon";
+/** Toast variants. */
+export type ToastVariant = "solid" | "subtle" | "outlined";
+/** Toast severities. */
+export type ToastSeverity = "neutral" | "info" | "success" | "danger" | "warning";
+/** Properties of the toast component. */
+export type ToastProps = ToastPropsWithAction | ToastPropsWithoutAction;
+/** Properties of the toast component when it has an action. */
+export interface ToastPropsWithAction extends ToastPropsBase {
+    action: React.ReactNode;
+    actionAltText: string;
+}
+/** Properties of the toast component when it does not have an action. */
+export interface ToastPropsWithoutAction extends ToastPropsBase {
+    action?: undefined;
+    actionAltText?: undefined;
+}
+/** Base properties of the toast component. */
+export interface ToastPropsBase extends Pick<React.ComponentPropsWithoutRef<typeof ToastPrimitive.Root>, "type" | "duration" | "defaultOpen" | "open" | "onOpenChange" | "onEscapeKeyDown" | "onPause" | "onResume" | "onSwipeStart" | "onSwipeEnd" | "forceMount">, Omit<React.ComponentPropsWithoutRef<"div">, "onPause"> {
+    /**
+     * Toast variant.
+     *
+     * @default solid
+     */
+    variant?: ToastVariant;
+    /**
+     * Sets the toast's severity.
+     *
+     * @default info
+     */
+    severity?: ToastSeverity;
+    /** Alert action. */
+    action?: React.ReactNode;
+    /**
+     * Describes an alternative way to achieve the action for assistive technology
+     * users who cannot access the toast easily.
+     *
+     * This should always be provided whenever the toast has an `action`.
+     */
+    actionAltText?: string;
+    /** Icon to show. Each severity except `"neutral"` has its own default icon. */
+    icon?: IconProp | null;
+    /**
+     * Whether to show a close button. By default, a close button is shown when an
+     * `action` is not specified.
+     */
+    showCloseButton?: boolean;
+    /** Properties to pass to the root component. */
+    rootProps?: Omit<React.ComponentPropsWithRef<"li">, "onPause">;
+    /** Properties to pass to the container component. */
+    containerProps?: React.ComponentPropsWithRef<"div">;
+    /** Properties to pass to the icon component. */
+    iconProps?: Omit<React.ComponentPropsWithRef<typeof Icon>, "icon">;
+    /** Properties to pass to the content component. */
+    contentProps?: React.ComponentPropsWithRef<"div">;
+    /** Properties to pass to the component containing the action/close button. */
+    actionContainerProps?: React.ComponentPropsWithRef<"div">;
+    /** Properties to pass to the close button component. */
+    closeButtonProps?: React.ComponentPropsWithRef<typeof CloseButton>;
+}
+/**
+ * The `Toast` component is a simple and powerful element that provides
+ * non-intrusive, temporary feedback to users. These messages can notify users
+ * about system statuses, errors, successes, or informational alerts in a
+ * visually appealing and unobtrusive manner.
+ *
+ * It composes the following subcomponents:
+ *
+ * - `ToastDescription`: Refers to the content displayed within the `Toast`
+ *   component. It typically includes the message or notification that the
+ *   `Toast` is meant to convey to the user.
+ * - `ToastTitle`: Refers to the title displayed within the `Toast` component. It
+ *   is typically used to highlight the main subject or category of the toast
+ *   notification.
+ */
+export declare const Toast: React.ForwardRefExoticComponent<ToastProps & React.RefAttributes<HTMLDivElement>>;

package/dist/types/components/Toast/ToastDescription.d.ts

@@ -0,0 +1,3 @@
+import { Toast as ToastPrimitive } from "radix-ui";
+/** The toast message. */
+export declare const ToastDescription: import("react").ForwardRefExoticComponent<ToastPrimitive.ToastDescriptionProps & import("react").RefAttributes<HTMLDivElement>>;

package/dist/types/components/Toast/ToastProvider.d.ts

@@ -0,0 +1,12 @@
+import { Toast as ToastPrimitive } from "radix-ui";
+import * as React from "react";
+/** Direction of pointer swipe that should close the toast */
+export type ToastSwipeDirection = "up" | "down" | "left" | "right";
+/** Properties of the toast provider. */
+export interface ToastProviderProps extends React.ComponentPropsWithoutRef<typeof ToastPrimitive.Provider> {
+}
+/**
+ * The provider that wraps the toasts and their viewport. It usually wraps the
+ * application.
+ */
+export declare function ToastProvider({ label, ...otherProps }: ToastProviderProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Toast/ToastTitle.d.ts

@@ -0,0 +1,7 @@
+import { Toast as ToastPrimitive } from "radix-ui";
+import * as React from "react";
+/** Properties of the toast title. */
+export interface ToastTitleProps extends React.ComponentPropsWithoutRef<typeof ToastPrimitive.Title> {
+}
+/** An optional title for the toast. */
+export declare const ToastTitle: React.ForwardRefExoticComponent<ToastTitleProps & React.RefAttributes<HTMLDivElement>>;

package/dist/types/components/Toast/ToastViewport.d.ts

@@ -0,0 +1,10 @@
+import { Toast as ToastPrimitive } from "radix-ui";
+import * as React from "react";
+/** Properties of the toast viewport component. */
+export interface ToastViewportProps extends React.ComponentPropsWithoutRef<typeof ToastPrimitive.Viewport> {
+}
+/**
+ * The fixed area where toasts appear. Users can jump to the viewport by
+ * pressing a hotkey.
+ */
+export declare const ToastViewport: React.ForwardRefExoticComponent<ToastViewportProps & React.RefAttributes<HTMLOListElement>>;

package/dist/types/components/Toast/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./Toast.tsx";
+export * from "./ToastDescription.tsx";
+export * from "./ToastProvider.tsx";
+export * from "./ToastTitle.tsx";
+export * from "./ToastViewport.tsx";

package/dist/types/components/Tooltip/Tooltip.d.ts

@@ -0,0 +1,55 @@
+import { Tooltip as TooltipPrimitive } from "radix-ui";
+import * as React from "react";
+/** Properties of the tooltip component. */
+export interface TooltipProps extends Omit<React.ComponentPropsWithoutRef<typeof TooltipPrimitive.Content>, "asChild" | "content" | "forceMount"> {
+    /** Tooltip's content. */
+    content: React.ReactNode;
+    /**
+     * Whether to show an arrow pointing to the anchor.
+     *
+     * @default true
+     */
+    showArrow?: boolean;
+    /** Tooltip's trigger element. */
+    children: React.ReactElement;
+    /** The open state of the tooltip when it is initially rendered. */
+    defaultOpen?: boolean;
+    /**
+     * The controlled open state of the tooltip. Should be used in conjunction
+     * with `onOpenChange`.
+     */
+    open?: boolean;
+    /** Event handler called when the open state of the tooltip changes. */
+    onOpenChange?: (open: boolean) => void;
+    /**
+     * Override the duration given to the `TooltipProvider` to customise the open
+     * delay for a specific tooltip.
+     */
+    delayDuration?: number;
+    /**
+     * Prevents the content from remaining open when hovering. Disabling this has
+     * accessibility consequences. Inherits from `TooltipProvider`.
+     */
+    disableHoverableContent?: boolean;
+    /** Used to force mounting when more control is needed. */
+    forceMount?: true;
+    /** Properties to pass to the portal component. */
+    portalProps?: Omit<React.ComponentPropsWithRef<typeof TooltipPrimitive.Portal>, "forceMount">;
+    /** Properties to pass to the arrow component. */
+    arrowProps?: React.ComponentPropsWithRef<typeof TooltipPrimitive.Arrow>;
+}
+/**
+ * The `Tooltip` component renders a popup that displays information related to
+ * an element (trigger) when the element receives keyboard focus or the mouse
+ * hovers over it.
+ *
+ * In ostack/UI applications, `TooltipProvider` is already integrated into the
+ * root container to ensure consistent tooltip behavior throughout the
+ * application. Developers typically don't need to configure it manually, as the
+ * default setup handles delay times and interactions seamlessly.
+ *
+ * For detailed information on these props, which do not have descriptions,
+ * please refer to the
+ * [docs](https://www.radix-ui.com/primitives/docs/components/tooltip).
+ */
+export declare const Tooltip: React.ForwardRefExoticComponent<TooltipProps & React.RefAttributes<HTMLDivElement>>;

package/dist/types/components/Tooltip/TooltipProvider.d.ts

@@ -0,0 +1,3 @@
+import { Tooltip as TooltipPrimitive } from "radix-ui";
+/** Wrapper providing global options for tooltips. */
+export declare const TooltipProvider: import("react").FC<TooltipPrimitive.TooltipProviderProps>;

package/dist/types/components/Tooltip/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./Tooltip.tsx";
+export * from "./TooltipProvider.tsx";

package/dist/types/components/VisuallyHidden/VisuallyHidden.d.ts

@@ -0,0 +1,3 @@
+import { VisuallyHidden as VisuallyHiddenPrimitive } from "radix-ui";
+/** Component that hides content from the screen in an accessible way. */
+export declare const VisuallyHidden: import("react").ForwardRefExoticComponent<VisuallyHiddenPrimitive.VisuallyHiddenProps & import("react").RefAttributes<HTMLSpanElement>>;

package/dist/types/components/VisuallyHidden/index.d.ts

@@ -0,0 +1 @@
+export * from "./VisuallyHidden.tsx";

package/dist/types/index.d.ts

@@ -0,0 +1,96 @@
+export * from "./components/Root";
+export * from "./locale";
+export * from "./components/Alert";
+export * from "./components/AlertDialog";
+export * from "./components/Button";
+export * from "./components/ButtonGroup";
+export * from "./components/Calendar";
+export * from "./components/Card";
+export * from "./components/Checkbox";
+export * from "./components/CheckboxGroup";
+export * from "./components/ClearContexts";
+export * from "./components/CloseButton";
+export * from "./components/Code";
+export * from "./components/Collapsible";
+export * from "./components/CommandMenu";
+export * from "./components/Container";
+export * from "./components/ControlAddon";
+export * from "./components/ControlCode";
+export * from "./components/DataTable";
+export * from "./components/DateInput";
+export * from "./components/DatePicker";
+export * from "./components/DateRangeInput";
+export * from "./components/DateRangePicker";
+export * from "./components/Dialog";
+export * from "./components/DropdownMenu";
+export * from "./components/ErrorBoundary";
+export * from "./components/Feedback";
+export * from "./components/FeedbackList";
+export * from "./components/FeedbackPopover";
+export * from "./components/Field";
+export * from "./components/FieldGroup";
+export * from "./components/Grid";
+export * from "./components/Heading";
+export * from "./components/HelperText";
+export * from "./components/Icon";
+export * from "./components/IconButton";
+export * from "./components/Input";
+export * from "./components/Keyboard";
+export * from "./components/Label";
+export * from "./components/Link";
+export * from "./components/Mark";
+export * from "./components/MenuList";
+export * from "./components/NumericInput";
+export * from "./components/Output";
+export * from "./components/Popover";
+export * from "./components/Portal";
+export * from "./components/RadioGroup";
+export * from "./components/Select";
+export * from "./components/Separator";
+export * from "./components/Slot";
+export * from "./components/Spinner";
+export * from "./components/Stack";
+export * from "./components/Stepper";
+export * from "./components/Table";
+export * from "./components/Tabs";
+export * from "./components/Tag";
+export * from "./components/TextArea";
+export * from "./components/Toast";
+export * from "./components/Tooltip";
+export * from "./components/VisuallyHidden";
+export * from "./providers/AlertDialogProvider";
+export * from "./providers/DocumentTitleProvider";
+export * from "./providers/ErrorReportingProvider";
+export * from "./providers/LocalizationProvider";
+export * from "./providers/PrefixProvider";
+export * from "./providers/ToastManagerProvider";
+export * from "./utils/boolDataAttr.ts";
+export * from "./utils/breakpoints.ts";
+export * from "./utils/combineEventHandlers.ts";
+export * from "./utils/control.ts";
+export * from "./utils/cx.ts";
+export * from "./utils/filtering.ts";
+export * from "./utils/keyboardShortcut.ts";
+export * from "./utils/mergeAriaIds.ts";
+export * from "./utils/nativeControls.ts";
+export * from "./utils/numericStringUtils.ts";
+export * from "./utils/parseDateStrict.ts";
+export * from "./utils/sorting.ts";
+export * from "./utils/stringHash.ts";
+export * from "./utils/useCombinedRef.ts";
+export * from "./utils/useConstant.ts";
+export * from "./utils/useControllableState.ts";
+export * from "./utils/useCssVars.ts";
+export * from "./utils/useDateTransformer.tsx";
+export * from "./utils/useIntersectionObserver.ts";
+export * from "./utils/useLatestValues.ts";
+export * from "./utils/useLayoutEffect.ts";
+export * from "./utils/useMeasure.ts";
+export * from "./utils/useMediaQuery.ts";
+export * from "./utils/useNumericTransformer.tsx";
+export * from "./utils/useResponsiveValues.ts";
+export * from "./utils/useScrollbarSize.ts";
+export * from "./utils/useScrollPosition.ts";
+export * from "./utils/useSpacing.ts";
+export * from "./utils/warnOnce.ts";
+export * from "./utils/zustandUtils.ts";

package/dist/types/locale/LocalizationObject.d.ts

@@ -0,0 +1,49 @@
+import { type Locale as DateFnsLocale } from "date-fns";
+import { type CalendarProps } from "../components/Calendar";
+import { type CloseButtonProps } from "../components/CloseButton";
+import { type CommandMenuDialogProps, type CommandMenuProps } from "../components/CommandMenu";
+import { type ControlCodeProps } from "../components/ControlCode";
+import { type DataTableContentProps, type DataTableFilterProps, type DataTablePaginationProps, type DataTableRowsPerPageProps } from "../components/DataTable";
+import { type DateInputProps } from "../components/DateInput";
+import { type DateRangeInputProps } from "../components/DateRangeInput";
+import { type ErrorBoundaryProps } from "../components/ErrorBoundary";
+import { type FeedbackProps } from "../components/Feedback";
+import { type FeedbackPopoverProps } from "../components/FeedbackPopover";
+import { type FieldGroupHeaderProps } from "../components/FieldGroup";
+import { type InputProps } from "../components/Input";
+import { type LabelProps } from "../components/Label";
+import { type NumericInputProps } from "../components/NumericInput";
+import { type SelectProps } from "../components/Select";
+import { type TableColumnProps, type TableHeadProps } from "../components/Table";
+import { type ToastProviderProps, type ToastViewportProps } from "../components/Toast";
+import { type ConfirmDialogOptions } from "../providers/AlertDialogProvider";
+/** Localization object representation. */
+export interface LocalizationObject {
+    languageTag: string;
+    dateFnsLocale: DateFnsLocale;
+    AlertDialog: Pick<ConfirmDialogOptions, "okText">;
+    Calendar: Pick<CalendarProps, "previousMonthLabel" | "nextMonthLabel">;
+    CloseButton: Pick<CloseButtonProps, "aria-label">;
+    CommandMenu: Pick<CommandMenuProps, "label" | "searchPlaceholder" | "listLabel" | "loadingLabel" | "emptyMessage">;
+    CommandMenuDialog: Pick<CommandMenuDialogProps, "title" | "description">;
+    ConfirmDialog: Pick<ConfirmDialogOptions, "okText" | "cancelText">;
+    ControlCode: Pick<ControlCodeProps, "visuallyHiddenPrefix">;
+    DataTable: Pick<DataTableContentProps, "emptyMessage">;
+    DataTableFilter: Pick<DataTableFilterProps, "aria-label" | "placeholder">;
+    DataTablePagination: Pick<DataTablePaginationProps, "rowsRange" | "previousPageButtonLabel" | "nextPageButtonLabel">;
+    DataTableRowsPerPage: Pick<DataTableRowsPerPageProps, "label">;
+    DateInput: Pick<DateInputProps, "shortFormat" | "fullFormat" | "placeholder" | "formatDescription" | "calendarButtonLabel">;
+    DateRangeInput: Pick<DateRangeInputProps, "startInputLabel" | "endInputLabel" | "calendarButtonLabel">;
+    ErrorBoundary: Pick<ErrorBoundaryProps, "fallbackTitle" | "fallbackMessage" | "resetButtonLabel">;
+    Feedback: Pick<FeedbackProps, "visuallyHiddenPrefix">;
+    FeedbackPopover: Pick<FeedbackPopoverProps, "label">;
+    FieldGroupHeader: Pick<FieldGroupHeaderProps, "visuallyHiddenCodePrefix">;
+    Input: Pick<InputProps, "clearButtonLabel">;
+    Label: Pick<LabelProps, "requiredIconLabel" | "helperButtonLabel">;
+    NumericInput: Pick<NumericInputProps, "decimalSeparator" | "groupingStyle" | "groupSeparator">;
+    Select: Pick<SelectProps, "searchPlaceholder" | "emptyMessage" | "optionsLabel" | "loadingOptionsLabel">;
+    TableColumn: Pick<TableColumnProps, "helperButtonLabel">;
+    TableHead: Pick<TableHeadProps, "sortByColumnDescription">;
+    ToastProvider: Pick<ToastProviderProps, "label">;
+    ToastViewport: Pick<ToastViewportProps, "label">;
+}

package/dist/types/locale/defaultLocale.d.ts

@@ -0,0 +1,3 @@
+import { type LocalizationObject } from "./LocalizationObject.ts";
+/** Default locale. */
+export declare const defaultLocale: LocalizationObject;

package/dist/types/locale/en-GB.d.ts

@@ -0,0 +1,3 @@
+import { type LocalizationObject } from "./LocalizationObject.ts";
+/** `en-GB` locale. */
+export declare const enGB: LocalizationObject;

package/dist/types/locale/en-US.d.ts

@@ -0,0 +1,3 @@
+import { type LocalizationObject } from "./LocalizationObject.ts";
+/** `en-US` locale. */
+export declare const enUS: LocalizationObject;

package/dist/types/locale/en.d.ts

@@ -0,0 +1,3 @@
+import { type LocalizationObject } from "./LocalizationObject.ts";
+/** `en` locale (partial). */
+export declare const en: Omit<LocalizationObject, "languageTag" | "dateFnsLocale">;

package/dist/types/locale/fr-FR.d.ts

@@ -0,0 +1,3 @@
+import { type LocalizationObject } from "./LocalizationObject.ts";
+/** `fr-FR` locale. */
+export declare const frFR: LocalizationObject;

package/dist/types/locale/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./LocalizationObject.ts";
+export * from "./defaultLocale.ts";
+export * from "./en-GB.ts";
+export * from "./en-US.ts";
+export * from "./fr-FR.tsx";
+export * from "./pt-PT.tsx";

package/dist/types/locale/pt-PT.d.ts

@@ -0,0 +1,3 @@
+import { type LocalizationObject } from "./LocalizationObject.ts";
+/** `pt-PT` locale. */
+export declare const ptPT: LocalizationObject;

package/dist/types/providers/AlertDialogProvider/AlertDialogProvider.d.ts

@@ -0,0 +1,7 @@
+import * as React from "react";
+/** Properties of the alert dialog provider. */
+export interface AlertDialogProviderProps {
+    children: React.ReactNode;
+}
+/** Alert dialog provider. */
+export declare function AlertDialogProvider({ children }: AlertDialogProviderProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/providers/AlertDialogProvider/AlertDialogProviderContext.d.ts

@@ -0,0 +1,97 @@
+import * as React from "react";
+import { type AlertDialogBody, type AlertDialogContent, type AlertDialogContentColor, type AlertDialogContentSize, type AlertDialogContentVariant, type AlertDialogDescription, type AlertDialogFooter, type AlertDialogHeader, type AlertDialogTitle } from "../../components/AlertDialog";
+import { type Button } from "../../components/Button";
+/** Options that can be provided to both `alert` and `confirm` alert dialogs. */
+export interface AlertDialogOptions {
+    /** Alert dialog's title. */
+    title?: React.ReactNode;
+    /**
+     * Alert dialog content variant.
+     *
+     * @default solid
+     */
+    variant?: AlertDialogContentVariant;
+    /**
+     * Whether sections should be merged together, as opposed to them being
+     * clearly delimited. By default, each section is clearly delimited via a
+     * border or solid background colour.
+     *
+     * @default false
+     */
+    mergeSections?: boolean;
+    /**
+     * Alert dialog content color.
+     *
+     * @default neutral
+     */
+    color?: AlertDialogContentColor;
+    /** Alert dialog content size. */
+    size?: AlertDialogContentSize;
+    /** Alert dialog's extra body content, displayed after the description. */
+    extraBodyContent?: React.ReactNode;
+    /** Alert dialog's action text. */
+    okText?: React.ReactNode;
+    /**
+     * Element that caused the alert dialog to be triggered. This element will be
+     * automatically focused when the dialog closes.
+     */
+    triggerElement?: HTMLElement | null;
+    /** Properties to pass to the alert dialog's content component. */
+    contentProps?: Omit<React.ComponentPropsWithoutRef<typeof AlertDialogContent>, "solid" | "color" | "size">;
+    /** Properties to pass to the alert dialog's header component. */
+    headerProps?: React.ComponentPropsWithRef<typeof AlertDialogHeader>;
+    /** Properties to pass to the alert dialog's title component. */
+    titleProps?: React.ComponentPropsWithRef<typeof AlertDialogTitle>;
+    /** Properties to pass to the alert dialog's body component. */
+    bodyProps?: React.ComponentPropsWithRef<typeof AlertDialogBody>;
+    /** Properties to pass to the alert dialog's description component. */
+    descriptionProps?: React.ComponentPropsWithRef<typeof AlertDialogDescription>;
+    /** Properties to pass to the alert dialog's footer component. */
+    footerProps?: React.ComponentPropsWithRef<typeof AlertDialogFooter>;
+    /** Properties to pass to the alert dialog's OK button component. */
+    okButtonProps?: Omit<React.ComponentPropsWithRef<typeof Button>, "onClick">;
+}
+/** Options that can be provided to a `confirm` alert dialog. */
+export interface ConfirmDialogOptions extends AlertDialogOptions {
+    /** Alert dialog's cancel text. */
+    cancelText?: React.ReactNode;
+    /** Properties to pass to the alert dialog's cancel button component. */
+    cancelButtonProps?: Omit<React.ComponentPropsWithRef<typeof Button>, "onClick">;
+}
+/** Value of the alert dialog context. */
+export interface AlertDialogProviderContextValue {
+    /**
+     * Displays an alert to prompt the user with custom content rendered by the
+     * provided `renderContent` function.
+     *
+     * The displayed content should eventually call the provided `resolve`
+     * function with the user-provided value.
+     *
+     * @param renderContent Function used to render the alert's content. Receives
+     *   a `resolve` function that should be called with the user-provided value.
+     * @returns A promise that resolves with the value called in `resolve`, or
+     *   `undefined` if the dialog was closed for another reason.
+     */
+    prompt: <T>(renderContent: (resolve: (value?: T | PromiseLike<T>) => void) => React.ReactNode) => Promise<T | undefined>;
+    /**
+     * Displays an alert (similar to the browser's `alert`, but non-blocking) via
+     * an alert dialog.
+     *
+     * @param description Alert description.
+     * @param dialogOptions Dialog options.
+     * @returns A promise that resolves once the dialog has been dismissed.
+     */
+    alert: (description: React.ReactNode, dialogOptions?: AlertDialogOptions) => Promise<void>;
+    /**
+     * Displays a confirmation dialog (similar to the browser's `confirm` but
+     * non-blocking) via an alert dialog.
+     *
+     * @param description Confirmation description.
+     * @param dialogOptions Dialog options.
+     * @returns A promise that resolves with a boolean representing whether the
+     *   dialog has been confirmed or cancelled.
+     */
+    confirm: (description: React.ReactNode, dialogOptions?: ConfirmDialogOptions) => Promise<boolean>;
+}
+/** Alert dialog context. */
+export declare const AlertDialogProviderContext: React.Context<AlertDialogProviderContextValue | undefined>;

package/dist/types/providers/AlertDialogProvider/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./AlertDialogProvider.tsx";
+export * from "./AlertDialogProviderContext.ts";
+export * from "./useAlertDialog.tsx";

package/dist/types/providers/AlertDialogProvider/useAlertDialog.d.ts

@@ -0,0 +1,68 @@
+import { type AlertDialogProviderContextValue } from "./AlertDialogProviderContext.ts";
+/**
+ * Hook used to access an alert dialog in an imperative manner, providing
+ * `alert` and `confirm` functions somewhat mimicking the browser's.
+ *
+ * It also exposes a lower level `prompt` function which allows custom dialog
+ * content to be provided, and any value to be resolved.
+ *
+ * @example
+ *
+ * ```typescript
+ * const { alert, confirm } = useAlertDialog();
+ *
+ * async function handleRemoveItemClick(event) {
+ *   if (
+ *     (await confirm(`Are you sure you wish to remove item #${itemId}?`),
+ *     {
+ *       title: "Remove item",
+ *       color: "danger",
+ *       okText: "Remove",
+ *       triggerElement: event.target,
+ *     })
+ *   ) {
+ *     api.removeItem(itemId);
+ *     await alert("Item removed successfully!", {
+ *       color: "success",
+ *       triggerElement: event.target,
+ *     });
+ *   }
+ * }
+ * ```
+ *
+ * @example
+ *
+ * ```typescript
+ * const { prompt } = useAlertDialog();
+ *
+ * async function handleClick(event) {
+ *   const result = await prompt((resolve) => (
+ *     <AlertDialogContent>
+ *       <AlertDialogHeader>
+ *         <AlertDialogTitle>Custom alert dialog title</AlertDialogTitle>
+ *       </AlertDialogHeader>
+ *       <AlertDialogBody>
+ *         <AlertDialogDescription>
+ *           Custom alert dialog description
+ *         </AlertDialogDescription>
+ *       </AlertDialogBody>
+ *       <AlertDialogFooter>
+ *         <AlertDialogCancel>
+ *           <Button variant="subtle" onClick={() => resolve()}>
+ *             Cancel
+ *           </Button>
+ *         </AlertDialogCancel>
+ *         <AlertDialogAction>
+ *           <Button color="primary" onClick={() => resolve("custom")}>
+ *             Confirm
+ *           </Button>
+ *         </AlertDialogAction>
+ *       </AlertDialogFooter>
+ *     </AlertDialogContent>
+ *   ));
+ *
+ *   console.assert(result === "custom" || result === undefined);
+ * }
+ * ```
+ */
+export declare function useAlertDialog(): AlertDialogProviderContextValue;

package/dist/types/providers/DocumentTitleProvider/DocumentTitle.d.ts

@@ -0,0 +1,12 @@
+import * as React from "react";
+/** Properties of the document title component. */
+export interface DocumentTitleProps {
+    /** Title to set as a breadcrumb of the document title. */
+    title?: string;
+    children: React.ReactNode;
+}
+/**
+ * Component used to set the provided title as a breadcrumb of the document
+ * title.
+ */
+export declare function DocumentTitle({ title, children }: DocumentTitleProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/providers/DocumentTitleProvider/DocumentTitleProvider.d.ts

@@ -0,0 +1,25 @@
+import * as React from "react";
+/** Properties of the document title provider. */
+export interface DocumentTitleProviderProps {
+    /** Base document title. Defaults to the existing document title at load time. */
+    baseDocumentTitle?: string | null;
+    /**
+     * String which separates the breadcrumbs from the base document title.
+     *
+     * @default " | "
+     */
+    baseSeparator?: string;
+    /**
+     * String which separates the breadcrumbs.
+     *
+     * @default " ‹ "
+     */
+    breadcrumbsSeparator?: string;
+    children: React.ReactNode;
+}
+/** Default base separator. */
+export declare const DEFAULT_DOCUMENT_TITLE_BASE_SEPARATOR = " | ";
+/** Default breadcrumbs separator. */
+export declare const DEFAULT_DOCUMENT_TITLE_BREADCRUMBS_SEPARATOR = " \u2039 ";
+/** Localisation provider. */
+export declare function DocumentTitleProvider({ baseDocumentTitle, baseSeparator, breadcrumbsSeparator, children, }: DocumentTitleProviderProps): import("react/jsx-runtime").JSX.Element;