@protonradio/proton-ui 0.10.13-beta.5 → 0.10.13

package/dist/index.d.ts

@@ -1,11 +1,14 @@
 import { AriaDialogProps } from 'react-aria';
 import { AriaPopoverProps } 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';
 import { ForwardRefExoticComponent } from 'react';
+import { ItemProps } from 'react-stately';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { JSX as JSX_3 } from 'react';
 import { OverlayTriggerProps } from 'react-stately';
 import { OverlayTriggerState } from 'react-stately';
 import { PressEvent } from 'react-aria';
@@ -182,7 +185,7 @@ declare interface BaseInputProps {
     name: string;
     /**
      * The placeholder text to display when the input is empty.
-     * @note label takes precedence over placeholder, if both are provided.
+     * @note Placeholder takes precedence over label, if both are provided.
      * @external https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/placeholder
      */
     placeholder?: string;
@@ -332,7 +335,7 @@ declare interface DialogProps extends AriaDialogProps {
  *
  * @interface ElevationProps
  */
-export declare const Elevation: ({ children, hasPrimaryGradient, "data-testid": dataTestId, }: ElevationProps) => JSX_2.Element;
+export declare const Elevation: ({ children, hasPrimaryGradient, backgroundGradientDirection, "data-testid": dataTestId, }: ElevationProps) => JSX_2.Element;
 
 declare interface ElevationProps {
     /**
@@ -345,6 +348,10 @@ declare interface ElevationProps {
      * @default false
      */
     hasPrimaryGradient?: boolean;
+    /**
+     * The direction of the background gradient.
+     */
+    backgroundGradientDirection?: "left" | "right";
     /**
      * The data-testid attribute for testing purposes.
      */
@@ -564,6 +571,18 @@ declare interface ResponsiveMenuProps {
 
 export declare function ResponsiveMenuTrigger({ renderTrigger, menuId, size, actions, disabled, onClose, testId: triggerTestId, menuTestId, }: ResponsiveMenuProps): JSX_2.Element;
 
+export declare const ResponsiveSelect: {
+    Menu: typeof ResponsiveSelectMenu;
+    Option: <T>(props: ItemProps<T>) => JSX_3.Element;
+};
+
+/**
+ * A dropdown select menu that opens a Popover, or an ActionMenu on mobile.
+ * Supports controlled and uncontrolled modes.
+ * @interface SelectProps
+ */
+declare function ResponsiveSelectMenu<T extends object>({ label, name, isDisabled, disabledKeys, selectedKey, onSelectionChange, onOpen, onClose, items, "data-testid": testId, children, }: SelectProps<T>): JSX_2.Element;
+
 export declare const Row: <T = object>(props: ProtonRowProps<T>) => JSX.Element;
 
 /**
@@ -613,23 +632,19 @@ export { Section }
 
 export declare const Select: {
     Menu: typeof SelectMenu;
+    Option: <T>(props: ItemProps<T>) => JSX_3.Element;
 };
 
-declare interface SelectItem {
-    key: string;
-    label: string;
-    to?: string;
-    onAction?: (key: string) => void;
-}
-
 /**
- * A dropdown select menu that opens a popover on desktop and an action menu on mobile.
- * Supports controlled and uncontrolled modes.
+ * A dropdown select menu that opens a popover. Supports controlled and uncontrolled modes.
+ * @interface SelectProps
  */
-declare function SelectMenu({ label, name, isDisabled, disabledKeys, selectedKey, onSelectionChange, onOpen, onClose, items, "data-testid": testId, }: SelectProps): JSX_2.Element;
+declare function SelectMenu<T extends object>({ label, name, isDisabled, disabledKeys, selectedKey, onSelectionChange, onOpen, onClose, items, "data-testid": testId, children, }: SelectProps<T>): JSX_2.Element;
 
-declare interface SelectProps {
-    /** The name of the select field */
+declare interface SelectProps<T> {
+    /** The name of the select field
+     * @external https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name
+     */
     name: string;
     /** Label to display above the select
      * @external https://developer.mozilla.org/en-US/docs/Web/HTML/Element/label#text
@@ -640,21 +655,23 @@ declare interface SelectProps {
     /** Array of keys that should be disabled
      * @example ["Thing 1", "Thing 2"]
      */
-    disabledKeys?: string[];
+    disabledKeys?: (string | number)[];
     /** Currently selected key */
-    selectedKey?: string;
+    selectedKey?: string | number;
     /** Callback fired when selection changes */
-    onSelectionChange?: (key: string) => void;
+    onSelectionChange?: (key: string | number) => void;
     /** Callback fired when the menu opens */
     onOpen?: () => void;
     /** Callback fired when the menu closes */
     onClose?: () => void;
     /** Array of items to display
-     * @example [{ key: "thing-1", label: "Thing 1" }, { key: "thing-2", label: "Thing 2" }]
+     * @example [{ name: "thing 1", label: "Thing 1" }, { name: "thing 2", label: "Thing 2" }]
      */
-    items: SelectItem[];
+    items?: T[];
     /** Test ID for the select */
     "data-testid"?: string;
+    /** Children elements or render function */
+    children: CollectionChildren<T>;
 }
 
 export declare function Switch(props: SwitchProps): JSX_2.Element;