@commercetools/nimbus 0.0.11 → 0.0.12-rc1

package/dist/index.d.ts

@@ -30,12 +30,12 @@ import { DateValue } from '@internationalized/date';
 import { DateValue as DateValue_2 } from 'react-aria';
 import { default as default_2 } from 'react';
 import { DetailedHTMLProps } from 'react';
-import { Dialog as Dialog_2 } from '@chakra-ui/react';
+import { Dialog as Dialog_2 } from '@chakra-ui/react/dialog';
 import { DisclosureGroupProps as DisclosureGroupProps_2 } from './accordion.types';
 import { DisclosureProps } from 'react-aria-components';
 import { Dispatch } from 'react';
 import { FC } from 'react';
-import { Flex } from '@chakra-ui/react';
+import { Flex } from '@chakra-ui/react/flex';
 import { FocusableOptions } from 'react-aria';
 import { FormFieldDescriptionSlotProps } from './form-field.slots';
 import { FormFieldErrorSlotProps } from './form-field.slots';
@@ -44,15 +44,15 @@ import { FormFieldLabelSlotProps } from './form-field.slots';
 import { FormFieldProps as FormFieldProps_2 } from './form-field.types';
 import { ForwardRefExoticComponent } from 'react';
 import { GridItemProps } from '@chakra-ui/react';
-import { GridProps as GridProps_2 } from '@chakra-ui/react';
-import { Heading } from '@chakra-ui/react';
+import { GridProps as GridProps_2 } from '@chakra-ui/react/grid';
+import { Heading } from '@chakra-ui/react/typography';
 import { HTMLAttributes } from 'react';
-import { HTMLChakraProps } from '@chakra-ui/react';
-import { ImageProps as ImageProps_2 } from '@chakra-ui/react';
+import { HTMLChakraProps } from '@chakra-ui/react/styled-system';
+import { ImageProps as ImageProps_2 } from '@chakra-ui/react/image';
 import { JSX } from 'react/jsx-runtime';
 import { JsxStyleProps } from '@chakra-ui/react';
-import { KbdProps as KbdProps_2 } from '@chakra-ui/react';
-import { List as List_2 } from '@chakra-ui/react';
+import { KbdProps as KbdProps_2 } from '@chakra-ui/react/kbd';
+import { List as List_2 } from '@chakra-ui/react/list';
 import { ListBoxItemProps } from 'react-aria-components';
 import { ListBoxProps } from 'react-aria-components';
 import { ListBoxSectionProps } from 'react-aria-components';
@@ -80,8 +80,8 @@ import { RadioProps } from 'react-aria-components';
 import { RangeCalendarProps as RangeCalendarProps_2 } from 'react-aria-components';
 import { ReactNode } from 'react';
 import { RecipeDefinition } from '@chakra-ui/react';
-import { RecipeProps } from '@chakra-ui/react';
-import { RecipeVariantProps } from '@chakra-ui/react';
+import { RecipeProps } from '@chakra-ui/react/styled-system';
+import { RecipeVariantProps } from '@chakra-ui/react/styled-system';
 import { RecipeVariantRecord } from '@chakra-ui/react';
 import { Ref } from 'react';
 import { RefAttributes } from 'react';
@@ -94,13 +94,13 @@ import { SelectRootProps as SelectRootProps_2 } from './select.types';
 import { SeparatorProps } from 'react-aria';
 import { SeparatorProps as SeparatorProps_2 } from 'react-aria-components';
 import { SetStateAction } from 'react';
-import { SimpleGridProps as SimpleGridProps_2 } from '@chakra-ui/react';
+import { SimpleGridProps as SimpleGridProps_2 } from '@chakra-ui/react/grid';
 import { SlotRecipeDefinition } from '@chakra-ui/react';
 import { SlotRecipeVariantRecord } from '@chakra-ui/react';
-import { StackProps as StackProps_2 } from '@chakra-ui/react';
+import { StackProps as StackProps_2 } from '@chakra-ui/react/stack';
 import { SubmenuTriggerProps } from 'react-aria-components';
 import { SystemContext } from '@chakra-ui/react';
-import { Table } from '@chakra-ui/react';
+import { Table } from '@chakra-ui/react/table';
 import { Tag } from 'react-aria-components';
 import { TagGroup as TagGroup_2 } from 'react-aria-components';
 import { TagGroupProps as TagGroupProps_2 } from 'react-aria-components';
@@ -110,17 +110,18 @@ import { TagGroupTagListProps as TagGroupTagListProps_2 } from './tag-group.type
 import { TagListProps } from 'react-aria-components';
 import { TagProps } from 'react-aria-components';
 import { TextFieldProps } from 'react-aria-components';
-import { TextProps as TextProps_2 } from '@chakra-ui/react';
+import { TextProps as TextProps_2 } from '@chakra-ui/react/typography';
 import { ThemeProviderProps } from 'next-themes';
 import { TimeFieldStateOptions } from 'react-stately';
 import { TimeValue } from 'react-aria';
-import { ToggleButton } from 'react-aria-components';
+import { ToggleButton as ToggleButton_2 } from 'react-aria-components';
 import { ToggleButtonGroup as ToggleButtonGroup_2 } from 'react-aria-components';
 import { ToggleButtonGroupButtonComponent as ToggleButtonGroupButtonComponent_2 } from './toggle-button-group.types';
 import { ToggleButtonGroupRootComponent as ToggleButtonGroupRootComponent_2 } from './toggle-button-group.types';
