@protonradio/proton-ui 0.6.3 → 0.6.4

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { AriaDialogProps } from 'react-aria';
 import { AriaPopoverProps } from 'react-aria';
-import { AriaSelectProps } from 'react-aria';
 import { AriaTableProps } from 'react-aria';
+import { CollectionChildren } from '@react-types/shared';
 import { ColumnProps } from '@react-stately/table';
 import { default as default_2 } from 'react';
 import { DOMProps } from '@react-types/shared';
@@ -20,6 +20,61 @@ import { TableStateProps } from 'react-stately';
 import { TooltipProps as TooltipProps_2 } from 'react-aria-components';
 import { TooltipTriggerComponentProps } from 'react-aria-components';
 
+export declare function ActionMenu({ children, closeOnNavigation, isDisabled, showCancel, isOpen, close, "data-testId": testId, }: ActionMenuProps): JSX_2.Element;
+
+export declare namespace ActionMenu {
+    var Item: ({ name, to }: ActionMenuItemProps) => JSX_2.Element;
+}
+
+declare interface ActionMenuItemProps {
+    name: string | ReactNode;
+    to?: string;
+}
+
+/**
+ * @interface ActionMenuProps
+ * @description Props interface for the ActionMenu component
+ */
+declare interface ActionMenuProps extends ActionMenuToggleState {
+    /**
+     * @param {ReactNode | function} children - Content to be rendered inside the menu, can be components or render function
+     */
+    children?: ReactNode | ((props: {
+        close: () => void;
+    }) => ReactNode);
+    /**
+     * @param {boolean} isDisabled - Prevents the menu from closing
+     */
+    isDisabled?: boolean;
+    /**
+     * @param {boolean} showCancel - Shows the cancel button
+     */
+    showCancel?: boolean;
+    /**
+     * @param {string} data-testId - Test ID for the menu container
+     */
+    "data-testId"?: string;
+}
+
+/**
+ * @interface ActionMenuToggleState
+ * @description State interface for controlling the ActionMenu's open/close behavior
+ */
+declare interface ActionMenuToggleState {
+    /**
+     * @param {boolean} isOpen - Controls whether the menu is displayed
+     */
+    isOpen: boolean;
+    /**
+     * @param {() => void} close - Closes the menu
+     */
+    close: () => void;
+    /**
+     * @param {boolean} closeOnNavigation - Automatically closes when route changes
+     */
+    closeOnNavigation?: boolean;
+}
+
 export declare const Badge: ({ variant, children, ...props }: BadgeProps) => JSX_2.Element;
 
 export declare interface BadgeProps extends React.HTMLAttributes<HTMLDivElement> {
@@ -296,11 +351,55 @@ export declare const Select: {
     Option: <T>(props: ItemProps<T>) => JSX_3.Element;
 };
 
-declare function SelectMenu<T extends object>({ label, name, isDisabled, ...props }: SelectProps<T>): JSX_2.Element;
+/**
+ * A Dropdown select menu that opens a Popover, or an ActionMenu on mobile.
+ * Supports controlled and uncontrolled modes, and urlSearchParam syncing.
+ * @interface SelectProps
+ */
+declare function SelectMenu<T extends object>({ label, name, isDisabled, disabledKeys, selectedKey, onSelectionChange, items, "data-testid": testId, children, }: SelectProps<T>): JSX_2.Element;
 
-declare interface SelectProps<T> extends AriaSelectProps<T> {
-    label?: string;
+declare interface SelectProps<T> {
+    /** The name of the select field
+     * @external https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name
+     * @prop {string} name
+     */
     name: string;
+    /** Label to display above the select
+     * @external https://developer.mozilla.org/en-US/docs/Web/HTML/Element/label#text
+     * @prop {string} label
+     */
+    label?: string;
+    /** Whether the select is disabled
+     * @prop {boolean} isDisabled
+     */
+    isDisabled?: boolean;
+    /** Array of keys that should be disabled
+     * @example ["Thing 1", "Thing 2"]
+     * @prop {string[] | number[]} disabledKeys
+     */
+    disabledKeys?: (string | number)[];
+    /** Currently selected key
+     * @prop {string | number} selectedKey
+     */
+    selectedKey?: string | number;
+    /** Callback fired when selection changes
+     * @prop {(key: string | number) => void} onSelectionChange
+     */
+    onSelectionChange?: (key: string | number) => void;
+    /** Array of items to display
+     * @example [{ name: "thing 1", label: "Thing 1" }, { name: "thing 2", label: "Thing 2" }]
+     * @prop {object[]} items
+     */
+    items?: T[];
+    /**
+     * Test ID for the select
+     * @prop {string} data-testid
+     */
+    "data-testid"?: string;
+    /** Children elements or render function
+     * @prop {CollectionChildren<T>} children
+     */
+    children: CollectionChildren<T>;
 }
 
 declare const SUCCESS: {
@@ -502,3 +601,8 @@ export { }
 declare namespace ButtonGroup {
     var Option: (props: ButtonGroupOptionProps) => import("react/jsx-runtime").JSX.Element;
 }
+
+
+declare namespace ActionMenu {
+    var Item: ({ name, to }: ActionMenuItemProps) => import("react/jsx-runtime").JSX.Element;
+}