@algolia/satellite 1.0.0-beta.171 → 1.0.0-beta.173

package/esm/Avatars/UserAvatar.js

@@ -13,7 +13,11 @@ import { jsxs as _jsxs } from "react/jsx-runtime";
 var DEFAULT_LOCALE = {
   fallbackText: "User's avatar"
 };
-/** The `UserAvatar` is used as a visual representation of a user. */
+/**
+ * The `UserAvatar` component is used as a visual representation of a user.
+ *
+ * See the [User Avatar documentation page](https://satellite.algolia.com/components/images/user-avatar) for more information.
+ */
 export var UserAvatar = function UserAvatar(_ref) {
   var _user$email;
   var className = _ref.className,

package/esm/Badge/Badge.d.ts

@@ -15,19 +15,9 @@ declare type BadgeContentProps = {
 };
 export declare type BadgeProps = BaseBadgeProps & AtLeastOne<BadgeContentProps>;
 /**
- * Badges are used to inform a user about a status of an item or a process. They can also contain a numeric value. Badges come with a set of colours that are easily identified. Green colour implies success or completion, while orange suggests a warning, on hold, or a problem. Red coloured badges mean error or failure.
+ * The `Badge` component is a visual marker highlighting information or status. It enhances UI, indicates progress, and classifies data.
  *
- * - Stay consistent with badge content (text), don't vary your vocabulary
- * - Bages usually come after a textual information or explanation
- * - Don't use badges where traditional error messages (such as form validation) can be used instead
- * - Don't use badges with combination of buttons
- * - Badges are not interactive
- *
- * Do use
- *
- * - To indicate progress of an A/B test
- * - To indicate problem with an index
- * - To display numeric values for multiple items (similar to a "tag cloud")
+ * See the [Badge documentation page](https://satellite.algolia.com/components/feedback/badge) for more information.
  */
 export declare const Badge: import("react").ForwardRefExoticComponent<BadgeProps & import("react").RefAttributes<HTMLSpanElement>>;
 export default Badge;

package/esm/Badge/Badge.js

@@ -28,19 +28,9 @@ var SIZE_CLASSNAMES = {
 };
 
 /**
- * Badges are used to inform a user about a status of an item or a process. They can also contain a numeric value. Badges come with a set of colours that are easily identified. Green colour implies success or completion, while orange suggests a warning, on hold, or a problem. Red coloured badges mean error or failure.
+ * The `Badge` component is a visual marker highlighting information or status. It enhances UI, indicates progress, and classifies data.
  *
- * - Stay consistent with badge content (text), don't vary your vocabulary
- * - Bages usually come after a textual information or explanation
- * - Don't use badges where traditional error messages (such as form validation) can be used instead
- * - Don't use badges with combination of buttons
- * - Badges are not interactive
- *
- * Do use
- *
- * - To indicate progress of an A/B test
- * - To indicate problem with an index
- * - To display numeric values for multiple items (similar to a "tag cloud")
+ * See the [Badge documentation page](https://satellite.algolia.com/components/feedback/badge) for more information.
  */
 export var Badge = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var children = _ref.children,

package/esm/Banners/Alert/Alert.d.ts

@@ -25,54 +25,9 @@ export interface AlertProps {
     children: ReactNode;
 }
 /**
-* Alerts inform users about important changes or temporally conditions. Use this component if you need to communicate something to users in a prominent way.
-
-* ## Examples
-* [See the component in Figma](https://www.figma.com/file/99l59il97k2n5y4n6Jucal/%5BSatellite%5D-Components?node-id=2912%3A262266)
-
-* ## Current Status
-* - [x] Figma
-* - [x] React
-* - [ ] Documentation
-
-* ## Component structure
-* This component uses a common banner structure. It uses an icon that should match the intent of the message, an optional title _(Highly recommended)_, a short paragraph of text and optional buttons for follow up actions. The `Alert` is dismissible by default, to do so a cross icon is displayed on the top-right corner.
-
-* ## Guidelines
-* ### How to use it?
-* Use the `Alert` if you want to inform the user about a specific action they need to do after something happened.
-
-* ### How to NOT use it?
-* Do not use the component to give higher visibility to trivial information, use the [Insert](https://algolia-satellite.netlify.app/?path=/docs/indicators-banners-insert--basic) component instead.
-* Make sure that alerts are not stacking, We highly recommend to have only one per page if possible, though we understand that sometimes this is not possible.
-* Do not use a product wide `Alert` to display features information.
-
-* ### Variants
-* This component comes with two sets of Variants:
-
-* #### Color
-* - `Grey` `Default`
-*   Use this as your default Alert if no other color matches your use-case.
-* - `Accent` `Primary`
-*   Use this to represent something that is currently happening with no level of severity.
-* - `Green` `Success`
-*   Use this to inform the user that an action has been completed in the background while the user wasn't on that page and/or needs further exploration from the user. For smaller and quick processes use the [Flag](https://algolia-satellite.netlify.app/?path=/docs/indicators-flag--basic) instead.
-* - `Orange` `Warning`
-*   Use this to show the user that something important requires their attention. The warning should be used for low to medium errors.
-* - `Red` `Failure`
-*   Use this to show the user that something requires their full attention and actions. Only use red for critical warnings that will result in a loss of data of production down time.
-
-* #### Usage Context
-* - `Page`
-*   This is for global and product wide alerts, use that with extreme caution as it's will impact every page and every feature.
-* - `Section`
-*   This alert should be inside the frame of a section and linked to the content it impacts
-
-* ### Do's and Don't
-* TODO
-
-* ## Accessibility
-* TODO
+ * The `Alert` component give users suggestions, tips, warnings, and error information without stopping them from completing the tasks they're doing.
+ *
+ * See the [Alert documentation page](https://satellite.algolia.com/components/feedback/alert) for more information.
  */
 export declare const Alert: VFC<AlertProps>;
 export default Alert;

package/esm/Banners/Alert/Alert.js

@@ -37,54 +37,9 @@ var ICON_CLASSNAME_VARIANTS = {
 };
 
 /**
-* Alerts inform users about important changes or temporally conditions. Use this component if you need to communicate something to users in a prominent way.
-
-* ## Examples
-* [See the component in Figma](https://www.figma.com/file/99l59il97k2n5y4n6Jucal/%5BSatellite%5D-Components?node-id=2912%3A262266)
-
-* ## Current Status
-* - [x] Figma
-* - [x] React
-* - [ ] Documentation
-
-* ## Component structure
-* This component uses a common banner structure. It uses an icon that should match the intent of the message, an optional title _(Highly recommended)_, a short paragraph of text and optional buttons for follow up actions. The `Alert` is dismissible by default, to do so a cross icon is displayed on the top-right corner.
-
-* ## Guidelines
-* ### How to use it?
-* Use the `Alert` if you want to inform the user about a specific action they need to do after something happened.
-
-* ### How to NOT use it?
-* Do not use the component to give higher visibility to trivial information, use the [Insert](https://algolia-satellite.netlify.app/?path=/docs/indicators-banners-insert--basic) component instead.
-* Make sure that alerts are not stacking, We highly recommend to have only one per page if possible, though we understand that sometimes this is not possible.
-* Do not use a product wide `Alert` to display features information.
-
-* ### Variants
-* This component comes with two sets of Variants:
-
-* #### Color
-* - `Grey` `Default`
-*   Use this as your default Alert if no other color matches your use-case.
-* - `Accent` `Primary`
-*   Use this to represent something that is currently happening with no level of severity.
-* - `Green` `Success`
-*   Use this to inform the user that an action has been completed in the background while the user wasn't on that page and/or needs further exploration from the user. For smaller and quick processes use the [Flag](https://algolia-satellite.netlify.app/?path=/docs/indicators-flag--basic) instead.
-* - `Orange` `Warning`
-*   Use this to show the user that something important requires their attention. The warning should be used for low to medium errors.
-* - `Red` `Failure`
-*   Use this to show the user that something requires their full attention and actions. Only use red for critical warnings that will result in a loss of data of production down time.
-
-* #### Usage Context
-* - `Page`
-*   This is for global and product wide alerts, use that with extreme caution as it's will impact every page and every feature.
-* - `Section`
-*   This alert should be inside the frame of a section and linked to the content it impacts
-
-* ### Do's and Don't
-* TODO
-
-* ## Accessibility
-* TODO
+ * The `Alert` component give users suggestions, tips, warnings, and error information without stopping them from completing the tasks they're doing.
+ *
+ * See the [Alert documentation page](https://satellite.algolia.com/components/feedback/alert) for more information.
  */
 export var Alert = function Alert(_ref) {
   var title = _ref.title,

package/esm/Banners/BigBertha/BigBertha.d.ts

@@ -5,37 +5,9 @@ export interface BigBerthaProps {
     children: ReactNode;
 }
 /**
-* Major product wide announcement from Algolia to the users.
-
-* ## Examples
-* [See the component in Figma](https://www.figma.com/file/99l59il97k2n5y4n6Jucal/%5BSatellite%5D-Components?node-id=2912%3A279476)
-
-* ## Current Status
-* - [x] Figma
-* - [x] React
-* - [ ] Documentation
-
-* ## Component structure
-* This is a simple high contrast banner. It use an icon that should match the content of the message, a short text that describe the situation and can contain "Learn more" links.
-
-* ## Guidelines
-
-* ### How to use it?
-* This component should only be used to inform the user about an on-going situation at Algolia that will impact the users' or end-users' experience with our products. The content of the message should be concise and explicit. Make sure that the tone used in the text does not generate stress.
-
-* ### How to NOT use it?
-* - Do not use this banner for any non critical announcement or any non product wide announcement.
-* - If you want to inform the user about something in your features, please use the [Alert](https://algolia-satellite.netlify.app/?path=/docs/indicators-banners-alert--variants) component.
-* - If you want to promote a specific feature, please use the [Promote Banner](https://algolia-satellite.netlify.app/?path=/docs/indicators-banners-promote--basic) component.
-
-* ### Variants
-* - Blue banner : Default state of this component
-
-* ### Do's and Don't
-* TODO
-
-* ## Accessibility
-* TODO
+ * The `BigBertha` component is a top-of-page alert for critical system messages, updates, and urgent warnings.
+ *
+ * See the [Big Bertha documentation page](https://satellite.algolia.com/components/feedback/big-bertha) for more information.
  */
 export declare const BigBertha: VFC<BigBerthaProps>;
 export default BigBertha;

package/esm/Banners/BigBertha/BigBertha.js

@@ -5,37 +5,9 @@ import stl from "../../styles/helpers/satellitePrefixer";
 import { jsx as _jsx } from "react/jsx-runtime";
 import { jsxs as _jsxs } from "react/jsx-runtime";
 /**
-* Major product wide announcement from Algolia to the users.
-
-* ## Examples
-* [See the component in Figma](https://www.figma.com/file/99l59il97k2n5y4n6Jucal/%5BSatellite%5D-Components?node-id=2912%3A279476)
-
-* ## Current Status
-* - [x] Figma
-* - [x] React
-* - [ ] Documentation
-
-* ## Component structure
-* This is a simple high contrast banner. It use an icon that should match the content of the message, a short text that describe the situation and can contain "Learn more" links.
-
-* ## Guidelines
-
-* ### How to use it?
-* This component should only be used to inform the user about an on-going situation at Algolia that will impact the users' or end-users' experience with our products. The content of the message should be concise and explicit. Make sure that the tone used in the text does not generate stress.
-
-* ### How to NOT use it?
-* - Do not use this banner for any non critical announcement or any non product wide announcement.
-* - If you want to inform the user about something in your features, please use the [Alert](https://algolia-satellite.netlify.app/?path=/docs/indicators-banners-alert--variants) component.
-* - If you want to promote a specific feature, please use the [Promote Banner](https://algolia-satellite.netlify.app/?path=/docs/indicators-banners-promote--basic) component.
-
-* ### Variants
-* - Blue banner : Default state of this component
-
-* ### Do's and Don't
-* TODO
-
-* ## Accessibility
-* TODO
+ * The `BigBertha` component is a top-of-page alert for critical system messages, updates, and urgent warnings.
+ *
+ * See the [Big Bertha documentation page](https://satellite.algolia.com/components/feedback/big-bertha) for more information.
  */
 export var BigBertha = function BigBertha(_ref) {
   var icon = _ref.icon,

package/esm/Banners/Promote/Promote.d.ts

@@ -20,32 +20,9 @@ export declare type PromoteProps = {
     children: ReactNode;
 } & (CompactPromoteProps | WidePromoteProps);
 /**
-* A contextual way of showing our user that a new feature / product is available to them on a higher plan or as an option.
-
-* ## Examples
-* [See the component in Figma](https://www.figma.com/file/99l59il97k2n5y4n6Jucal/%5BSatellite%5D-Components?node-id=2912%3A279945)
-
-* ## Current Status
-* - [x] Figma
-* - [x] React
-* - [ ] Documentation
-
-* ## Component structure
-* This component is a bigger banner. It include an optional image, an optional product context, a title, a short text (2 lines maximum without an image and 3 lines maximum with an image), optional CTAs (one primary and one secondary). It comes in two different variants: `large` and `compact`.
-
-* ## Guidelines
-* ### How to use it?
-* You should use this component to display to the users that a new features/product is now available for them in the current context they are in. This feature can be automatically available or locked behind higher plan tier, please make sure you adapt the content to not give false impression of availability to the user.
-
-* This component is permanently dismissible by default.
-
-* ### How to NOT use it?
-* - Do not use this banner as a regular [Alert](https://algolia-satellite.netlify.app/?path=/docs/indicators-banners-alert--variants).
-* - You can only use one `large` promotion banner per context and two/four compact per context.
-
-* ### Variants
-* - `large`
-* - `compact`
+ * The `Promote` component is a contextual way of showing a user that a new feature or product is available to them on a higher plan or as an option.
+ *
+ * See the [Promote documentation page](https://satellite.algolia.com/components/feedback/promote-banner) for more information.
  */
 export declare const Promote: VFC<PromoteProps>;
 export default Promote;

package/esm/Banners/Promote/Promote.js

@@ -21,32 +21,9 @@ var ACTIONS_VARIANT_CLASSNAMES = {
 };
 
 /**
-* A contextual way of showing our user that a new feature / product is available to them on a higher plan or as an option.
-
-* ## Examples
-* [See the component in Figma](https://www.figma.com/file/99l59il97k2n5y4n6Jucal/%5BSatellite%5D-Components?node-id=2912%3A279945)
-
-* ## Current Status
-* - [x] Figma
-* - [x] React
-* - [ ] Documentation
-
-* ## Component structure
-* This component is a bigger banner. It include an optional image, an optional product context, a title, a short text (2 lines maximum without an image and 3 lines maximum with an image), optional CTAs (one primary and one secondary). It comes in two different variants: `large` and `compact`.
-
-* ## Guidelines
-* ### How to use it?
-* You should use this component to display to the users that a new features/product is now available for them in the current context they are in. This feature can be automatically available or locked behind higher plan tier, please make sure you adapt the content to not give false impression of availability to the user.
-
-* This component is permanently dismissible by default.
-
-* ### How to NOT use it?
-* - Do not use this banner as a regular [Alert](https://algolia-satellite.netlify.app/?path=/docs/indicators-banners-alert--variants).
-* - You can only use one `large` promotion banner per context and two/four compact per context.
-
-* ### Variants
-* - `large`
-* - `compact`
+ * The `Promote` component is a contextual way of showing a user that a new feature or product is available to them on a higher plan or as an option.
+ *
+ * See the [Promote documentation page](https://satellite.algolia.com/components/feedback/promote-banner) for more information.
  */
 export var Promote = function Promote(_ref) {
   var context = _ref.context,

package/esm/Button/Button.d.ts

@@ -2,18 +2,9 @@
 import { type PolymorphicButtonProps } from "./PolymorphicButton";
 export declare type ButtonProps = Omit<PolymorphicButtonProps<"button">, "as" | "ref">;
 /**
- * Buttons are used to trigger user actions (like "Add", "Close" or "Save") or navigate users elsewhere through the links. Buttons can contain a combination of a clear label and an icon while links are always text.
+ * The `Button` component is used to trigger user actions (like "Add", "Close" or "Save") or navigate users elsewhere through the links. It can contain a combination of a clear label and an icon while links are always text.
  *
- * ## Variations
- * - **Primary**: to highlight the strongest action on a page. Should only appear once per screen. Not every screen requires a primary button
- * - **Neutral (default)**: the standard button for most use cases
- * - **Destructive**: appears as a final confirmation for a destructive action (e.g. deleting an index). Should be used with care, primarily in confirmation modals
- * - **Subtle-neutral**: user with a primary button or for actionals that are less crucial (e.g. Cancel)
- *
- * ## Styles
- * - Use icons before the label in any button type to draw more attention to it, or help convey more meaning
- * - Use icon-only button for an action that is less critical and doesn't have to drag too much of user attention
- * - Buttons can take the full width to fill the parent container
+ * See the [Button documentation page](https://satellite.algolia.com/components/actions/button) for more information.
  */
 export declare const Button: import("react").ForwardRefExoticComponent<ButtonProps & import("react").RefAttributes<HTMLButtonElement>>;
 export default Button;

package/esm/Button/Button.js

@@ -5,18 +5,9 @@ import { forwardRef } from "react";
 import { PolymorphicButton } from "./PolymorphicButton";
 import { jsx as _jsx } from "react/jsx-runtime";
 /**
- * Buttons are used to trigger user actions (like "Add", "Close" or "Save") or navigate users elsewhere through the links. Buttons can contain a combination of a clear label and an icon while links are always text.
+ * The `Button` component is used to trigger user actions (like "Add", "Close" or "Save") or navigate users elsewhere through the links. It can contain a combination of a clear label and an icon while links are always text.
  *
- * ## Variations
- * - **Primary**: to highlight the strongest action on a page. Should only appear once per screen. Not every screen requires a primary button
- * - **Neutral (default)**: the standard button for most use cases
- * - **Destructive**: appears as a final confirmation for a destructive action (e.g. deleting an index). Should be used with care, primarily in confirmation modals
- * - **Subtle-neutral**: user with a primary button or for actionals that are less crucial (e.g. Cancel)
- *
- * ## Styles
- * - Use icons before the label in any button type to draw more attention to it, or help convey more meaning
- * - Use icon-only button for an action that is less critical and doesn't have to drag too much of user attention
- * - Buttons can take the full width to fill the parent container
+ * See the [Button documentation page](https://satellite.algolia.com/components/actions/button) for more information.
  */
 export var Button = /*#__PURE__*/forwardRef(function (props, ref) {
   return /*#__PURE__*/_jsx(PolymorphicButton, _objectSpread(_objectSpread({}, props), {}, {

package/esm/Button/ButtonGroup.d.ts

@@ -10,9 +10,9 @@ export interface ButtonGroupProps {
     children: ReactNode;
 }
 /**
- * - Use grouped buttons when there is a close relationship between a number of buttons.
- * - Group buttons logically into sets based on usage and importance.
- * - Common placement of grouped buttons is the view switch (e.g. list vs grid view)
+ * The `ButtonGroup` component is used to group buttons together.
+ *
+ * See the [Button Group documentation page](https://satellite.algolia.com/components/actions/button-group) for more information.
  */
 export declare const ButtonGroup: VFC<ButtonGroupProps>;
 export default ButtonGroup;

package/esm/Button/ButtonGroup.js

@@ -4,9 +4,9 @@ import cx from "clsx";
 import stl from "../styles/helpers/satellitePrefixer";
 import { jsx as _jsx } from "react/jsx-runtime";
 /**
- * - Use grouped buttons when there is a close relationship between a number of buttons.
- * - Group buttons logically into sets based on usage and importance.
- * - Common placement of grouped buttons is the view switch (e.g. list vs grid view)
+ * The `ButtonGroup` component is used to group buttons together.
+ *
+ * See the [Button Group documentation page](https://satellite.algolia.com/components/actions/button-group) for more information.
  */
 export var ButtonGroup = function ButtonGroup(_ref) {
   var className = _ref.className,

package/esm/Button/IconButton.d.ts

@@ -2,9 +2,9 @@
 import { type PolymorphicIconButtonProps } from "./PolymorphicIconButton";
 export declare type IconButtonProps = Omit<PolymorphicIconButtonProps<"button">, "as" | "ref">;
 /**
- * IconButtons are useful in situations where you are limited on space or the action is self-explanatory with just an icon.
+ * The `IconButton` component is used to trigger user actions (like "Add", "Close" or "Save"). It can only contain an icon.
  *
- * Please refer to the `Button` guidelines.
+ * See the [Icon Button documentation page](https://satellite.algolia.com/components/actions/icon-button) for more information.
  */
 export declare const IconButton: import("react").ForwardRefExoticComponent<IconButtonProps & import("react").RefAttributes<HTMLButtonElement>>;
 export default IconButton;

package/esm/Button/IconButton.js

@@ -5,9 +5,9 @@ import { forwardRef } from "react";
 import { PolymorphicIconButton } from "./PolymorphicIconButton";
 import { jsx as _jsx } from "react/jsx-runtime";
 /**
- * IconButtons are useful in situations where you are limited on space or the action is self-explanatory with just an icon.
+ * The `IconButton` component is used to trigger user actions (like "Add", "Close" or "Save"). It can only contain an icon.
  *
- * Please refer to the `Button` guidelines.
+ * See the [Icon Button documentation page](https://satellite.algolia.com/components/actions/icon-button) for more information.
  */
 export var IconButton = /*#__PURE__*/forwardRef(function (props, ref) {
   return /*#__PURE__*/_jsx(PolymorphicIconButton, _objectSpread(_objectSpread({}, props), {}, {

package/esm/Card/Card.d.ts

@@ -27,6 +27,10 @@ export interface CardType extends ForwardRefExoticComponent<PropsWithoutRef<Card
     Header: typeof CardHeader;
     Title: typeof CardTitle;
 }
-/** The `Card` is a useful component for containing content within a page. */
+/**
+ * The `Card` component is a useful for containing content within a page.
+ *
+ * See the [Card documentation page](https://satellite.algolia.com/layouts/card) for more information.
+ */
 export declare const Card: CardType;
 export default Card;

package/esm/Card/Card.js

@@ -17,7 +17,11 @@ var ELEVATION_CLASSNAMES = {
   "400": stl(_templateObject4 || (_templateObject4 = _taggedTemplateLiteral(["card-z400"]))),
   "500": stl(_templateObject5 || (_templateObject5 = _taggedTemplateLiteral(["card-z500"])))
 };
-/** The `Card` is a useful component for containing content within a page. */
+/**
+ * The `Card` component is a useful for containing content within a page.
+ *
+ * See the [Card documentation page](https://satellite.algolia.com/layouts/card) for more information.
+ */
 export var Card = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var className = _ref.className,
     _ref$as = _ref.as,

package/esm/Checkbox/Checkbox.d.ts

@@ -15,10 +15,9 @@ declare type CheckboxCustomProps = {
 declare type CheckboxInputProps = Omit<HTMLAttributes<HTMLInputElement>, "onChange"> & Pick<InputHTMLAttributes<HTMLInputElement>, "onChange" | "required" | "autoFocus" | "disabled" | "checked" | "defaultChecked">;
 export declare type CheckboxProps = CheckboxInputProps & CheckboxCustomProps;
 /**
- * When users need to make a range of selections (none, one, or several), checkboxes are a good input control.
+ * The `Checkbox` component is a control that allows single or multiple selections from a set of options.
  *
- * - A checkbox control has two primary states: selected and unselected. If required, there's an additional visual state for indeterminate (usually for a parent checkbox, when some children checkboxes are selected, but not all of them)
- * - Checkboxes require the use of a button to apply the settings once they are selected
+ * See the [Checkbox documentation page](https://satellite.algolia.com/components/controls/checkbox) for more information.
  */
 export declare const Checkbox: import("react").ForwardRefExoticComponent<Omit<HTMLAttributes<HTMLInputElement>, "onChange"> & Pick<InputHTMLAttributes<HTMLInputElement>, "defaultChecked" | "onChange" | "autoFocus" | "disabled" | "checked" | "required"> & CheckboxCustomProps & import("react").RefAttributes<HTMLInputElement>>;
 export default Checkbox;

package/esm/Checkbox/Checkbox.js

@@ -24,10 +24,9 @@ var STATUS_CLASSNAMES = {
 };
 
 /**
- * When users need to make a range of selections (none, one, or several), checkboxes are a good input control.
+ * The `Checkbox` component is a control that allows single or multiple selections from a set of options.
  *
- * - A checkbox control has two primary states: selected and unselected. If required, there's an additional visual state for indeterminate (usually for a parent checkbox, when some children checkboxes are selected, but not all of them)
- * - Checkboxes require the use of a button to apply the settings once they are selected
+ * See the [Checkbox documentation page](https://satellite.algolia.com/components/controls/checkbox) for more information.
  */
 export var Checkbox = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var children = _ref.children,

package/esm/DatePicker/DatePicker/DatePicker.d.ts

@@ -30,5 +30,10 @@ export declare type DatePickerProps = {
     initialValue?: Date | null;
     buttonSize?: DisplayProps["size"];
 } & SharedDatePickerProps;
+/**
+ * The `DatePicker` component allows users to easily select a date, featuring a calendar view, month/year navigation, and custom options.
+ *
+ * See the [Date Picker documentation page](https://satellite.algolia.com/layouts/date-picker) for more information.
+ */
 export declare const DatePicker: VFC<DatePickerProps>;
 export default DatePicker;

package/esm/DatePicker/DatePicker/DatePicker.js

@@ -18,6 +18,11 @@ import { DatePickerActionTypes, datePickerReducer, initDatePickerReducer } from
 import { jsx as _jsx } from "react/jsx-runtime";
 import { jsxs as _jsxs } from "react/jsx-runtime";
 import { Fragment as _Fragment } from "react/jsx-runtime";
+/**
+ * The `DatePicker` component allows users to easily select a date, featuring a calendar view, month/year navigation, and custom options.
+ *
+ * See the [Date Picker documentation page](https://satellite.algolia.com/layouts/date-picker) for more information.
+ */
 export var DatePicker = function DatePicker(props) {
   var _props$initialValue, _props$validate, _props$calendarProps;
   var contextLocale = useLocale("datePicker");

package/esm/DatePicker/DateRangePicker/DateRangePicker.d.ts

@@ -31,5 +31,10 @@ export declare type DateRangePickerProps = {
     renderRightPanel?: (args: RightSidePanelComponentArgs) => ReactNode;
     buttonSize?: DateRangePickerDisplayProps["buttonSize"];
 } & SharedDatePickerProps;
+/**
+ * The `DateRangePicker` component allows selection of start and end dates using two calendars, ideal for planning and scheduling.
+ *
+ * See the [Date Range Picker documentation page](https://satellite.algolia.com/layouts/date-range-picker) for more information.
+ */
 export declare const DateRangePicker: VFC<DateRangePickerProps>;
 export default DateRangePicker;

package/esm/DatePicker/DateRangePicker/DateRangePicker.js

@@ -28,6 +28,12 @@ var defaultValidator = function defaultValidator(_ref) {
 var DEFAULT_DATE_RANGE_PICKER_LOCALE = _objectSpread(_objectSpread({}, DEFAULT_DATE_PICKER_LOCALE), {}, {
   openButton: "Enter a date period..."
 });
+
+/**
+ * The `DateRangePicker` component allows selection of start and end dates using two calendars, ideal for planning and scheduling.
+ *
+ * See the [Date Range Picker documentation page](https://satellite.algolia.com/layouts/date-range-picker) for more information.
+ */
 export var DateRangePicker = function DateRangePicker(_ref2) {
   var _validate, _displayedRange$start, _initialRange$start;
   var id = _ref2.id,

package/esm/Dropdown/Dropdown.d.ts

@@ -36,14 +36,9 @@ declare type DropdownSubComponents = {
 };
 export declare const DEFAULT_DROPDOWN_POPPER_MODIFIERS: StrictModifier[];
 /**
- * ## Best practices
- * - Sort list of options in a way that will make the most sense to the user. You can order:
- *   - alphabetically
- *   - numerically
- *   - by most commonly selected option
- * - Write in sentence case (the first word capitalized, the rest lowercase) and avoid using commas or semicolons at the end of each option
- * - Clearly label options based on what each one will do
- * - Make sure the most common options are listed. These can be grouped into sub-categories under headings
+ * The `Dropdown` component helps users select an item from a list of available options.
+ *
+ * See the [Dropdown documentation page](https://satellite.algolia.com/components/actions/dropdown) for more information.
  */
 export declare const Dropdown: VFC<DropdownProps> & DropdownSubComponents;
 export default Dropdown;

package/esm/Dropdown/Dropdown.js

@@ -31,14 +31,9 @@ export var DEFAULT_DROPDOWN_POPPER_MODIFIERS = [{
 }];
 
 /**
- * ## Best practices
- * - Sort list of options in a way that will make the most sense to the user. You can order:
- *   - alphabetically
- *   - numerically
- *   - by most commonly selected option
- * - Write in sentence case (the first word capitalized, the rest lowercase) and avoid using commas or semicolons at the end of each option
- * - Clearly label options based on what each one will do
- * - Make sure the most common options are listed. These can be grouped into sub-categories under headings
+ * The `Dropdown` component helps users select an item from a list of available options.
+ *
+ * See the [Dropdown documentation page](https://satellite.algolia.com/components/actions/dropdown) for more information.
  */
 export var Dropdown = function Dropdown(_ref) {
   var _renderFooter;

package/esm/Dropzone/Dropzone.d.ts

@@ -17,5 +17,10 @@ export interface DropzoneBaseProps {
     locale?: DropzoneLocale;
 }
 export declare type DropzoneProps = DropzoneBaseProps & Omit<ReactDropZoneProps, "onDrop" | "onDropAccepted" | "onDropRejected" | "multiple">;
+/**
+ * The `Dropzone` component is used to upload files.
+ *
+ * See the [Dropzone documentation page](https://satellite.algolia.com/components/forms/dropzone) for more information.
+ */
 export declare const Dropzone: VFC<DropzoneProps>;
 export default Dropzone;

package/esm/Dropzone/Dropzone.js

@@ -42,6 +42,12 @@ var ValidatedIcon = function ValidatedIcon() {
     className: stl(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["mr-4 h-4 w-4 text-white bg-accent-600 p-px rounded-full"])))
   });
 };
+
+/**
+ * The `Dropzone` component is used to upload files.
+ *
+ * See the [Dropzone documentation page](https://satellite.algolia.com/components/forms/dropzone) for more information.
+ */
 export var Dropzone = function Dropzone(_ref2) {
   var id = _ref2.id,
     placeholder = _ref2.placeholder,