@commercetools/nimbus 0.0.0-canary-20251015171040 → 0.0.0-canary-20251015182814

package/dist/radio-input.d.ts

@@ -1,12 +1,13 @@
 import { HTMLChakraProps } from '@chakra-ui/react';
 import { JSX } from 'react/jsx-runtime';
-import { RadioGroupProps as RadioGroupProps_2 } from 'react-aria-components';
+import { RadioGroupProps } from 'react-aria-components';
 import { RadioInputOptionProps as RadioInputOptionProps_2 } from './radio-input.types';
 import { RadioInputRootProps as RadioInputRootProps_2 } from './radio-input.types';
 import { RadioProps } from 'react-aria-components';
 import { RecipeProps } from '@chakra-ui/react';
 
-declare type RadioGroupProps = Omit<RadioGroupProps_2, "children" | "orientation"> & {
+declare type RadioGroupPropsSubset = Omit<RadioGroupProps, "children" | "orientation"> & {
+    /** Radio options to display */
     children?: React.ReactNode;
 };
 
@@ -31,6 +32,10 @@ export declare type RadioInputOptionProps = RadioProps & Omit<RadioInputOptionSl
 export declare type RadioInputOptionSlotProps = HTMLChakraProps<"span", RecipeProps<"option">>;
 
 declare type RadioInputRecipeProps = {
+    /**
+     * Layout orientation for radio options
+     * @default "vertical"
+     */
     orientation?: RecipeProps<"radioInput">["orientation"];
 };
 
@@ -46,7 +51,7 @@ export declare const _RadioInputRoot: {
     displayName: string;
 };
 
-export declare type RadioInputRootProps = Omit<RadioInputRootSlotProps, keyof RadioGroupProps> & RadioGroupProps;
+export declare type RadioInputRootProps = Omit<RadioInputRootSlotProps, keyof RadioGroupPropsSubset> & RadioGroupPropsSubset;
 
 export declare type RadioInputRootSlotProps = HTMLChakraProps<"div", RadioInputRecipeProps>;
 

package/dist/range-calendar.d.ts

@@ -4,10 +4,6 @@ import { JSX } from 'react/jsx-runtime';
 import { RangeCalendarProps as RangeCalendarProps_2 } from 'react-aria-components';
 import { SlotRecipeProps } from '@chakra-ui/react';
 
-/**
- * Additional properties we want to exclude from the RangeCalendar component.
- * These are either deprecated or not intended for use in this component.
- */
 declare type ExcludedProps = "as" | "style" | "createCalendar";
 
 export declare const RangeCalendar: (props: RangeCalendarProps<DateValue>) => JSX.Element;
@@ -34,9 +30,6 @@ declare type RangeCalendarRecipeProps = SlotRecipeProps<"rangeCalendar">;
 
 export declare type RangeCalendarRootSlotProps = HTMLChakraProps<"div", RangeCalendarRecipeProps & RangeCalendarProps_2<DateValue>>;
 
-/**
- * Range value type for date ranges
- */
 export declare type RangeValue<T> = {
     start: T;
     end: T;

package/dist/scoped-search-input.d.ts

@@ -9,139 +9,76 @@ export declare const ScopedSearchInput: {
     displayName: string;
 };
 
-/**
- * Option definition for the select dropdown
- */
 export declare type ScopedSearchInputOption = {
-    /**
-     * Display label for the option
-     */
+    /** Display label for the option */
     label: string;
-    /**
-     * Unique value/key for the option
-     */
+    /** Unique value for the option */
     value: string;
-    /**
-     * Whether the option is disabled
-     */
+    /** Whether the option is disabled */
     isDisabled?: boolean;
 };
 
-/**
- * Option group definition for grouped options
- */
 export declare type ScopedSearchInputOptionGroup = {
-    /**
-     * Group label
-     */
+    /** Group label */
     label: string;
-    /**
-     * Options in this group
-     */
+    /** Options within the group */
     options: ScopedSearchInputOption[];
 };
 
 export declare type ScopedSearchInputProps = Omit<ScopedSearchInputRootSlotProps, "value" | "onSubmit" | "as" | "asChild"> & {
-    /**
-     * The current value (controlled)
-     */
+    /** Current value (text + selected option) */
     value: ScopedSearchInputValue;
-    /**
-     * Callback when the unified value changes
-     */
+    /** Callback when complete value changes */
     onValueChange?: (value: ScopedSearchInputValue) => void;
-    /**
-     * Callback when the text input changes
-     */
+    /** Callback when only search text changes */
     onTextChange?: (text: string) => void;
-    /**
-     * Callback when the select option changes
-     */
+    /** Callback when only option changes */
     onOptionChange?: (option: string) => void;
-    /**
-     * Callback when search is submitted (Enter key or submit button)
-     */
+    /** Callback when search is submitted */
     onSubmit: (value: ScopedSearchInputValue) => void;
-    /**
-     * Callback when reset/clear is triggered
-     */
+    /** Callback when search is reset/cleared */
     onReset?: () => void;
-    /**
-     * Options for the select dropdown
-     */
+    /** Available scope options or option groups */
     options: ScopedSearchInputOption[] | ScopedSearchInputOptionGroup[];
-    /**
-     * Placeholder text for the select dropdown
-     */
+    /** Placeholder for scope selector */
     selectPlaceholder?: string;
-    /**
-     * Placeholder text for the search input
-     */
+    /** Placeholder for search input */
     searchPlaceholder?: string;
-    /**
-     * Accessible label for the select dropdown
-     */
+    /** Aria label for scope selector */
     selectAriaLabel?: string;
-    /**
-     * Accessible label for the search input
-     */
+    /** Aria label for search input */
     searchAriaLabel?: string;
-    /**
-     * Whether to show the clear button in the search input
-     * @default true
-     */
+    /** Whether to show clear button */
     isClearable?: boolean;
-    /**
-     * Whether the component is disabled
-     * @default false
-     */
+    /** Whether the input is disabled */
     isDisabled?: boolean;
-    /**
-     * Whether the component is read-only
-     * @default false
-     */
+    /** Whether the input is read-only */
     isReadOnly?: boolean;
-    /**
-     * Whether the component is in an invalid state
-     * @default false
-     */
+    /** Whether the input has validation errors */
     isInvalid?: boolean;
-    /**
-     * Whether the component is required
-     * @default false
-     */
+    /** Whether the input is required */
     isRequired?: boolean;
-    /**
-     * ID for the component (used for ARIA relationships)
-     */
+    /** Unique identifier */
     id?: string;
-    /**
-     * ID of element describing the component
-     */
+    /** ID of element describing the input */
     "aria-describedby"?: string;
-    /**
-     * ID of element labeling the component
-     */
+    /** ID of element labeling the input */
     "aria-labelledby"?: string;
 };
 
 declare type ScopedSearchInputRecipeProps = {
+    /**
+     * Size variant of the scoped search input
+     */
     size?: SlotRecipeProps<"scopedSearchInput">["size"];
 };
 
 declare type ScopedSearchInputRootSlotProps = HTMLChakraProps<"div", ScopedSearchInputRecipeProps>;
 
-/**
- * Value structure for ScopedSearchInput
- */
 export declare type ScopedSearchInputValue = {
-    /**
-     * The text in the search input
-     */
+    /** Search text entered by user */
     text: string;
-    /**
-     * The selected option key from the select dropdown
-     */
+    /** Selected scope/category option */
     option: string;
 };
 

package/dist/search-input.d.ts

@@ -14,31 +14,35 @@ export declare const SearchInput: {
     displayName: string;
 };
 
-export declare type SearchInputInputProps = HTMLChakraProps<"input">;
+export declare type SearchInputInputSlotProps = HTMLChakraProps<"input">;
 
-export declare type SearchInputLeadingElementProps = HTMLChakraProps<"div">;
+export declare type SearchInputLeadingElementSlotProps = HTMLChakraProps<"div">;
 
-/**
- * Props for the SearchInput component.
- * Built on React Aria's SearchField for accessibility.
- */
-export declare type SearchInputProps = Omit<SearchInputRootProps, keyof SearchFieldProps | "as" | "asChild"> & Omit<SearchFieldProps, "ref"> & {
+export declare type SearchInputProps = Omit<SearchInputRootSlotProps, keyof SearchFieldProps | "as" | "asChild"> & Omit<SearchFieldProps, "ref"> & {
     /**
-     * React ref to be forwarded to the input element
+     * Ref forwarding to the input element
      */
     ref?: React.Ref<HTMLInputElement>;
     /**
-     * Placeholder text for the input
+     * Placeholder text for the search input
      */
     placeholder?: string;
 };
 
 declare type SearchInputRecipeProps = {
+    /**
+     * Size variant of the search input
+     * @default "md"
+     */
     size?: SlotRecipeProps<"searchInput">["size"];
+    /**
+     * Visual style variant of the search input
+     * @default "solid"
+     */
     variant?: SlotRecipeProps<"searchInput">["variant"];
 };
 
-export declare type SearchInputRootProps = HTMLChakraProps<"div", SearchInputRecipeProps>;
+export declare type SearchInputRootSlotProps = HTMLChakraProps<"div", SearchInputRecipeProps>;
 
 export { }
 

package/dist/select.d.ts

@@ -150,7 +150,9 @@ export declare const _SelectOptionGroup: {
 };
 
 export declare type SelectOptionGroupProps<T> = ListBoxSectionProps<T> & Omit<SelectOptionGroupSlotProps, keyof ListBoxSectionProps<T>> & {
-    /** the label for the section */
+    /**
+     * Label text for the option group section
+     */
     label: string;
 };
 
@@ -158,7 +160,7 @@ export declare type SelectOptionGroupSlotProps = HTMLChakraProps<"div">;
 
 export declare type SelectOptionProps = Omit<ListBoxItemProps, "onClick" | "translate" | "onBlur" | "onFocus" | "onKeyDown" | "onKeyUp" | "onMouseDown" | "onMouseUp"> & Omit<SelectOptionSlotProps, keyof ListBoxItemProps> & {
     /**
-     * React ref to be forwarded to the option element
+     * Ref forwarding to the option element
      */
     ref?: React.Ref<HTMLDivElement>;
 };
@@ -177,8 +179,14 @@ export declare interface SelectOptionsProps<T> extends ListBoxProps<T>, Omit<Sel
 
 export declare type SelectOptionsSlotProps = HTMLChakraProps<"div">;
 
-export declare type SelectRecipeProps = {
+declare type SelectRecipeProps = {
+    /**
+     * Size variant of the select
+     */
     size?: SlotRecipeProps<"select">["size"];
+    /**
+     * Visual style variant of the select
+     */
     variant?: SlotRecipeProps<"select">["variant"];
 };
 
@@ -195,19 +203,27 @@ export declare const _SelectRoot: {
 };
 
 export declare type SelectRootProps = SelectRootSlotProps & SelectProps & {
-    /** set to true if Select is currently busy with something */
+    /**
+     * Whether the select is in a loading state
+     * @default false
+     */
     isLoading?: boolean;
-    /** Children must be ReactNode, no render props/functions allowed */
+    /**
+     * Children elements (must be ReactNode, no render props/functions allowed)
+     */
     children: ReactNode;
     /**
-     * Optional element to display at the start of the input
-     * Will respect text direction (left in LTR, right in RTL)
+     * Optional element to display at the start of the input field
+     * Respects text direction (left in LTR, right in RTL)
      */
     leadingElement?: ReactNode;
-    /** Whether the select should show a clear button when a value is selected */
+    /**
+     * Whether to show a clear button when a value is selected
+     * @default false
+     */
     isClearable?: boolean;
     /**
-     * React ref to be forwarded to the root element
+     * Ref forwarding to the root element
      */
     ref?: React.Ref<HTMLDivElement>;
 };

package/dist/separator.d.ts

@@ -22,37 +22,20 @@ export declare const Separator: {
     displayName: string;
 };
 
-/**
- * Main props type for the Separator component.
- * Extends SeparatorVariantProps to include both root props and variant props,
- * while adding support for React Aria separator props.
- */
-export declare type SeparatorProps = SeparatorVariantProps & {
-    /** Reference to the separator element */
+export declare type SeparatorProps = SeparatorRootSlotProps & {
+    /**
+     * Data attributes for testing or custom metadata
+     */
+    [key: `data-${string}`]: unknown;
+    /**
+     * Ref forwarding to the root element
+     */
     ref?: React.Ref<HTMLDivElement>;
 };
 
-/**
- * Base recipe props type that combines Chakra UI's recipe props
- * with the unstyled prop option for the div element.
- */
-export declare type SeparatorRecipeProps = RecipeProps<"separator"> & UnstyledProp;
-
-/**
- * Root props type that extends Chakra's HTML props with our recipe props.
- * This creates a complete set of props for the root element, combining
- * HTML attributes, Chakra's styling system, and our custom recipe props.
- */
-export declare type SeparatorRootProps = HTMLChakraProps<"div", SeparatorRecipeProps>;
+declare type SeparatorRecipeProps = RecipeProps<"separator"> & UnstyledProp;
 
-/**
- * Combines the root props with Chakra UI's recipe variant props.
- * This allows the component to accept both structural props from Root
- * and styling variants from the recipe.
- */
-declare type SeparatorVariantProps = SeparatorRootProps & {
-    [key: `data-${string}`]: unknown;
-};
+export declare type SeparatorRootSlotProps = HTMLChakraProps<"div", SeparatorRecipeProps>;
 
 export { }
 

package/dist/split-button.d.ts

@@ -8,35 +8,42 @@ import { RecipeProps } from '@chakra-ui/react';
 import { SlotRecipeProps } from '@chakra-ui/react';
 import { UnstyledProp } from '@chakra-ui/react';
 
-declare type ButtonProps = ButtonRootProps & FunctionalButtonProps & {
+declare type ButtonProps = Omit<ButtonRootSlotProps, keyof AriaButtonProps> & AriaButtonProps & {
+    /**
+     * Data attributes for testing or custom metadata
+     */
+    [key: `data-${string}`]: unknown;
+    /**
+     * Slot name for React Aria Components composition
+     */
     slot?: string | null | undefined;
+    /**
+     * Ref forwarding to the button element
+     */
     ref?: React.Ref<HTMLButtonElement>;
 };
 
-/**
- * Base recipe props interface that combines Chakra UI's recipe props
- * with the unstyled prop option for the button element.
- */
 declare type ButtonRecipeProps = {
+    /**
+     * Size variant of the button
+     * @default "md"
+     */
     size?: RecipeProps<"button">["size"];
+    /**
+     * Visual style variant of the button
+     * @default "subtle"
+     */
     variant?: RecipeProps<"button">["variant"];
+    /**
+     * Color tone palette for the button
+     */
     tone?: RecipeProps<"button">["tone"];
 } & UnstyledProp;
 
-/**
- * Root props interface that extends Chakra's HTML props with our recipe props.
- * This creates a complete set of props for the root element, combining
- * HTML attributes, Chakra's styling system, and our custom recipe props.
- */
-declare type ButtonRootProps = Omit<HTMLChakraProps<"button", ButtonRecipeProps>, "slot"> & {
+declare type ButtonRootSlotProps = Omit<HTMLChakraProps<"button", ButtonRecipeProps>, "slot"> & {
     slot?: string | null | undefined;
 };
 
-/** combine chakra-button props with aria-button props */
-declare type FunctionalButtonProps = AriaButtonProps & Omit<ButtonRootProps, keyof AriaButtonProps | "slot"> & {
-    [key: `data-${string}`]: unknown;
-};
-
 /**
  * # SplitButton
  *

package/dist/switch.d.ts

@@ -3,9 +3,6 @@ import { HTMLChakraProps } from '@chakra-ui/react';
 import { JSX } from 'react/jsx-runtime';
 import { SlotRecipeProps } from '@chakra-ui/react';
 
-/**
- * List of props that should be excluded from the root props when combining with ARIA props
- */
 declare type ExcludedSwitchProps = "asChild" | "isIndeterminate" | "colorScheme" | "validationState" | "validationBehavior" | "validate";
 
 /**
@@ -20,22 +17,20 @@ export declare const Switch: {
     displayName: string;
 };
 
-/**
- * Main props interface for the Switch component.
- * Combines root element props with ARIA toggle functionality props.
- */
-export declare type SwitchProps = Omit<SwitchRootProps, ExcludedSwitchProps | "onChange"> & Omit<AriaCheckboxProps, ExcludedSwitchProps> & {
+export declare type SwitchProps = Omit<SwitchRootSlotProps, ExcludedSwitchProps | "onChange"> & Omit<AriaCheckboxProps, ExcludedSwitchProps> & {
     /**
-     * The content to display next to the switch.
-     * Can be a string or React node.
+     * The label content to display next to the switch
      */
     children?: React.ReactNode;
+    /**
+     * Ref forwarding to the input element
+     */
     ref?: React.Ref<HTMLInputElement>;
 };
 
 declare type SwitchRecipeProps = SlotRecipeProps<"switch">;
 
-declare type SwitchRootProps = HTMLChakraProps<"label", SwitchRecipeProps>;
+declare type SwitchRootSlotProps = HTMLChakraProps<"label", SwitchRecipeProps>;
 
 export { }
 

package/dist/tabs.d.ts

@@ -19,9 +19,6 @@ export declare const _Tab: {
     displayName: string;
 };
 
-/**
- * Props for individual tab item component
- */
 export declare type TabItemProps = {
     /**
      * The id of the tab item
@@ -136,10 +133,6 @@ export declare type TabsPanelsSlotProps = HTMLChakraProps<"div", SlotRecipeProps
     children?: React.ReactNode;
 };
 
-/**
- * Main props type for the Tabs root component.
- * Combines React Aria tabs props with our styling variants.
- */
 export declare type TabsProps = TabsRootSlotProps & TabsVariantProps & {
     children?: React.ReactNode;
     ref?: React.Ref<HTMLDivElement>;
@@ -147,8 +140,20 @@ export declare type TabsProps = TabsRootSlotProps & TabsVariantProps & {
 };
 
 declare type TabsRecipeProps = {
+    /**
+     * Layout orientation of the tabs
+     * @default "horizontal"
+     */
     orientation?: SlotRecipeProps<"tabs">["orientation"];
+    /**
+     * Placement of the tab list relative to panels
+     * @default "start"
+     */
     placement?: SlotRecipeProps<"tabs">["placement"];
+    /**
+     * Size variant of the tabs
+     * @default "md"
+     */
     size?: SlotRecipeProps<"tabs">["size"];
 };
 
@@ -164,9 +169,6 @@ export declare const _TabsRoot: {
     displayName: string;
 };
 
-/**
- * Root props type that extends React Aria's tabs props with our recipe props.
- */
 export declare type TabsRootSlotProps = HTMLChakraProps<"div", TabsRecipeProps> & {
     /**
      * The children of the Tabs component.
@@ -195,9 +197,6 @@ export declare type TabsTabSlotProps = HTMLChakraProps<"button", TabsRecipeProps
     isDisabled?: boolean;
 };
 
-/**
- * Tabs recipe variant props for direction and placement configuration
- */
 declare type TabsVariantProps = SlotRecipeProps<"tabs"> & {
     [key: `data-${string}`]: unknown;
 };

package/dist/tag-group.d.ts

@@ -29,44 +29,38 @@ export declare const TagGroup: {
     Tag: TagGroupTagComponent_2;
 };
 
-/** Final external props for the `<TagGroup>` component, including `children`. */
 export declare type TagGroupProps = TagGroupRecipeVariantProps & Omit<TagGroupRootProps, "size"> & {
     ref?: Ref<typeof TagGroup_2>;
 };
 
 declare type TagGroupRecipeVariantProps = {
+    /**
+     * Size variant of the tag group
+     * @default "lg"
+     */
     size?: SlotRecipeProps<"taggroup">["size"];
 };
 
-/** Type signature for the main `TagGroup` component. */
 export declare type TagGroupRootComponent = FC<TagGroupProps>;
 
-/** Combined props for the root element (Chakra styles + Aria behavior). */
 declare type TagGroupRootProps = TagGroupRootSlotProps & TagGroupProps_2;
 
-/** Base Chakra styling props for the root `div` slot. */
 declare type TagGroupRootSlotProps = HTMLChakraProps<"div", TagGroupRecipeVariantProps>;
 
-/** Type signature for the `TagGroup.Tag` sub-component. */
 export declare type TagGroupTagComponent = FC<TagGroupTagProps>;
 
-/** Type signature for the `TagGroup.TagList` sub-component. */
 export declare type TagGroupTagListComponent<T extends object> = FC<TagGroupTagListProps<T>>;
 
-/** Combined props for the tagList element (Chakra styles + Aria behavior + Recipe variants). */
 export declare type TagGroupTagListProps<T extends object> = TagListProps<T> & Omit<TagGroupTagListSlotProps, keyof TagListProps<T>> & {
     ref?: Ref<HTMLDivElement>;
 };
 
-/** Base Chakra styling props for the root `div` slot. */
 declare type TagGroupTagListSlotProps = HTMLChakraProps<"div", RecipeProps<"div">>;
 
-/** Combined props for the tag element (Chakra styles + Aria behavior + Recipe variants). */
 export declare type TagGroupTagProps = TagProps & Omit<TagGroupTagSlotProps, keyof TagProps> & {
     ref?: Ref<typeof Tag>;
 };
 
-/** Base Chakra styling props for the root `div` slot. */
 declare type TagGroupTagSlotProps = HTMLChakraProps<"div", RecipeProps<"div">>;
 
 export { }

package/dist/text-input.d.ts

@@ -15,36 +15,47 @@ export declare const TextInput: {
     displayName: string;
 };
 
-export declare type TextInputInputProps = HTMLChakraProps<"input">;
+export declare type TextInputInputSlotProps = HTMLChakraProps<"input">;
 
-export declare type TextInputLeadingElementProps = HTMLChakraProps<"div">;
+export declare type TextInputLeadingElementSlotProps = HTMLChakraProps<"div">;
 
-export declare type TextInputProps = Omit<TextInputRootProps, keyof TextFieldProps | "as" | "asChild"> & Omit<TextFieldProps, "ref"> & {
+export declare type TextInputProps = Omit<TextInputRootSlotProps, keyof TextFieldProps | "as" | "asChild"> & Omit<TextFieldProps, "ref"> & {
     /**
-     * React ref to be forwarded to the input element
+     * Ref forwarding to the input element
      */
     ref?: React.Ref<HTMLInputElement>;
     /**
      * Optional element to display at the start of the input
-     * Will respect text direction (left in LTR, right in RTL)
+     * Respects text direction (left in LTR, right in RTL)
      */
     leadingElement?: React.ReactNode;
     /**
      * Optional element to display at the end of the input
-     * Will respect text direction (right in LTR, left in RTL)
+     * Respects text direction (right in LTR, left in RTL)
      */
     trailingElement?: React.ReactNode;
+    /**
+     * Placeholder text for the input
+     */
     placeholder?: string;
 };
 
 declare type TextInputRecipeProps = {
+    /**
+     * Size variant of the text input
+     * @default "md"
+     */
     size?: SlotRecipeProps<"textInput">["size"];
+    /**
+     * Visual style variant of the text input
+     * @default "solid"
+     */
     variant?: SlotRecipeProps<"textInput">["variant"];
 };
 
-export declare type TextInputRootProps = HTMLChakraProps<"div", TextInputRecipeProps>;
+export declare type TextInputRootSlotProps = HTMLChakraProps<"div", TextInputRecipeProps>;
 
-export declare type TextInputTrailingElementProps = HTMLChakraProps<"div">;
+export declare type TextInputTrailingElementSlotProps = HTMLChakraProps<"div">;
 
 export { }