@algolia/satellite 1.10.1 → 1.11.0

package/dist/cjs/Actions/Accordion/Accordion.d.ts

@@ -2,34 +2,37 @@ import * as RadixAccordion from "@radix-ui/react-accordion";
 import type { ReactNode, VFC } from "react";
 import type { IconComponentType } from "../../Icons";
 declare type AccordionSharedProps = {
+    /**
+     * The content of the `Accordion`.
+     */
     children: ReactNode;
     /**
-     * Defines a class name for the `Accordion`.
+     * The class name of the `Accordion`.
      */
     className?: string;
     /**
-     * Defines whether the `Accordion` is disabled, preventing the user from interacting with the accordion and all its items.
+     * Whether the `Accordion` is disabled, preventing the user from interacting with the accordion and all its items.
      */
     disabled?: boolean;
 };
 declare type AccordionSingleProps = {
     /**
-     * Defines whether a single or multiple items can be expanded at a time.
+     * Whether a single or multiple items can be expanded at a time.
      * @default false
      */
     multiple?: false;
     /**
-     * Defines the controlled value of the item to expand when `multiple` is `false`.
+     * The controlled value of the item to expand when `multiple` is `false`.
      * Must be used in conjunction with `onValueChange`.
      */
     value?: RadixAccordion.AccordionSingleProps["value"];
     /**
-     * Defines the value of the item to expand when initially rendered and `multiple` is `false`.
+     * The value of the item to expand when initially rendered and `multiple` is `false`.
      * Use when you do not need to control the state of the items.
      */
     defaultValue?: RadixAccordion.AccordionSingleProps["defaultValue"];
     /**
-     * Defines the event handler called when the expanded state of an item changes and `multiple` is `false`.
+     * The event handler called when the expanded state of an item changes and `multiple` is `false`.
      */
     onChange?: RadixAccordion.AccordionSingleProps["onValueChange"];
     /**
@@ -40,22 +43,22 @@ declare type AccordionSingleProps = {
 };
 declare type AccordionMultipleProps = {
     /**
-     * Defines whether a single or multiple items can be expanded at a time.
+     * Whether a single or multiple items can be expanded at a time.
      * @default false
      */
     multiple: true;
     /**
-     * Defines the controlled value of the item to expand when `multiple` is `true`.
+     * The controlled value of the item to expand when `multiple` is `true`.
      * Must be used in conjunction with `onValueChange`.
      */
     value?: RadixAccordion.AccordionMultipleProps["value"];
     /**
-     * Defines the value of the item to expand when initially rendered when `multiple` is `true`.
+     * The value of the item to expand when initially rendered when `multiple` is `true`.
      * Use when you do not need to control the state of the items.
      */
     defaultValue?: RadixAccordion.AccordionMultipleProps["defaultValue"];
     /**
-     * Defines the event handler called when the expanded state of an item changes and `multiple` is `true`.
+     * The event handler called when the expanded state of an item changes and `multiple` is `true`.
      */
     onChange?: RadixAccordion.AccordionMultipleProps["onValueChange"];
     /**
@@ -65,27 +68,30 @@ declare type AccordionMultipleProps = {
 };
 export declare type AccordionProps = AccordionSharedProps & (AccordionSingleProps | AccordionMultipleProps);
 export declare type AccordionItemProps = {
+    /**
+     * Defines the content of the `AccordionItem`.
+     */
     children: ReactNode;
     /**
-     * Defines a class name for the item.
+     * Defines a class name for the `AccordionItem`.
      */
     className?: string;
     /**
-     * Defines a unique value for the item.
+     * Defines a unique value for the `AccordionItem`.
      */
     value: string;
     /**
-     * Defines whether the item is disabled, preventing the user from interacting with the item.
+     * Defines whether the `AccordionItem` is disabled, preventing the user from interacting with it.
      */
     disabled?: boolean;
 };
 export declare type AccordionHeaderProps = {
     /**
-     * Defines the title of the header.
+     * Defines the title of the `AccordionHeader`.
      */
     children: ReactNode;
     /**
-     * Defines a class name for the header.
+     * Defines a class name for the `AccordionHeader`.
      */
     className?: string;
     /**
@@ -101,11 +107,11 @@ export declare type AccordionHeaderProps = {
      */
     iconBgClassName?: string;
     /**
-     * Defines a description for the header.
+     * Defines a description for the `AccordionHeader`.
      */
     description?: ReactNode;
     /**
-     * Defines a meta value for the header.
+     * Defines a meta value for the `AccordionHeader`.
      */
     meta?: ReactNode;
     /**
@@ -119,9 +125,12 @@ export declare type AccordionHeaderProps = {
     triggerClassName?: string;
 };
 export declare type AccordionContentProps = {
+    /**
+     * Defines the content of the `AccordionContent`.
+     */
     children: ReactNode;
     /**
-     * Defines a class name for the content.
+     * Defines a class name for the `AccordionContent`.
      */
     className?: string;
 };

