@bmsuisse/ui 0.13.0 → 0.15.0

package/dist/index.d.ts

@@ -209,6 +209,41 @@ interface ConfirmDialogProps {
  */
 declare const ConfirmDialog: ({ open, onOpenChange, title, description, confirmLabel, cancelLabel, onConfirm, variant, confirmTestId, cancelTestId, }: ConfirmDialogProps) => ReactElement;
 
+interface DialogActionsProps {
+    /**
+     * The dialog's non-cancel actions, ordered from *nearest to Cancel* to
+     * *most primary* — e.g. `[secondaryAction, primaryAction]`. For a plain
+     * two-button confirm dialog, pass a single primary action here.
+     */
+    actions: ReactNode[];
+    /** The dismissive/cancel action. */
+    cancel: ReactNode;
+}
+/**
+ * Renders `actions` and `cancel` in the order the current platform's own
+ * dialogs use — Windows puts Cancel on the right (trailing), every other
+ * platform we target (iOS/iPadOS, macOS, Android, Linux) puts it on the
+ * left (leading) — instead of a fixed order every caller has to get right
+ * itself. `ConfirmDialog` and `QuestionDialog` use this internally; use it
+ * directly for any other dialog/panel footer with the same
+ * actions-plus-cancel shape.
+ *
+ * Matches native multi-button "Save changes?"-style dialogs: the most
+ * primary action sits at the edge *opposite* Cancel (Windows:
+ * `Save · Don't Save · Cancel`; iOS/macOS: `Cancel · Don't Save · Save`),
+ * not next to it. `actions` is reversed when Cancel sits on the right
+ * (Windows), so the last element of `actions` — the primary action — is
+ * always the one furthest from Cancel, and the first element is always the
+ * one nearest Cancel, regardless of platform — a caller picks the order
+ * once, by meaning, and doesn't have to reason about which edge Cancel
+ * lands on.
+ *
+ * Renders no wrapping element of its own — nest it inside the caller's own
+ * footer container (e.g. `DialogFooter`, or `Modal`'s `footer` prop) for
+ * layout/spacing.
+ */
+declare function DialogActions({ actions, cancel }: DialogActionsProps): ReactElement;
+
 interface FormModalProps {
     /** Whether the modal is open. Fully controlled — no internal open state. */
     open: boolean;
@@ -313,6 +348,53 @@ interface ResponsivePanelProps {
  */
 declare const ResponsivePanel: ({ open, onOpenChange, title, description, children, footer, className, breakpoint, size, resizable, draggable, closeOnOutsideClick, }: ResponsivePanelProps) => ReactElement;
 
+interface QuestionDialogAction {
+    /** Button label. */
+    label: string;
+    /** Called when this action is clicked. May return a promise; the dialog waits for it before closing. */
+    onClick: () => void | Promise<void>;
+    /** Visual style of this action's button. Defaults to `"default"`. */
+    variant?: ButtonProps["variant"];
+    /** Forwarded to this action's `Button`, for test targeting. */
+    testId?: string;
+}
+interface QuestionDialogProps {
+    /** Whether the dialog is open. Fully controlled — no internal open state. */
+    open: boolean;
+    /** Called when Radix wants to change the open state (backdrop click, Esc, close button, Cancel). */
+    onOpenChange: (open: boolean) => void;
+    /** Dialog title. */
+    title: string;
+    /** Optional supporting copy shown under the title. */
+    description?: string;
+    /**
+     * The dialog's non-cancel actions, ordered from *nearest Cancel* to *most
+     * primary* (see `DialogActions`) — e.g.
+     * `[{ label: "Don't Save", ... }, { label: "Save", ... }]` puts "Save",
+     * the primary action, at the edge opposite Cancel on every platform,
+     * matching native "Save changes?"-style dialogs.
+     */
+    actions: QuestionDialogAction[];
+    /** Label for the cancel button. Defaults to `"Cancel"`. */
+    cancelLabel?: string;
+    /** Forwarded to the cancel button, for test targeting. */
+    cancelTestId?: string;
+}
+/**
+ * A dialog asking a question with any number of actions plus a Cancel —
+ * `ConfirmDialog` generalized past the fixed confirm/cancel pair, for
+ * prompts like "Save changes before closing?" (Don't Save / Cancel / Save).
+ * Like `ConfirmDialog`, it closes itself automatically after a successful
+ * action click — if the clicked action's `onClick` throws/rejects, the
+ * dialog stays open (and the error isn't swallowed) so a caller can surface
+ * its own error UI. Cancel always closes immediately.
+ *
+ * Button order follows the current platform's own convention via
+ * `DialogActions` — pick `actions`' order by *meaning* (least to most
+ * primary), not by which edge Cancel happens to land on.
+ */
+declare const QuestionDialog: ({ open, onOpenChange, title, description, actions, cancelLabel, cancelTestId, }: QuestionDialogProps) => ReactElement;
+
 interface FormFieldProps {
     /** Visible label text for the field. */
     label: string;
@@ -891,4 +973,22 @@ declare function cn(...inputs: ClassValue[]): string;
  */
 declare function useMediaQuery(query: string): boolean;
 
-export { AlertBox, type AlertBoxProps, type AlertBoxVariant, Badge, type BadgeProps, Button, ButtonGroup, type ButtonGroupOption, type ButtonGroupProps, type ButtonProps, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, Checkbox, Combobox, type GridColumn as ComboboxColumn, type ComboboxMultiProps, type ComboboxOption, type ComboboxProps, type ComboboxSingleProps, ConfirmDialog, type ConfirmDialogProps, Dialog, DialogContent, DialogDescription, DialogFooter, DialogHeader, DialogTitle, DialogTrigger, DonutChart, type DonutSegment, DropdownMenu, DropdownMenuCheckboxItem, DropdownMenuContent, DropdownMenuGroup, DropdownMenuItem, DropdownMenuLabel, DropdownMenuPortal, DropdownMenuRadioGroup, DropdownMenuRadioItem, DropdownMenuSeparator, DropdownMenuShortcut, DropdownMenuSub, DropdownMenuSubContent, DropdownMenuSubTrigger, DropdownMenuTrigger, FormField, type FormFieldProps, FormModal, type FormModalProps, Input, type InputProps, KpiCard, type KpiCardProps, Label, LoadingOverlay, type LoadingOverlayProps, LoadingSpinner, type LoadingSpinnerProps, Modal, type ModalProps, NavGroup, type NavGroupProps, type NavIconProps, NavItem, type NavItemProps, Popover, PopoverAnchor, PopoverContent, PopoverTrigger, ResponsivePanel, type ResponsivePanelProps, type ResponsivePanelSize, ScrollArea, ScrollBar, SearchBar, type SearchBarProps, SearchPanel, type SearchPanelMode, type SearchPanelProps, SearchTrigger, type SearchTriggerProps, Select, SelectContent, SelectGroup, SelectItem, SelectTrigger, type SelectTriggerProps, SelectValue, Separator, Sheet, SheetClose, SheetContent, type SheetContentProps, SheetDescription, SheetFooter, SheetHeader, SheetPortal, SheetTitle, SheetTrigger, Sidebar, SidebarNav, type SidebarNavProps, type SidebarProps, Skeleton, Sparkline, StatusBadge, type StatusBadgeProps, type StatusTone, Stepper, type StepperProps, type StepperStep, Switch, type SwitchProps, Table, TableBody, TableCaption, TableCell, TableFooter, TableHead, TableHeader, TableRow, Tabs, TabsContent, TabsList, TabsTrigger, TagCombobox, type TagComboboxOption, type TagComboboxProps, Textarea, type TextareaProps, Tooltip, TooltipContent, TooltipProvider, TooltipTrigger, badgeVariants, buttonVariants, cn, loadingSpinnerIconVariants, sheetVariants, useMediaQuery, useSidebarCollapsed };
+/**
+ * Whether the current runtime is Windows, based on the UA string. Returns
+ * `false` outside a browser (SSR, tests) so platform-dependent UI falls back
+ * to the non-Windows default rather than guessing.
+ */
+declare function isWindowsPlatform(): boolean;
+type ConfirmButtonPlacement = "leading" | "trailing";
+/**
+ * Where a dialog's affirmative/confirm button should sit, matching each
+ * platform's own system convention: Windows dialogs place OK/Save on the
+ * left (Cancel on the right); every other platform we target — iOS/iPadOS,
+ * macOS, Android, Linux — places the affirmative action on the right (the
+ * iOS/macOS Human Interface Guidelines require this, and it's the de facto
+ * default everywhere else too). Windows is the one exception, so this is
+ * driven entirely by `isWindowsPlatform`.
+ */
+declare function getConfirmButtonPlacement(): ConfirmButtonPlacement;
+
+export { AlertBox, type AlertBoxProps, type AlertBoxVariant, Badge, type BadgeProps, Button, ButtonGroup, type ButtonGroupOption, type ButtonGroupProps, type ButtonProps, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, Checkbox, Combobox, type GridColumn as ComboboxColumn, type ComboboxMultiProps, type ComboboxOption, type ComboboxProps, type ComboboxSingleProps, type ConfirmButtonPlacement, ConfirmDialog, type ConfirmDialogProps, Dialog, DialogActions, type DialogActionsProps, DialogContent, DialogDescription, DialogFooter, DialogHeader, DialogTitle, DialogTrigger, DonutChart, type DonutSegment, DropdownMenu, DropdownMenuCheckboxItem, DropdownMenuContent, DropdownMenuGroup, DropdownMenuItem, DropdownMenuLabel, DropdownMenuPortal, DropdownMenuRadioGroup, DropdownMenuRadioItem, DropdownMenuSeparator, DropdownMenuShortcut, DropdownMenuSub, DropdownMenuSubContent, DropdownMenuSubTrigger, DropdownMenuTrigger, FormField, type FormFieldProps, FormModal, type FormModalProps, Input, type InputProps, KpiCard, type KpiCardProps, Label, LoadingOverlay, type LoadingOverlayProps, LoadingSpinner, type LoadingSpinnerProps, Modal, type ModalProps, NavGroup, type NavGroupProps, type NavIconProps, NavItem, type NavItemProps, Popover, PopoverAnchor, PopoverContent, PopoverTrigger, QuestionDialog, type QuestionDialogAction, type QuestionDialogProps, ResponsivePanel, type ResponsivePanelProps, type ResponsivePanelSize, ScrollArea, ScrollBar, SearchBar, type SearchBarProps, SearchPanel, type SearchPanelMode, type SearchPanelProps, SearchTrigger, type SearchTriggerProps, Select, SelectContent, SelectGroup, SelectItem, SelectTrigger, type SelectTriggerProps, SelectValue, Separator, Sheet, SheetClose, SheetContent, type SheetContentProps, SheetDescription, SheetFooter, SheetHeader, SheetPortal, SheetTitle, SheetTrigger, Sidebar, SidebarNav, type SidebarNavProps, type SidebarProps, Skeleton, Sparkline, StatusBadge, type StatusBadgeProps, type StatusTone, Stepper, type StepperProps, type StepperStep, Switch, type SwitchProps, Table, TableBody, TableCaption, TableCell, TableFooter, TableHead, TableHeader, TableRow, Tabs, TabsContent, TabsList, TabsTrigger, TagCombobox, type TagComboboxOption, type TagComboboxProps, Textarea, type TextareaProps, Tooltip, TooltipContent, TooltipProvider, TooltipTrigger, badgeVariants, buttonVariants, cn, getConfirmButtonPlacement, isWindowsPlatform, loadingSpinnerIconVariants, sheetVariants, useMediaQuery, useSidebarCollapsed };