+import { ToggleButtonProps as ToggleButtonProps_2 } from 'react-aria-components';
 import { TooltipProps as TooltipProps_2 } from 'react-aria-components';
 import { TooltipTriggerComponentProps } from 'react-aria-components';
-import { UnstyledProp } from '@chakra-ui/react';
+import { UnstyledProp } from '@chakra-ui/react/styled-system';
 import { useButton } from 'react-aria';
 import { useCopyToClipboard } from 'react-use';
 import { useDisclosure } from 'react-aria';
@@ -203,6 +204,13 @@ export declare interface AccordionProps extends Omit<DisclosureProps, "children"
     size?: "sm" | "md";
 }
 
+/**
+ * # Accordion
+ *
+ * Displays an Accordion.
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/navigation/accordion}
+ */
 export declare const _AccordionRoot: default_2.ForwardRefExoticComponent<Omit<DisclosureGroupProps, "ref"> & default_2.RefAttributes<HTMLDivElement>>;
 
 export declare type AccordionRootProps = HTMLChakraProps<"div", RecipeVariantProps<typeof accordionSlotRecipe>>;
@@ -346,9 +354,11 @@ declare const alertRecipe: SlotRecipeDefinition<"title" | "description" | "icon"
 }>;
 
 /**
- * Alert
- * ============================================================
+ * # Alert
+ *
  * Provides feedback to the user about the status of an action or system event
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/feedback/alert}
  */
 export declare const _AlertRoot: AlertRootComponent;
 
@@ -431,17 +441,11 @@ declare interface AvatarRootProps extends HTMLChakraProps<"div", AvatarRecipePro
 }
 
 /**
- * Badge
- * ============================================================
- * badge
+ * # Badge
  *
- * Features:
+ * Briefly highlights or categorizes associated UI elements with concise visual cues for status or metadata.
  *
- * - allows forwarding refs to the underlying DOM element
- * - accepts all native html 'HTMLSpanElement' attributes (including aria- & data-attributes)
- * - supports 'variants', 'sizes', etc. configured in the recipe
- * - allows overriding styles by using style-props
- * - supports 'asChild' and 'as' to modify the underlying html-element (polymorphic)
+ * @see {@link https://nimbus-documentation.vercel.app/components/data-display/badge}
  */
 export declare const Badge: {
     (props: BadgeProps): JSX.Element;
@@ -524,6 +528,13 @@ declare type BadgeVariantProps = BadgeRootProps & RecipeVariantProps<typeof badg
     [key: `data-${string}`]: string;
 };
 