package/dist/cjs/Actions/Button/Button.tailwind.js

@@ -2,8 +2,6 @@
 
 // @ts-check
 var plugin = require("tailwindcss/plugin");
-var disabledColor = require("../../styles/disabledColor");
-var rgba = require("../../styles/rgba");
 var buttonPlugin = plugin(function (_ref) {
   var addComponents = _ref.addComponents,
     theme = _ref.theme;
@@ -24,83 +22,58 @@ var buttonPlugin = plugin(function (_ref) {
     ".btn-subtle": {
       color: theme("colors.accent.600"),
       "&:hover": {
-        backgroundColor: rgba(theme("colors.grey.300"), 0.15)
+        backgroundColor: theme("colors.grey.100")
       },
       "&:active, &.btn-active": {
-        color: theme("colors.accent.600"),
-        backgroundColor: theme("colors.accent.100"),
-        boxShadow: "none"
+        backgroundColor: theme("colors.grey.200")
       },
       "&:disabled, &.btn-disabled": {
         background: "none",
-        boxShadow: "none",
         color: theme("colors.grey.300")
       }
     },
     ".btn-neutral": {
       color: theme("colors.grey.900"),
       backgroundColor: theme("colors.white"),
-      backgroundImage: "linear-gradient(-180deg, ".concat(theme("colors.white"), " 0%, ").concat(theme("colors.grey.50"), " 100%)"),
       border: "1px solid ".concat(theme("colors.grey.200")),
-      boxShadow: "0 1px 0 0 ".concat(theme("colors.shadow.5")),
       "&:hover": {
-        backgroundImage: "linear-gradient(-180deg, ".concat(theme("colors.white"), " 0%, ").concat(theme("colors.grey.100"), " 100%)"),
-        borderColor: theme("colors.grey.200")
+        backgroundColor: theme("colors.grey.100")
+      },
+      "&:focus-visible": {
+        borderColor: "transparent"
       },
       "&:active, &.btn-active": {
-        borderColor: theme("colors.grey.200"),
-        boxShadow: "\n          inset 0 1px 4px 0 ".concat(rgba(theme("colors.grey.500"), 0.4), ",\n          inset 0 1px 1px 0 ").concat(rgba(theme("colors.grey.500"), 0.4), ",\n          0 1px 0 0 ").concat(theme("colors.shadow.5"), "\n        ")
+        backgroundColor: theme("colors.grey.200")
       },
       "&:disabled, &.btn-disabled": {
-        backgroundImage: "linear-gradient(-180deg, ".concat(theme("colors.white"), " 0%, ").concat(theme("colors.grey.100"), " 100%)"),
-        borderColor: disabledColor(theme("colors.grey.200")),
-        color: theme("colors.grey.300"),
-        boxShadow: "none"
+        backgroundColor: theme("colors.grey.50"),
+        color: theme("colors.grey.300")
       }
     },
     ".btn-primary": {
       color: theme("colors.white"),
       backgroundColor: theme("colors.accent.600"),
-      backgroundImage: "linear-gradient(-180deg, ".concat(theme("colors.accent.600"), " 0%, ").concat(theme("colors.accent.700"), " 100%)"),
-      border: "1px solid ".concat(theme("colors.accent.700")),
-      boxShadow: "\n        inset 0 1px 0 0 ".concat(rgba(theme("colors.white"), 0.06), ",\n        0 1px 0 0 ").concat(theme("colors.shadow.10"), "\n      "),
       "&:hover": {
-        borderColor: theme("colors.accent.800"),
-        backgroundImage: "linear-gradient(0deg, ".concat(theme("colors.accent.800"), " 0%, ").concat(theme("colors.accent.700"), " 100%)"),
-        boxShadow: "\n          inset 0 1px 0 0 ".concat(rgba(theme("colors.white"), 0.06), ",\n          0 1px 0 0 ").concat(theme("colors.shadow.10"), "\n        ")
+        backgroundColor: theme("colors.accent.700")
       },
       "&:active, &.btn-active": {
-        backgroundColor: theme("colors.accent.700"),
-        borderColor: theme("colors.accent.800"),
-        boxShadow: "\n          inset 0 1px 4px 0 ".concat(rgba(theme("colors.accent.900"), 0.4), ",\n          inset 0 1px 1px 0 ").concat(rgba(theme("colors.accent.900"), 0.6), ",\n          0 1px 0 0 ").concat(theme("colors.shadow.5"), "\n        ")
+        backgroundColor: theme("colors.accent.800")
       },
       "&:disabled, &.btn-disabled": {
-        backgroundColor: disabledColor(theme("colors.accent.600")),
-        backgroundImage: "\n          linear-gradient(0deg, ".concat(disabledColor(theme("colors.accent.600")), " 0%,\n          ").concat(disabledColor(theme("colors.accent.700")), " 100%)\n        "),
-        borderColor: disabledColor(theme("colors.accent.700")),
-        boxShadow: "none"
+        backgroundColor: theme("colors.accent.200")
       }
     },
     ".btn-destructive": {
       color: theme("colors.white"),
       backgroundColor: theme("colors.red.600"),
-      backgroundImage: "linear-gradient(-180deg, ".concat(theme("colors.red.600"), " 0%, ").concat(theme("colors.red.700"), " 100%)"),
-      border: "1px solid ".concat(theme("colors.red.700")),
-      boxShadow: "\n        inset 0 1px 0 0 ".concat(rgba(theme("colors.white"), 0.06), ",\n        0 1px 0 0 ").concat(theme("colors.shadow.10"), "\n      "),
       "&:hover": {
-        backgroundImage: "linear-gradient(0deg, ".concat(theme("colors.red.700"), " 0%, ").concat(theme("colors.red.800"), " 100%)"),
-        borderColor: theme("colors.red.800"),
-        boxShadow: "\n          inset 0 1px 0 0 ".concat(rgba(theme("colors.white"), 0.06), ",\n          0 1px 0 0 ").concat(theme("colors.shadow.10"), "\n        ")
+        backgroundColor: theme("colors.red.700")
       },
       "&:active, &.btn-active": {
-        borderColor: theme("colors.red.800"),
-        boxShadow: "\n          inset 0 1px 4px 0 ".concat(rgba(theme("colors.red.900"), 0.4), ",\n          inset 0 1px 1px 0 ").concat(rgba(theme("colors.red.900"), 0.6), ",\n          0 1px 0 0 ").concat(theme("colors.shadow.5"), "\n        ")
+        backgroundColor: theme("colors.red.800")
       },
       "&:disabled, &.btn-disabled": {
-        backgroundColor: disabledColor(theme("colors.red.600")),
-        backgroundImage: "\n          linear-gradient(0deg, ".concat(disabledColor(theme("colors.red.600")), " 0%,\n          ").concat(disabledColor(theme("colors.red.700")), " 100%)\n        "),
-        borderColor: disabledColor(theme("colors.red.700")),
-        boxShadow: "none"
+        backgroundColor: theme("colors.red.300")
       }
     }
   });
@@ -113,6 +86,18 @@ var buttonPlugin = plugin(function (_ref) {
       "& > .btn:not(:first-child):not(:last-child), & > :not(:first-child):not(:last-child) .btn": {
         borderRadius: "0px"
       },
+      "& > .btn-destructive:not(:first-child), & > :not(:first-child) .btn-destructive": {
+        borderLeft: "1px solid ".concat(theme("colors.red.700"))
+      },
+      "& > .btn-destructive:not(:last-child), & > :not(:last-child) .btn-destructive": {
+        borderRight: "1px solid ".concat(theme("colors.red.700"))
+      },
+      "& > .btn-primary:not(:first-child), & > :not(:first-child) .btn-primary": {
+        borderLeft: "1px solid ".concat(theme("colors.accent.700"))
+      },
+      "& > .btn-primary:not(:last-child), & > :not(:last-child) .btn-primary": {
+        borderRight: "1px solid ".concat(theme("colors.accent.700"))
+      },
       "& > .btn:first-child, & > :first-child .btn": {
         borderTopRightRadius: "0px",
         borderBottomRightRadius: "0px"

package/dist/cjs/Actions/Button/PolymorphicIconButton.d.ts

@@ -3,19 +3,48 @@ import type { IconComponentType } from "../../Icons";
 import type { TooltipWrapperBaseProps } from "../../Overlay/Tooltip/types";
 import type { ButtonSize, ButtonVariant, PolymorphicComponentPropWithRef } from "./types";
 export interface IconButtonBaseProps {
-    /** @default neutral */
+    /**
+     * The variant of the `IconButton`.
+     * @default neutral
+     */
     variant?: ButtonVariant;
-    /** @default medium */
+    /**
+     * The size of the `IconButton`.
+     * @default medium
+     */
     size?: ButtonSize;
-    /** @default false */
+    /**
+     * Whether the `IconButton` is disabled.
+     * @default false
+     */
     disabled?: boolean;
+    /**
+     * The icon to display.
+     */
     icon: IconComponentType;
+    /**
+     * The title used for the tooltip.
+     */
     title: string;
+    /**
+     * Whether to show the tooltip.
+     * @default false
+     */
     showTooltip?: boolean;
-    /** @default top */
+    /**
+     * The side of the tooltip.
+     * @default top
+     */
     tooltipSide?: TooltipWrapperBaseProps["side"];
-    /** @default false */
+    /**
+     * Whether the `IconButton` is loading.
+     * @default false
+     */
     loading?: boolean;
+    /**
+     * The class name of the `IconButton`.
+     */
+    className?: string;
 }
 export declare type PolymorphicIconButtonProps<C extends React.ElementType> = PolymorphicComponentPropWithRef<C, IconButtonBaseProps>;
 declare type PolymorphicIconButtonComponent = (<C extends React.ElementType = "button">(props: PolymorphicIconButtonProps<C>) => React.ReactElement | null) & {

package/dist/cjs/Actions/Button/types.d.ts

@@ -1,23 +1,44 @@
 import type { ReactNode } from "react";
 import type { IconComponentType } from "../../Icons";
 export declare type ButtonVariant = "subtle" | "neutral" | "primary" | "destructive";
-export declare type ButtonSize = "small" | "medium" | "large";
+export declare const buttonSizes: readonly ["small", "medium", "large"];
+export declare type ButtonSize = (typeof buttonSizes)[number];
 export interface ButtonBaseProps {
-    /** @default neutral */
+    /**
+     * The variant of the `Button`.
+     * @default neutral
+     */
     variant?: ButtonVariant;
-    /** @default medium */
+    /**
+     * The size of the `Button`.
+     * @default medium
+     */
     size?: ButtonSize;
-    /** Left aligned icon */
+    /**
+     * The left aligned icon of the `Button`.
+     */
     startIcon?: IconComponentType;
-    /** Right aligned icon */
+    /**
+     * The right aligned icon of the `Button`.
+     */
     endIcon?: IconComponentType;
-    /** @ignore */
+    /**
+     * The content of the `Button`.
+     */
     children: ReactNode;
-    /** @default false */
+    /**
+     * Whether the `Button` is loading.
+     * @default false
+     */
     loading?: boolean;
-    /** @ignore */
+    /**
+     * Whether the `Button` is disabled.
+     * @default false
+     */
     disabled?: boolean;
-    /** @ignore */
+    /**
+     * The class name of the `Button`.
+     */
     className?: string;
 }
 export declare function isButtonType(props: any): props is JSX.IntrinsicElements["button"];

package/dist/cjs/Actions/Button/types.js

@@ -3,7 +3,9 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.buttonSizes = void 0;
 exports.isButtonType = isButtonType;
+var buttonSizes = exports.buttonSizes = ["small", "medium", "large"];
 function isButtonType(props) {
   return props && (!props.as || props.as === "button");
 }

package/dist/cjs/Actions/ButtonGroup/ButtonGroup.d.ts

@@ -5,8 +5,13 @@ export interface ButtonGroupProps {
      * @default div
      */
     as?: keyof JSX.IntrinsicElements;
-    /** @ignore */
+    /**
+     * The class name of the `ButtonGroup`.
+     */
     className?: string;
+    /**
+     * The content of the `ButtonGroup`.
+     */
     children: ReactNode;
 }
 /**

package/dist/cjs/Actions/Switch/Switch.d.ts

@@ -1,13 +1,33 @@
 import type { ReactNode, VFC } from "react";
 import type { SwitchSize } from "./types";
 export interface SwitchProps {
-    /** @ignore */
+    /**
+     * The class name of the `Switch`.
+     */
     className?: string;
+    /**
+     * The currently selected value.
+     */
     value: string;
+    /**
+     * Whether the `Switch` is disabled.
+     */
     disabled?: boolean;
+    /**
+     * Callback function called when the selected value changes.
+     */
     onChange: (value: string) => void;
+    /**
+     * The content of the `Switch`.
+     */
     children: ReactNode;
+    /**
+     * The size of the `Switch`.
+     */
     size?: SwitchSize;
+    /**
+     * Optional name attribute for the radio inputs.
+     */
     name?: string;
 }
 /**

package/dist/cjs/Actions/Switch/SwitchOption.d.ts

@@ -1,7 +1,16 @@
 import type { ReactNode, VFC } from "react";
 export interface SwitchOptionProps {
+    /**
+     * The value associated with this `SwitchOption`.
+     */
     value: string;
+    /**
+     * Whether this `SwitchOption` is disabled.
+     */
     disabled?: boolean;
+    /**
+     * The content to display for this `SwitchOption`.
+     */
     children: ReactNode;
 }
 export declare const SwitchOption: VFC<SwitchOptionProps>;

package/dist/cjs/Actions/Switch/types.d.ts

@@ -1,4 +1,5 @@
-export declare type SwitchSize = "small" | "medium" | "large";
+export declare const switchSizes: readonly ["small", "medium", "large"];
+export declare type SwitchSize = (typeof switchSizes)[number];
 export interface SwitchContextValue {
     name: string;
     value: string;

package/dist/cjs/Actions/Switch/types.js

@@ -2,4 +2,6 @@
 
 Object.defineProperty(exports, "__esModule", {
   value: true
-});
+});
+exports.switchSizes = void 0;
+var switchSizes = exports.switchSizes = ["small", "medium", "large"];

package/dist/cjs/Actions/ToggleButton/ToggleButton.d.ts

@@ -2,8 +2,17 @@
 import type { ToggleProps } from "@radix-ui/react-toggle";
 import type { ToggleButtonBaseProps } from "./ToggleButtonBase";
 export declare type ToggleButtonProps = {
+    /**
+     * The pressed state of the `ToggleButton`.
+     */
     pressed?: ToggleProps["pressed"];
+    /**
+     * The default pressed state of the `ToggleButton`.
+     */
     defaultPressed?: ToggleProps["defaultPressed"];
+    /**
+     * The callback function that is called when the pressed state changes.
+     */
     onPressedChange?: ToggleProps["onPressedChange"];
 } & ToggleButtonBaseProps;
 /**

package/dist/cjs/Actions/ToggleButton/ToggleButtonBase.d.ts

@@ -1,15 +1,46 @@
-import type { ButtonHTMLAttributes, ReactNode } from "react";
+import type { ReactNode } from "react";
 import type { IconComponentType } from "../../Icons";
 import type { ButtonSize } from "../Button/types";
 declare type IconOnlyToggleButtonBaseProps = {
+    /**
+     * The icon to display for the `ToggleButton`.
+     */
     icon: IconComponentType;
+    /**
+     * The label to display for the `ToggleButton`.
+     */
     label: string;
 };
 declare type TextToggleButtonBaseProps = {
+    /**
+     * The icon to display for the `ToggleButton`.
+     */
     icon?: IconComponentType;
+    /**
+     * The content to display for the `ToggleButton`.
+     */
     children: ReactNode;
 };
-export declare type ToggleButtonBaseProps = Pick<ButtonHTMLAttributes<HTMLButtonElement>, "id" | "className" | "style" | "autoFocus" | "disabled"> & {
+export declare type ToggleButtonBaseProps = {
+    /**
+     * The id of the `ToggleButton`.
+     */
+    id?: string;
+    /**
+     * The class name of the `ToggleButton`.
+     */
+    className?: string;
+    /**
+     * Whether the `ToggleButton` should be auto focused.
+     */
+    autoFocus?: boolean;
+    /**
+     * Whether the `ToggleButton` should be disabled.
+     */
+    disabled?: boolean;
+    /**
+     * The size of the `ToggleButton`.
+     */
     size?: ButtonSize;
 } & (IconOnlyToggleButtonBaseProps | TextToggleButtonBaseProps);
 export declare const ToggleButtonBase: import("react").ForwardRefExoticComponent<ToggleButtonBaseProps & import("react").RefAttributes<HTMLButtonElement>>;

package/dist/cjs/Actions/ToggleButton/ToggleButtonBase.js

@@ -43,7 +43,7 @@ var ToggleButtonBase = exports.ToggleButtonBase = /*#__PURE__*/(0, _react.forwar
         ref: ref,
         type: "button",
         "aria-label": label,
-        className: (0, _clsx["default"])((0, _satellitePrefixer["default"])(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2["default"])(["inline-flex items-center justify-center gap-1 min-w-min whitespace-nowrap typo-display-body"]))), (0, _satellitePrefixer["default"])(_templateObject6 || (_templateObject6 = (0, _taggedTemplateLiteral2["default"])(["group/toggle-button rounded focusable-visible disabled:cursor-not-allowed"]))), (0, _satellitePrefixer["default"])(_templateObject7 || (_templateObject7 = (0, _taggedTemplateLiteral2["default"])(["data-[state=on]:text-accent-600 disabled:!text-grey-300"]))), (0, _satellitePrefixer["default"])(_templateObject8 || (_templateObject8 = (0, _taggedTemplateLiteral2["default"])(["bg-white data-[state=off]:hover:bg-grey-100 data-[state=on]:bg-accent-100 disabled:!bg-grey-50"]))), (0, _satellitePrefixer["default"])(_templateObject9 || (_templateObject9 = (0, _taggedTemplateLiteral2["default"])(["border border-grey-200 data-[state=on]:border-accent-600 disabled:!border-grey-200"]))), !isIconOnly && (0, _satellitePrefixer["default"])(_templateObject10 || (_templateObject10 = (0, _taggedTemplateLiteral2["default"])(["px-3"]))), isIconOnly ? ICON_ONLY_CLASSNAMES[size] : _styles.BUTTON_SIZE_CLASSNAMES[size], className)
+        className: (0, _clsx["default"])((0, _satellitePrefixer["default"])(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2["default"])(["inline-flex items-center justify-center gap-1 min-w-min whitespace-nowrap typo-display-body"]))), (0, _satellitePrefixer["default"])(_templateObject6 || (_templateObject6 = (0, _taggedTemplateLiteral2["default"])(["group/toggle-button rounded focusable-visible focus-visible:border-transparent disabled:cursor-not-allowed"]))), (0, _satellitePrefixer["default"])(_templateObject7 || (_templateObject7 = (0, _taggedTemplateLiteral2["default"])(["data-[state=on]:text-accent-600 disabled:!text-grey-300"]))), (0, _satellitePrefixer["default"])(_templateObject8 || (_templateObject8 = (0, _taggedTemplateLiteral2["default"])(["bg-white data-[state=off]:hover:bg-grey-100 data-[state=on]:bg-accent-100 disabled:!bg-grey-50"]))), (0, _satellitePrefixer["default"])(_templateObject9 || (_templateObject9 = (0, _taggedTemplateLiteral2["default"])(["border border-grey-200 data-[state=on]:border-accent-600 disabled:!border-grey-200"]))), !isIconOnly && (0, _satellitePrefixer["default"])(_templateObject10 || (_templateObject10 = (0, _taggedTemplateLiteral2["default"])(["px-3"]))), isIconOnly ? ICON_ONLY_CLASSNAMES[size] : _styles.BUTTON_SIZE_CLASSNAMES[size], className)
       }, rest), {}, {
         children: [!!Icon && /*#__PURE__*/(0, _jsxRuntime.jsx)(Icon, {
           "aria-hidden": "true",

package/dist/cjs/Actions/ToggleGroup/ToggleGroup.d.ts

@@ -2,7 +2,9 @@ import type { ToggleGroupItemProps as RadixToggleGroupItemProps, ToggleGroupMult
 import type { FC } from "react";
 import type { ToggleButtonBaseProps } from "../ToggleButton/ToggleButtonBase";
 declare type ToggleGroupSharedProps = {
-    /** @ignore */
+    /**
+     * The class name of the `ToggleGroup`.
+     */
     className?: string;
     /**
      * Defines whether the `ToggleGroup` is disabled,
@@ -11,7 +13,9 @@ declare type ToggleGroupSharedProps = {
     disabled?: RadixToggleGroupSharedProps["disabled"];
 };
 declare type ToggleGroupSingleProps = {
-    /** Defines whether a single or multiple items can be pressed at a time. */
+    /**
+     * Defines whether a single or multiple items can be pressed at a time.
+     */
     type: "single";
     /**
      * Defines the controlled value of the pressed item.
@@ -23,11 +27,15 @@ declare type ToggleGroupSingleProps = {
      * Use when you do not need to control the state of the items.
      */
     defaultValue?: RadixToggleGroupSingleProps["defaultValue"];
-    /** Defines the event handler called when the pressed state of an item changes. */
+    /**
+     * Defines the event handler called when the pressed state of an item changes.
+     */
     onChange?: RadixToggleGroupSingleProps["onValueChange"];
 };
 declare type ToggleGroupMultipleProps = {
-    /** Defines whether a single or multiple items can be pressed at a time. */
+    /**
+     * Defines whether a single or multiple items can be pressed at a time.
+     */
     type: "multiple";
     /**
      * Defines the controlled value of the pressed items.
@@ -39,7 +47,9 @@ declare type ToggleGroupMultipleProps = {
      * Use when you do not need to control the state of the items.
      */
     defaultValue?: RadixToggleGroupMultipleProps["defaultValue"];
-    /** Defines the event handler called when the pressed state of an item changes. */
+    /**
+     * Defines the event handler called when the pressed state of an item changes.
+     */
     onChange?: RadixToggleGroupMultipleProps["onValueChange"];
 };
 export declare type ToggleGroupProps = ToggleGroupSharedProps & (ToggleGroupSingleProps | ToggleGroupMultipleProps);
@@ -52,7 +62,9 @@ declare type ToggleGroupComponent = FC<ToggleGroupProps> & {
  * See the [ToggleGroupItem documentation page](https://satellite.algolia.com/components/actions/toggle-group) for more information.
  */
 export declare type ToggleGroupItemProps = ToggleButtonBaseProps & {
-    /** Defines a unique value for the item. */
+    /**
+     * Defines a unique value for the item.
+     */
     value: RadixToggleGroupItemProps["value"];
 };
 /**

package/dist/cjs/Avatars/ApplicationAvatar/ApplicationAvatar.d.ts

@@ -1,11 +1,18 @@
 import type { VFC } from "react";
 import type { ApplicationAvatarSize, MinimalApplication } from "../types";
 export interface ApplicationAvatarProps {
-    /** A minimal application object containing `applicationID` and `name`. */
+    /**
+     * A minimal application object containing `applicationID` and `name`.
+     */
     application: MinimalApplication;
-    /** @default "medium" */
+    /**
+     * The size of the `ApplicationAvatar`.
+     * @default "medium"
+     */
     size?: ApplicationAvatarSize;
-    /** @ignore */
+    /**
+     * The class name of the `ApplicationAvatar`.
+     */
     className?: string;
 }
 /**

package/dist/cjs/Avatars/UserAvatar/UserAvatar.d.ts

@@ -4,16 +4,24 @@ export declare type UserAvatarLocale = {
     fallbackText?: string;
 };
 export interface UserAvatarProps {
-    /** A minimal user object containing `name`, `email` and `avatar`. */
+    /**
+     * A minimal user object containing `name`, `email` and `avatar`.
+     */
     user: MinimalUser;
     /**
-     * in px
+     * The size of the `UserAvatar`.
      * @default 32
-     * */
+     */
     size?: number;
-    /** @ignore */
-    className?: string;
+    /**
+     * The locale of the `UserAvatar`.
+     * @default { fallbackText: `User's avatar` }"
+     */
     locale?: UserAvatarLocale;
+    /**
+     * The class name of the `UserAvatar`.
+     */
+    className?: string;
 }
 /**
  * The `UserAvatar` component is used as a visual representation of a user.