@nimbus-ds/components 5.31.0 → 5.32.0

package/dist/index.d.ts

@@ -4035,5 +4035,93 @@ export interface SegmentedControlContextValue {
  * @throws Error if not within a SegmentedControl
  */
 export declare const useSegmentedControlContext: () => SegmentedControlContextValue;
+export interface SplitButtonActionProperties {
+	/**
+	 * The content of the action item.
+	 * @TJS-type React.ReactNode
+	 */
+	children: ReactNode;
+	/**
+	 * Optional icon to display before the action text.
+	 * @TJS-type React.ReactNode
+	 */
+	icon?: ReactNode;
+	/**
+	 * Callback function when the action is clicked.
+	 * @TJS-type () => void;
+	 */
+	onClick?: () => void;
+	/**
+	 * Disables the action item.
+	 * @default false
+	 */
+	disabled?: boolean;
+}
+export type SplitButtonActionProps = SplitButtonActionProperties & Pick<BoxProps, "backgroundColor" | "borderWidth" | "display" | "alignItems" | "gap" | "p" | "borderRadius">;
+declare const SplitButtonAction: React.FC<SplitButtonActionProps>;
+export interface SplitButtonPrimaryProperties {
+	/**
+	 * The content of the primary button.
+	 * @TJS-type React.ReactNode
+	 */
+	children: ReactNode;
+	/**
+	 * Callback function when the primary button is clicked.
+	 * @TJS-type () => void;
+	 */
+	onClick?: () => void;
+}
+export type SplitButtonPrimaryProps = SplitButtonPrimaryProperties & Omit<ButtonHTMLAttributes<HTMLButtonElement>, "onClick" | "children">;
+declare const SplitButtonPrimary: React.FC<SplitButtonPrimaryProps>;
+export interface SplitButtonSecondaryProperties {
+	/**
+	 * The content of the secondary dropdown menu.
+	 * @TJS-type React.ReactNode
+	 */
+	children: ReactNode;
+	/**
+	 * Accessible label for the dropdown button.
+	 * @default "Show more actions"
+	 */
+	ariaLabel?: string;
+}
+export type SplitButtonSecondaryProps = SplitButtonSecondaryProperties & Omit<ButtonHTMLAttributes<HTMLButtonElement>, "children">;
+declare const SplitButtonSecondary: React.FC<SplitButtonSecondaryProps>;
+export interface SplitButtonComponents {
+	Action: typeof SplitButtonAction;
+	Primary: typeof SplitButtonPrimary;
+	Secondary: typeof SplitButtonSecondary;
+}
+export interface SplitButtonProperties {
+	/**
+	 * The subcomponents (Primary and Secondary).
+	 * @TJS-type React.ReactNode
+	 */
+	children: ReactNode;
+	/**
+	 * Disables the entire split button.
+	 * @default false
+	 */
+	disabled?: boolean;
+	/**
+	 * Controls the visibility of the popover.
+	 */
+	open?: boolean;
+	/**
+	 * Callback function to control popover opening and closing.
+	 * @TJS-type (open: boolean) => void;
+	 */
+	onOpenChange?: (open: boolean) => void;
+	/**
+	 * Position of the popover relative to the button.
+	 * @default bottom-end
+	 */
+	popoverPosition?: PopoverProps["position"];
+}
+export type SplitButtonProps = SplitButtonProperties & Omit<BoxProps, "children" | "display" | "gap" | "position">;
+/**
+ * SplitButton component allows users to perform actions by clicking a primary button and displaying a dropdown menu with additional actions.
+ */
+export declare const SplitButton: React.FC<SplitButtonProps> & SplitButtonComponents;
 
 export {};