+/**
+ * # Box
+ *
+ * A basic layout component that serves as a wrapper or container.
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/layout/box}
+ */
 export declare const Box: {
     (props: BoxProps): JSX.Element;
     displayName: string;
@@ -534,6 +545,13 @@ export declare interface BoxProps extends HTMLChakraProps<"div"> {
     ref?: React.Ref<HTMLDivElement>;
 }
 
+/**
+ * # Button
+ *
+ * Displays a Button.
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/inputs/button}
+ */
 export declare const Button: {
     (props: ButtonProps): JSX.Element;
     displayName: string;
@@ -615,9 +633,16 @@ declare interface ButtonRootProps extends Omit<HTMLChakraProps<"button", ButtonR
     slot?: string | null | undefined;
 }
 
+/**
+ * # Calendar
+ *
+ * Calendars display a grid of days in one or more months and allow users to select a single date.
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/inputs/calendar}
+ */
 export declare const Calendar: (props: CalendarProps<DateValue_2>) => JSX.Element;
 
-export declare interface CalendarProps<T extends DateValue> extends Omit<CalendarRootSlotProps, keyof CalendarProps_2<DateValue> | ExcludedProps_3>, Omit<CalendarProps_2<T>, ExcludedProps_3>, RecipeVariantProps<typeof calendarSlotRecipe> {
+export declare interface CalendarProps<T extends DateValue> extends Omit<CalendarRootSlotProps, keyof CalendarProps_2<DateValue> | ExcludedProps_4>, Omit<CalendarProps_2<T>, ExcludedProps_4>, RecipeVariantProps<typeof calendarSlotRecipe> {
 }
 
 declare interface CalendarRootSlotProps extends HTMLChakraProps<"div", RecipeVariantProps<typeof calendarSlotRecipe> & CalendarProps_2<DateValue>> {
@@ -726,6 +751,13 @@ declare const cardRecipe: SlotRecipeDefinition<"content" | "header" | "root", {
 declare interface CardRecipeProps extends RecipeProps<"div">, UnstyledProp {
 }
 
+/**
+ * # Card
+ *
+ * A versatile container component presents self-contained information
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/data-display/card}
+ */
 export declare const _CardRoot: {
     ({ children, ref, ...props }: CardProps): JSX.Element;
     displayName: string;
@@ -749,17 +781,11 @@ declare type CardVariantProps = CardRootProps & RecipeVariantProps<typeof cardRe
 };
 
 /**
- * Checkbox
- * ============================================================
- * displays a checkbox and an associated label
+ * # Checkbox
  *
- * Features:
+ * Displays a checkbox.
  *
- * - allows forwarding refs to the underlying DOM element
- * - accepts all native html 'HTMLDivElement' attributes (including aria- & data-attributes)
- * - supports 'variants', 'sizes', etc. configured in the recipe
- * - allows overriding styles by using style-props
- * - supports 'asChild' and 'as' to modify the underlying html-element (polymorphic)
+ * @see {@link https://nimbus-documentation.vercel.app/components/inputs/checkbox}
  */
 export declare const Checkbox: {
     (props: CheckboxProps): JSX.Element;
@@ -815,6 +841,12 @@ declare const checkboxSlotRecipe: SlotRecipeDefinition<"label" | "root" | "indic
 declare type CheckboxVariantProps = CheckboxRootProps & RecipeVariantProps<typeof checkboxSlotRecipe> & AriaCheckboxProps;
 
 /**
+ * # Code
+ *
+ * renders code blocks
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/typography/code}
+ *
  * @experimental This component is experimental and may change or be removed in future versions.
  */
 export declare const Code: ForwardRefExoticComponent<CodeProps & RefAttributes<HTMLElement>>;
@@ -947,6 +979,13 @@ export declare interface ComboBoxOptionsSlotProps extends HTMLChakraProps<"div",
 export declare interface ComboBoxPopoverSlotProps extends HTMLChakraProps<"div", RecipeProps<"popover">> {
 }
 
+/**
+ * # ComboBox
+ *
+ * A combo box combines a text input with a dropdown list, allowing users to filter a list of options to items matching a query.
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/inputs/combobox}
+ */
 export declare const _ComboBoxRoot: {
     <T extends object>({ children, ref, ...props }: ComboBoxRootProps<T>): JSX.Element;
     displayName: string;
@@ -987,7 +1026,6 @@ declare const comboBoxSlotRecipe: SlotRecipeDefinition<"option" | "popover" | "v
         solid: {
             root: {
                 width: "7200";
-                bg: "primary.1";
             };
             value: {
                 width: "100%";
@@ -1085,9 +1123,11 @@ declare type ConflictingFieldStateProps = keyof TimeFieldStateOptions<TimeValue>
 declare type ConflictingPickerStateProps = keyof DatePickerStateOptions<DateValue_2>;
 
 /**
- * DateInput
- * ============================================================
- * allows entering a date in the currently selected locale
+ * # DateInput
+ *
+ * allows entering a date
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/inputs/dateinput}
  */
 export declare const DateInput: {
     (props: DateInputProps): JSX.Element;
@@ -1102,7 +1142,7 @@ export declare const DateInput: {
  * 2. Merge with DateInputRootProps, excluding conflicting keys
  * 3. Add recipe variant props
  */
-export declare interface DateInputProps extends DateFieldProps<DateValue_2>, Omit<DateInputRootProps, keyof DateFieldProps<DateValue_2> | ExcludedProps_2>, RecipeVariantProps<typeof dateInputSlotRecipe> {
+export declare interface DateInputProps extends DateFieldProps<DateValue_2>, Omit<DateInputRootProps, keyof DateFieldProps<DateValue_2> | ExcludedProps_3>, RecipeVariantProps<typeof dateInputSlotRecipe> {
 }
 
 /**
@@ -1170,10 +1210,11 @@ declare const dateInputSlotRecipe: SlotRecipeDefinition<"root" | "segmentGroup"
 }>;
 
 /**
- * DatePicker
- * ============================================================
- * Combines a DateInput with a Calendar popover for date selection.
- * Users can either type a date directly or select from the calendar.
+ * # DatePicker
+ *
+ * a UI component for users to enter or select a specific calendar date.
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/inputs/datepicker}
  */
 export declare const DatePicker: {
     (props: DatePickerProps): JSX.Element;
@@ -1187,7 +1228,7 @@ export declare const DatePicker: {
  * 1. Conflicting props from DateInputProps to avoid TypeScript errors
  * 2. Explicitly excluded props that we don't want users to access
  */
-export declare interface DatePickerProps extends Omit<DateInputProps, ConflictingPickerStateProps | ExcludedProps_4>, Omit<DatePickerStateOptions<DateValue_2>, ExcludedProps_4>, RecipeVariantProps<typeof datePickerSlotRecipe> {
+export declare interface DatePickerProps extends Omit<DateInputProps, ConflictingPickerStateProps | ExcludedProps_5>, Omit<DatePickerStateOptions<DateValue_2>, ExcludedProps_5>, RecipeVariantProps<typeof datePickerSlotRecipe> {
     /**
      * Whether the calendar popover should be open by default (uncontrolled).
      */
@@ -1265,7 +1306,7 @@ export declare const DateRangePicker: {
  * We extend React Aria's DateRangePickerProps and add the size/variant props
  * that we want to pass through to the DateInput components.
  */
-export declare interface DateRangePickerProps extends Omit<DateRangePickerProps_2<DateValue_2>, ExcludedProps_7>, Omit<DateRangePickerRootProps, keyof DateRangePickerProps_2<DateValue_2> | ExcludedProps_7>, RecipeVariantProps<typeof dateRangePickerSlotRecipe> {
+export declare interface DateRangePickerProps extends Omit<DateRangePickerProps_2<DateValue_2>, ExcludedProps_8>, Omit<DateRangePickerRootProps, keyof DateRangePickerProps_2<DateValue_2> | ExcludedProps_8>, RecipeVariantProps<typeof dateRangePickerSlotRecipe> {
     /**
      * Whether the calendar popover should be open by default (uncontrolled).
      */
@@ -1344,6 +1385,12 @@ export declare interface DateRangePickerTimeInputProps {
 }
 
 /**
+ * # Dialog
+ *
+ * displays a dialog
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/feedback/dialog}
+ *
  * @experimental This component is experimental and may change or be removed in future versions.
  */
 export declare const Dialog: DialogComponents;
@@ -1470,47 +1517,53 @@ declare type DividerVariantProps = DividerRootProps & RecipeVariantProps<typeof
 
 declare type ExcludedNumberInputProps = "asChild" | "onChange";
 
+/**
+ * Additional properties we want to exclude from the ToggleButton component.
+ * These are chakra-ui props we don't want exposed for non-polymorphic components.
+ */
+declare type ExcludedProps = "css" | "colorScheme" | "unstyled" | "recipe" | "as" | "asChild";
+
 /**
  * Additional properties we want to exclude from the TimeInput component.
  * These are either deprecated or not intended for use in this component.
  */
-declare type ExcludedProps = "validationState" | "label" | "description" | "errorMessage" | "css" | "colorScheme" | "unstyled" | "recipe" | "as" | "asChild";
+declare type ExcludedProps_2 = "validationState" | "label" | "description" | "errorMessage" | "css" | "colorScheme" | "unstyled" | "recipe" | "as" | "asChild";
 
 /**
  * Additional properties we want to exclude from the DateInput component.
  * These are either deprecated or not intended for use in this component.
  */
-declare type ExcludedProps_2 = "validationState" | "label" | "description" | "errorMessage" | "css" | "colorScheme" | "unstyled" | "recipe" | "as" | "asChild";
+declare type ExcludedProps_3 = "validationState" | "label" | "description" | "errorMessage" | "css" | "colorScheme" | "unstyled" | "recipe" | "as" | "asChild";
 
 /**
  * Additional properties we want to exclude from the TimeInput component.
  * These are either deprecated or not intended for use in this component.
  */
-declare type ExcludedProps_3 = "as" | "asChild" | "style" | "createCalendar";
+declare type ExcludedProps_4 = "as" | "asChild" | "style" | "createCalendar";
 
 /**
  * Additional properties we want to exclude from the DatePicker component.
  * These are either deprecated or not intended for use in this component.
  */
-declare type ExcludedProps_4 = "validationState" | "label" | "description" | "errorMessage" | "css" | "colorScheme" | "unstyled" | "recipe" | "as" | "asChild" | "variant";
+declare type ExcludedProps_5 = "validationState" | "label" | "description" | "errorMessage" | "css" | "colorScheme" | "unstyled" | "recipe" | "as" | "asChild" | "variant";
 
 /**
  * Additional properties we want to exclude from the ProgressBar component.
  * These are chakra-ui props we don't want exposed.
  */
-declare type ExcludedProps_5 = "css" | "unstyled" | "as" | "asChild";
+declare type ExcludedProps_6 = "css" | "unstyled" | "as" | "asChild";
 
 /**
  * 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_6 = "as" | "style" | "createCalendar";
+declare type ExcludedProps_7 = "as" | "style" | "createCalendar";
 
 /**
  * Additional properties we want to exclude from the DateRangePicker component.
  * These are either deprecated or not intended for use in this component.
  */
-declare type ExcludedProps_7 = "validationState" | "label" | "description" | "errorMessage" | "css" | "colorScheme" | "unstyled" | "recipe" | "as" | "asChild";
+declare type ExcludedProps_8 = "validationState" | "label" | "description" | "errorMessage" | "css" | "colorScheme" | "unstyled" | "recipe" | "as" | "asChild";
 
 /**
  * List of props that should be excluded from the root props when combining with ARIA props
@@ -1641,9 +1694,11 @@ declare const formFieldRecipe: SlotRecipeDefinition<"input" | "label" | "popover
 }>;
 
 /**
- * FormField
- * ============================================================
- * displays inputs in a FormField context
+ * # FormField
+ *
+ * displays miscellaneous inputs in a FormField context
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/inputs/formfield}
  */
 export declare const _FormFieldRoot: ForwardRefExoticComponent<FormFieldProps & RefAttributes<HTMLDivElement>>;
 
@@ -1665,13 +1720,11 @@ export declare const Grid: {
 };
 
 /**
- * Grid
- * ============================================================
- * The Grid Layout Component provides a flexible and responsive way to structure content using a two-dimensional grid system. It allows elements to be arranged in rows and columns, enabling dynamic and efficient layouts for different screen sizes.
+ * # Grid
  *
- * Features:
+ * An easily customizable Grid component, re-exported from Chakra UI, that provides a consistent layout structure across different products.
  *
- * - allows forwarding refs to the underlying DOM element
+ * @see {@link https://nimbus-documentation.vercel.app/components/layout/grid}
  */
 export declare interface GridProps extends GridProps_2 {
     children?: React.ReactNode;
@@ -1681,8 +1734,11 @@ export declare interface GridProps extends GridProps_2 {
 export { Heading }
 
 /**
- * Icon
+ * # Icon
+ *
  * displays icon components
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/media/icon}
  */
 export declare const Icon: {
     (props: IconProps): JSX.Element;
@@ -1690,10 +1746,11 @@ export declare const Icon: {
 };
 
 /**
- * IconButton
- * ============================================================
- * displays a button with only an icon as child. It is based
- * on the regular `Button` component, but with a few adjustments.
+ * # IconButton
+ *
+ * displays a button with an icon only as child
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/inputs/iconbutton}
  */
 export declare const IconButton: {
     (props: IconButtonProps): JSX.Element;
@@ -1784,6 +1841,24 @@ declare interface IconRecipeProps extends RecipeProps<"svg">, UnstyledProp {
 declare interface IconRootSlotProps extends HTMLChakraProps<"svg", IconRecipeProps> {
 }
 
+/**
+ * # IconToggleButton
+ * ============================================================
+ * A toggle button with only an icon as child. It is based
+ * on the regular `ToggleButton` component, but with a few adjustments.
+ *
+ */
+export declare const IconToggleButton: {
+    ({ "aria-label": ariaLabel, children, ref, ...props }: IconToggleButtonProps): JSX.Element;
+    displayName: string;
+};
+
+export declare interface IconToggleButtonProps extends Omit<ToggleButtonProps, "aria-label"> {
+    /** explains the intended action, required for accessibility */
+    "aria-label": string;
+    ref?: React.Ref<HTMLButtonElement>;
+}
+
 /**
  * Combines the root props with Chakra UI's recipe variant props.
  * This allows the component to accept both structural props from Root
@@ -1792,9 +1867,11 @@ declare interface IconRootSlotProps extends HTMLChakraProps<"svg", IconRecipePro
 declare type IconVariantProps = Omit<IconRootSlotProps, keyof React.SVGProps<SVGSVGElement> | "css" | "unstyled" | "asChild" | "recipe"> & RecipeVariantProps<typeof iconRecipe>;
 
 /**
- * Image
+ * # Image
  *
- * Use this component to display an image.
+ * A component to display images with support for fallback.
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/media/image}
  */
 declare const Image_2: {
     (props: ImageProps): JSX.Element;
@@ -1806,10 +1883,12 @@ export declare interface ImageProps extends ImageProps_2 {
 }
 
 /**
- * Kbd component
+ * # Kbd
  *
  * Renders a keyboard shortcut or key combination, styled for visual clarity.
- * Typically used to visually represent keyboard keys
+ * Typically used to visually represent keyboard keys.
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/typography/kbd}
  */
 export declare const Kbd: ({ ref: forwardedRef, slot, ...props }: KbdProps) => JSX.Element;
 
@@ -1819,17 +1898,11 @@ export declare interface KbdProps extends Omit<KbdProps_2, "slot"> {
 }
 
 /**
- * Link
- * ============================================================
- * To allow a user to navigate to a different page or resource
+ * # Link
  *
- * Features:
+ * To allow a user to navigate to a different page or resource
  *
- * - allows forwarding refs to the underlying DOM element
- * - accepts all native html 'HTMLAnchorElement' attributes (including aria- & data-attributes)
- * - supports 'variants', 'sizes', etc. configured in the recipe
- * - allows overriding styles by using style-props
- * - supports 'asChild' and 'as' to modify the underlying html-element (polymorphic)
+ * @see {@link https://nimbus-documentation.vercel.app/components/navigation/link}
  */
 export declare const Link: {
     (props: LinkProps): JSX.Element;
@@ -1902,6 +1975,11 @@ declare type LinkVariantProps = Omit<LinkRootProps, "onFocus" | "onBlur" | "onCl
 };
 
 /**
+ * # List
+ *
+ * displays a list
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/typography/list}
  * @experimental This component is experimental and may change or be removed in future versions.
  */
 export declare const List: {
@@ -1917,9 +1995,11 @@ export declare const _ListItem: ForwardRefExoticComponent<List_2.ItemProps & Ref
 export declare const _ListRoot: ForwardRefExoticComponent<List_2.RootProps & RefAttributes<HTMLUListElement>>;
 
 /**
- * LoadingSpinner
- * ============================================================
+ * # LoadingSpinner
+ *
  * Indicates ongoing processes or loading states
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/feedback/loadingspinner}
  */
 export declare const LoadingSpinner: {
     (props: LoadingSpinnerProps): JSX.Element;
@@ -2166,17 +2246,11 @@ export declare interface MenuTriggerProps extends Omit<MenuTriggerSlotProps, key
 declare type MenuTriggerSlotProps = HTMLChakraProps<"button">;
 
 /**
- * MultilineTextInput
- * ============================================================
- * A textarea component that takes in multiline text as input
+ * # Multiline Text Input
  *
- * Features:
+ * A multiline text input component for capturing longer text content.
  *
- * - allows forwarding refs to the underlying DOM element
- * - accepts all native html 'HTMLTextAreaElement' attributes (including aria- & data-attributes)
- * - supports 'variants', 'sizes', etc. configured in the recipe
- * - allows overriding styles by using style-props
- * - supports auto-growing height based on content when `autoGrow` is enabled
+ * @see {@link https://nimbus-documentation.vercel.app/components/forms/multiline-text-input}
  */
 export declare const MultilineTextInput: {
     (props: MultilineTextInputProps): JSX.Element;
@@ -2233,6 +2307,13 @@ declare interface MultilineTextInputRecipeProps extends RecipeVariantProps<typeo
 
 declare type MultilineTextInputRootSlotProps = HTMLChakraProps<"textarea", MultilineTextInputRecipeProps>;
 
+/**
+ * # NimbusProvider
+ *
+ * provides an environment for the rest of the components to work in
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/utilities/nimbusprovider}
+ */
 export declare function NimbusProvider({ children, locale, router, ...props }: NimbusProviderProps): JSX.Element;
 
 export declare interface NimbusProviderProps extends ColorModeProviderProps {
@@ -2311,18 +2392,11 @@ export declare interface NimbusRouterOptionsBase {
 }
 
 /**
- * NumberInput
- * ============================================================
- * An input component that accepts only numbers with increment/decrement buttons
+ * # NumberInput
  *
- * Features:
+ * A number input allows users to enter numerical values and adjust them incrementally.
  *
- * - supports ref forwarding to the underlying DOM element
- * - supports number-specific props like min, max, step
- * - includes increment/decrement buttons for easy number adjustment
- * - supports 'variants', 'sizes', etc. configured in the recipe
- * - allows overriding styles by using style-props
- * - provides full accessibility support
+ * @see {@link https://nimbus-documentation.vercel.app/components/inputs/number-input}
  */
 export declare const NumberInput: {
     (props: NumberInputProps): JSX.Element;
@@ -2444,16 +2518,11 @@ declare interface NumberInputRecipeProps extends RecipeVariantProps<typeof numbe
 declare type NumberInputRootSlotProps = HTMLChakraProps<"div", NumberInputRecipeProps>;
 
 /**
- * PasswordInput
- * ============================================================
- * An input component that takes in password as input with toggleable visibility
+ * # PasswordInput
  *
- * Features:
+ * A password input is a text field that hides entered characters for secure password entry.
  *
- * - Based on TextInput with added password visibility toggle
- * - Allows toggling between type="password" and type="text"
- * - Positions the toggle button at the right edge of the input
- * - Inherits all TextInput features and props
+ * @see {@link https://nimbus-documentation.vercel.app/components/inputs/passwordinput}
  */
 export declare const PasswordInput: ForwardRefExoticComponent<Omit<PasswordInputProps, "ref"> & RefAttributes<HTMLInputElement>>;
 
@@ -2492,7 +2561,7 @@ export declare const ProgressBar: {
  * Extends ProgressBarRootProps to include root props, variant props, and aria props,
  * while adding custom props for label display and formatting.
  */
-export declare interface ProgressBarProps extends Omit<ProgressBarRootProps, ExcludedProps_5> {
+export declare interface ProgressBarProps extends Omit<ProgressBarRootProps, ExcludedProps_6> {
     /**
      * Ref forwarding to the root element
      */
@@ -2644,6 +2713,13 @@ export declare interface RadioInputOptionProps extends RadioProps, Omit<RadioInp
 export declare interface RadioInputOptionSlotProps extends HTMLChakraProps<"span", RecipeProps<"option">> {
 }
 
+/**
+ * # RadioInput
+ *
+ * A set of closely related, mutually exclusive or complementary actions that are important enough to be displayed directly in the interface for quick access.
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/inputs/radio-input}
+ */
 export declare const _RadioInputRoot: {
     (props: RadioInputRootProps): JSX.Element;
     displayName: string;
@@ -2679,7 +2755,7 @@ declare const radioInputSlotRecipe: SlotRecipeDefinition<"option" | "root", {
 
 export declare const RangeCalendar: (props: RangeCalendarProps<DateValue>) => JSX.Element;
 
-export declare interface RangeCalendarProps<T extends DateValue> extends Omit<RangeCalendarRootSlotProps, keyof RangeCalendarProps_2<DateValue> | ExcludedProps_6>, Omit<RangeCalendarProps_2<T>, ExcludedProps_6>, RecipeVariantProps<typeof rangeCalendarSlotRecipe> {
+export declare interface RangeCalendarProps<T extends DateValue> extends Omit<RangeCalendarRootSlotProps, keyof RangeCalendarProps_2<DateValue> | ExcludedProps_7>, Omit<RangeCalendarProps_2<T>, ExcludedProps_7>, RecipeVariantProps<typeof rangeCalendarSlotRecipe> {
 }
 
 declare interface RangeCalendarRootSlotProps extends HTMLChakraProps<"div", RecipeVariantProps<typeof rangeCalendarSlotRecipe> & RangeCalendarProps_2<DateValue>> {
@@ -2762,6 +2838,13 @@ export declare interface SelectOptionsProps<T> extends ListBoxProps<T>, Omit<Sel
 declare interface SelectOptionsSlotProps extends HTMLChakraProps<"div"> {
 }
 
+/**
+ * # Select
+ *
+ * displays a collapsible list of options and allows a user to select one of them.
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/inputs/select}
+ */
 export declare const _SelectRoot: ForwardRefExoticComponent<SelectRootProps & RefAttributes<HTMLDivElement>>;
 
 export declare interface SelectRootProps extends SelectRootSlotProps, SelectProps {
@@ -2833,13 +2916,11 @@ export declare const SimpleGrid: {
 };
 
 /**
- * SimpleGrid
- * ============================================================
- * The SimpleGrid Layout Component provides a flexible and responsive way to structure content.
+ * # SimpleGrid
  *
- * Features:
+ * displays a simple grid / matrix
  *
- * - allows forwarding refs to the underlying DOM element
+ * @see {@link https://nimbus-documentation.vercel.app/components/layout/simplegrid}
  */
 export declare interface SimpleGridProps extends SimpleGridProps_2 {
     children?: React.ReactNode;
@@ -2855,6 +2936,13 @@ export declare interface SingleSelectInputProps {
     ref?: default_2.Ref<HTMLInputElement>;
 }
 
+/**
+ * # Stack
+ *
+ * An easily customizable Stack component, re-exported from Chakra UI, that provides a consistent layout structure across different products.
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/layout/stack}
+ */
 export declare const Stack: {
     (props: StackProps): JSX.Element;
     displayName: string;
@@ -2866,9 +2954,11 @@ export declare interface StackProps extends StackProps_2 {
 }
 
 /**
- * Switch
- * ============================================================
- * displays a switch toggle and optionally an associated label
+ * # Switch
+ *
+ * A clear, visual toggle, allowing users to activate or deactivate a setting quickly.
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/inputs/switch}
  */
 export declare const Switch: {
     ({ ref: externalRef, ...props }: SwitchProps): JSX.Element;
@@ -3014,9 +3104,11 @@ export declare type TagGroupTagProps = TagProps & Omit<TagGroupTagSlotProps, key
 declare type TagGroupTagSlotProps = HTMLChakraProps<"div", RecipeProps<"div">>;
 
 /**
- * Text
+ * # Text
+ *
+ * the Text component is used to display text
  *
- * Use this component to display text.
+ * @see {@link https://nimbus-documentation.vercel.app/components/typography/text}
  */
 declare const Text_2: {
     ({ ref: forwardedRef, ...props }: TextProps): JSX.Element;
@@ -3025,16 +3117,11 @@ declare const Text_2: {
 export { Text_2 as Text }
 
 /**
- * TextInput
- * ============================================================
- * An input component that takes in text as input
+ * # TextInput
  *
- * Features:
+ * An input component that takes in a text as input
  *
- * - allows forwarding refs to the underlying DOM element
- * - accepts all native html 'HTMLInputElement' attributes (including aria- & data-attributes)
- * - supports 'variants', 'sizes', etc. configured in the recipe
- * - allows overriding styles by using style-props
+ * @see {@link https://nimbus-documentation.vercel.app/components/inputs/textinput}
  */
 export declare const TextInput: {
     (props: TextInputProps): JSX.Element;
@@ -3106,7 +3193,7 @@ export declare const TimeInput: {
  * 1. Conflicting props from TimeInputRootProps to avoid TypeScript errors
  * 2. Explicitly excluded props that we don't want users to access
  */
-export declare interface TimeInputProps extends Omit<TimeInputRootProps, ConflictingFieldStateProps | ExcludedProps>, Omit<TimeFieldStateOptions<TimeValue>, ExcludedProps>, RecipeVariantProps<typeof timeInputRecipe> {
+export declare interface TimeInputProps extends Omit<TimeInputRootProps, ConflictingFieldStateProps | ExcludedProps_2>, Omit<TimeFieldStateOptions<TimeValue>, ExcludedProps_2>, RecipeVariantProps<typeof timeInputRecipe> {
 }
 
 /**
@@ -3166,6 +3253,19 @@ declare interface TimeInputRecipeProps extends RecipeProps<"div">, UnstyledProp
 declare interface TimeInputRootProps extends HTMLChakraProps<"div", TimeInputRecipeProps> {
 }
 
+/**
+ * # ToggleButton
+ *
+ * A toggleable button component that can be pressed to switch between
+ * selected and unselected states.
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/inputs/togglebutton}
+ */
+export declare const ToggleButton: {
+    ({ ref: forwardedRef, ...props }: ToggleButtonProps): JSX.Element;
+    displayName: string;
+};
+
 /**
  * ToggleButtonGroup
  * ============================================================
@@ -3183,7 +3283,7 @@ export declare type ToggleButtonGroupButtonComponent = React.FC<ToggleButtonGrou
 
 /** Combined props for the button element (Chakra styles + Aria behavior). */
 export declare type ToggleButtonGroupButtonProps = ToggleButtonGroupButtonSlotProps & AriaToggleButtonProps & {
-    ref?: React.Ref<typeof ToggleButton>;
+    ref?: React.Ref<typeof ToggleButton_2>;
 };
 
 /** Base Chakra styling props for the `button` slot. */
@@ -3194,6 +3294,13 @@ export declare type ToggleButtonGroupProps = PropsWithChildren<ToggleButtonGroup
     ref?: React.Ref<typeof ToggleButtonGroup_2>;
 };
 
+/**
+ * # ToggleButtonGroup
+ *
+ * A set of closely related, mutually exclusive or complementary actions that are important enough to be displayed directly in the interface for quick access.
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/inputs/togglebuttongroup}
+ */
 export declare const _ToggleButtonGroupRoot: ToggleButtonGroupRootComponent;
 
 /** Type signature for the main `ToggleButtonGroup` component. */
@@ -3205,6 +3312,123 @@ declare type ToggleButtonGroupRootProps = ToggleButtonGroupRootSlotProps & AriaT
 /** Base Chakra styling props for the root `div` slot. */
 declare type ToggleButtonGroupRootSlotProps = HTMLChakraProps<"div", RecipeProps<"div">>;
 
+export declare interface ToggleButtonProps extends ToggleButtonProps_2, Omit<ToggleButtonRootProps, keyof ToggleButtonProps_2 | ExcludedProps> {
+    /**
+     * Ref to the underlying button element
+     */
+    ref?: React.Ref<HTMLButtonElement>;
+}
+
+declare const toggleButtonRecipe: RecipeDefinition<    {
+    size: {
+        "2xs"?: {
+            h: "600";
+            minW: "600";
+            fontSize: "300";
+            fontWeight: "500";
+            lineHeight: "400";
+            px: "200";
+            gap: "100";
+            _icon: {
+                width: "400";
+                height: "400";
+            };
+        } | undefined;
+        xs?: {
+            h: "800";
+            minW: "800";
+            fontSize: "350";
+            fontWeight: "500";
+            lineHeight: "400";
+            px: "300";
+            gap: "100";
+            _icon: {
+                width: "500";
+                height: "500";
+            };
+        } | undefined;
+        md?: {
+            h: "1000";
+            minW: "1000";
+            fontSize: "400";
+            lineHeight: "500";
+            px: "400";
+            gap: "200";
+            _icon: {
+                width: "600";
+                height: "600";
+            };
+        } | undefined;
+    };
+    variant: {
+        outline: {
+            "--button-bg": "transparent";
+            "--button-text": "{colors.colorPalette.11}";
+            "--border-width": "{sizes.25}";
+            "--border-color": "{colors.colorPalette.7}";
+            bg: "var(--button-bg)";
+            boxShadow: "0 0 0 var(--border-width) var(--border-color)";
+            color: "var(--button-text)";
+            "&[data-hovered='true']": {
+                "--button-bg": "{colors.colorPalette.2}";
+                "--border-color": "{colors.colorPalette.8}";
+            };
+            "&[data-selected=true]": {
+                "--button-bg": "{colors.colorPalette.3}";
+                "--border-color": "{colors.colorPalette.8}";
+                _hover: {
+                    "--button-bg": "{colors.colorPalette.4}";
+                    "--border-color": "{colors.colorPalette.9}";
+                };
+            };
+        };
+        ghost: {
+            "--button-text": "{colors.neutral.11}";
+            "--button-bg": "transparent";
+            color: "var(--button-text)";
+            bg: "var(--button-bg)";
+            "&[data-hovered='true']": {
+                "--button-bg": "{colors.colorPalette.2}";
+            };
+            "&[data-selected='true']": {
+                "--button-bg": "{colors.colorPalette.3}";
+                "--button-text": "{colors.colorPalette.11}";
+                "&[data-hovered='true']": {
+                    "--button-bg": "{colors.colorPalette.4}";
+                };
+            };
+        };
+    };
+    tone: {
+        primary?: {
+            colorPalette: "primary";
+        } | undefined;
+        critical?: {
+            colorPalette: "critical";
+        } | undefined;
+        neutral?: {
+            colorPalette: "neutral";
+        } | undefined;
+        info?: {
+            colorPalette: "info";
+        } | undefined;
+    };
+}>;
+
+/**
+ * Base recipe props interface that combines Chakra UI's recipe props
+ * with the unstyled prop option for the toggle button element.
+ */
+declare interface ToggleButtonRecipeProps extends RecipeVariantProps<typeof toggleButtonRecipe>, 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 ToggleButtonRootProps = HTMLChakraProps<"button", ToggleButtonRecipeProps>;
+
 export declare const Tooltip: {
     Root: typeof _TooltipRoot;
     Content: typeof _TooltipContent;
@@ -3253,13 +3477,11 @@ declare interface TooltipRecipeProps extends RecipeProps<"div">, UnstyledProp {
 }
 
 /**
- * TooltipRoot
- * ============================================================
- * Root component that wraps around a trigger element and Tooltip content.
- * It handles opening and closing the Tooltip when the user hovers over or focuses the trigger,
- * and positioning the Tooltip relative to the trigger.
+ * # Tooltip
+ *
+ * A contextual popup that displays a description for an element.
  *
- * This acts as the context provider for the compound Tooltip component.
+ * @see {@link https://nimbus-documentation.vercel.app/components/feedback/tooltip}
  */
 export declare function _TooltipRoot({ delay, closeDelay, ...props }: TooltipTriggerComponentProps): JSX.Element;
 
@@ -3353,6 +3575,13 @@ export { useCopyToClipboard }
 
 export { useHotkeys }
 
+/**
+ * # VisuallyHidden
+ *
+ * makes content accessible to screen readers but hides it visually
+ *
+ * @see {@link https://nimbus-documentation.vercel.app/components/accessibility/visually-hidden}
+ */
 export declare const VisuallyHidden: {
     (props: VisuallyHiddenProps): JSX.Element;
     displayName: string;