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

package/cjs/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/cjs/Button/IconButton.js

@@ -12,9 +12,9 @@ var _jsxRuntime = require("react/jsx-runtime");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2["default"])(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 /**
- * 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.
  */
 var IconButton = exports.IconButton = /*#__PURE__*/(0, _react.forwardRef)(function (props, ref) {
   return /*#__PURE__*/(0, _jsxRuntime.jsx)(_PolymorphicIconButton.PolymorphicIconButton, _objectSpread(_objectSpread({}, props), {}, {

package/cjs/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/cjs/Card/Card.js

@@ -24,7 +24,11 @@ var ELEVATION_CLASSNAMES = {
   "400": (0, _satellitePrefixer["default"])(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["card-z400"]))),
   "500": (0, _satellitePrefixer["default"])(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2["default"])(["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.
+ */
 var Card = exports.Card = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
   var className = _ref.className,
     _ref$as = _ref.as,

package/cjs/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/cjs/Checkbox/Checkbox.js

@@ -30,10 +30,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.
  */
 var Checkbox = exports.Checkbox = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
   var children = _ref.children,

package/cjs/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/cjs/DatePicker/DatePicker/DatePicker.js

@@ -23,6 +23,11 @@ var _jsxRuntime = require("react/jsx-runtime");
 var _templateObject, _templateObject2, _templateObject3, _templateObject4;
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2["default"])(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/**
+ * 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.
+ */
 var DatePicker = exports.DatePicker = function DatePicker(props) {
   var _props$initialValue, _props$validate, _props$calendarProps;
   var contextLocale = (0, _Satellite.useLocale)("datePicker");

package/cjs/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/cjs/DatePicker/DateRangePicker/DateRangePicker.js

@@ -33,6 +33,12 @@ var defaultValidator = function defaultValidator(_ref) {
 var DEFAULT_DATE_RANGE_PICKER_LOCALE = _objectSpread(_objectSpread({}, _utils.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.
+ */
 var DateRangePicker = exports.DateRangePicker = function DateRangePicker(_ref2) {
   var _validate, _displayedRange$start, _initialRange$start;
   var id = _ref2.id,

package/cjs/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/cjs/Dropdown/Dropdown.js

@@ -37,14 +37,9 @@ var DEFAULT_DROPDOWN_POPPER_MODIFIERS = exports.DEFAULT_DROPDOWN_POPPER_MODIFIER
 }];
 
 /**
- * ## 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.
  */
 var Dropdown = exports.Dropdown = function Dropdown(_ref) {
   var _renderFooter;

package/cjs/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/cjs/Dropzone/Dropzone.js

@@ -48,6 +48,12 @@ var ValidatedIcon = function ValidatedIcon() {
     className: (0, _satellitePrefixer["default"])(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["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.
+ */
 var Dropzone = exports.Dropzone = function Dropzone(_ref2) {
   var id = _ref2.id,
     placeholder = _ref2.placeholder,

package/cjs/EmptyState/EmptyState.d.ts

@@ -1,28 +1,9 @@
 import type { VFC } from "react";
 import type { EmptyStateProps } from "./types";
 /**
- * Empty states are used when a list, table, chart or page has no items or data to show. This is an opportunity to provide explanation or guidance to help users progress. This can also be shown when a features hasn't been enable.
+ * The `EmptyState` component informs users when there's no content or data, providing clear actions and guidance to help them proceed or populate the area.
  *
- * #### Features empty state
- * - Use when the CTA will unlock a key feature in the dashboard. The copy and the illustration need to sell the feature and be clear on the value for the user
- *
- * #### Cards empty state
- * - Use when the CTA will unlock a new set of features inside an already activated feature. Use the context of the interface to help users understand the value of these features and the copy to give further informations
- *
- * #### Results/Data empty states
- * - Use when the query lead to no result or when there is no data to show based on the user filters. Always make sure to give the user suggestions to fix it in the copy
- *
- * ## Best practices
- *
- * Empty states should:
- *
- * - Orient users by clearly explaining the benefit and utility of a product or feature
- * - Simplify a complicated experience by focusing on a few key features and benefits
- * - Use simple and clear language that empowers users to move their business forward
- * - Be encouraging and never make users feel unsuccessful or guilty because they haven't used a product or feature
- * - Explain the steps users need to take to activate a product or feature
- * - Use illustrations thoughtfully
- * - Use only one primary call-to-action button
+ * See the [Empty State documentation page](https://satellite.algolia.com/layouts/empty-state) for more information.
  */
 export declare const EmptyState: VFC<EmptyStateProps>;
 export default EmptyState;

package/cjs/EmptyState/EmptyState.js

@@ -94,28 +94,9 @@ var renderEmptyState = function renderEmptyState(_ref) {
 };
 
 /**
- * Empty states are used when a list, table, chart or page has no items or data to show. This is an opportunity to provide explanation or guidance to help users progress. This can also be shown when a features hasn't been enable.
+ * The `EmptyState` component informs users when there's no content or data, providing clear actions and guidance to help them proceed or populate the area.
  *
- * #### Features empty state
- * - Use when the CTA will unlock a key feature in the dashboard. The copy and the illustration need to sell the feature and be clear on the value for the user
- *
- * #### Cards empty state
- * - Use when the CTA will unlock a new set of features inside an already activated feature. Use the context of the interface to help users understand the value of these features and the copy to give further informations
- *
- * #### Results/Data empty states
- * - Use when the query lead to no result or when there is no data to show based on the user filters. Always make sure to give the user suggestions to fix it in the copy
- *
- * ## Best practices
- *
- * Empty states should:
- *
- * - Orient users by clearly explaining the benefit and utility of a product or feature
- * - Simplify a complicated experience by focusing on a few key features and benefits
- * - Use simple and clear language that empowers users to move their business forward
- * - Be encouraging and never make users feel unsuccessful or guilty because they haven't used a product or feature
- * - Explain the steps users need to take to activate a product or feature
- * - Use illustrations thoughtfully
- * - Use only one primary call-to-action button
+ * See the [Empty State documentation page](https://satellite.algolia.com/layouts/empty-state) for more information.
  */
 var EmptyState = exports.EmptyState = function EmptyState(props) {
   return renderEmptyState(props);

package/cjs/Field/Field.d.ts

@@ -17,38 +17,9 @@ export interface FieldProps {
     children: ReactNode;
 }
 /**
- * Use text fields to help users enter, select, and search for text. Text fields are normally found within a form but can also be part of a modal, search, or card
+ * The `Field` component is a helper that wraps inputs to streamline labeling, validation, integration into a form.
  *
- * ## Structure
- * - **Label**: Use the label to provide instructions critical to using the text field. Labels should indicate what sort of information the field requires, be concise and actionable. Consider starting with action verbs (e.g. enter; fill; select). Put labels directly above their input and align them to the left
- * - **Placeholder text**: Use to provide additional, non-critical instructions around how they should use the field. Try using examples over instructions whenever possible
- * - **Helper text**: Use to give additional context or extra guidance. Only use this where clarification is required, and try not to overuse it
- *   - When you provide help text via the helpText prop or an inline error message via the error prop, the help or error content is conveyed to screen reader users with the aria-describedby attribute. This attribute causes the content to be read along with the label, either immediately or after a short delay
- *
- * ## Validation behavior
- * - **Validation icon**: helps indicate what state the field has. This can manifest as validation (error, success) or utility (show/hide password, clear)
- * - **Error text**: is activated after the input is deselected and communicates more information signified by the input icon. This typically displays an error message related to the field. Keep this text as short as possible and make sure it helps the user to recover from an error
- *
- * ## Content guidelines
- * #### Field label
- * - Place above the form field
- * - Keep it short and succinct (1–3 words)
- * - Write in sentence case (the first word capitalized, the rest lowercase)
- *
- * #### Field placeholder
- * - Mandatory to use, however is supplementary in terms of information importance (because the text has low contrast and is not visible when text is entered)
- * - Use examples instead of instructions whenever possible
- * - Include “E.g.:” before an example
- *
- * #### Help / error text
- * - Clearly explain what  is expected (help) or what went wrong and how to fix it (error)
- * - Be short and concise, no more than a single sentence
- * - Use passive voice so users don't feel like they're being blamed for the error
- *
- * #### Designating optional fields
- * - Try to only ask for information that's required
- * - If you need to ask users to provide optional information, mark the field optional by placing the text “(optional)” at the end of the field's label
- * - Don't mark required fields with asterisks
+ * See the [Field documentation page](https://satellite.algolia.com/components/forms/field) for more information.
  */
 export declare const Field: VFC<FieldProps>;
 export default Field;

package/cjs/Field/Field.js

@@ -15,38 +15,9 @@ var _FieldContext = require("./FieldContext");
 var _jsxRuntime = require("react/jsx-runtime");
 var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5, _templateObject6, _templateObject7, _templateObject8, _templateObject9;
 /**
- * Use text fields to help users enter, select, and search for text. Text fields are normally found within a form but can also be part of a modal, search, or card
+ * The `Field` component is a helper that wraps inputs to streamline labeling, validation, integration into a form.
  *
- * ## Structure
- * - **Label**: Use the label to provide instructions critical to using the text field. Labels should indicate what sort of information the field requires, be concise and actionable. Consider starting with action verbs (e.g. enter; fill; select). Put labels directly above their input and align them to the left
- * - **Placeholder text**: Use to provide additional, non-critical instructions around how they should use the field. Try using examples over instructions whenever possible
- * - **Helper text**: Use to give additional context or extra guidance. Only use this where clarification is required, and try not to overuse it
- *   - When you provide help text via the helpText prop or an inline error message via the error prop, the help or error content is conveyed to screen reader users with the aria-describedby attribute. This attribute causes the content to be read along with the label, either immediately or after a short delay
- *
- * ## Validation behavior
- * - **Validation icon**: helps indicate what state the field has. This can manifest as validation (error, success) or utility (show/hide password, clear)
- * - **Error text**: is activated after the input is deselected and communicates more information signified by the input icon. This typically displays an error message related to the field. Keep this text as short as possible and make sure it helps the user to recover from an error
- *
- * ## Content guidelines
- * #### Field label
- * - Place above the form field
- * - Keep it short and succinct (1–3 words)
- * - Write in sentence case (the first word capitalized, the rest lowercase)
- *
- * #### Field placeholder
- * - Mandatory to use, however is supplementary in terms of information importance (because the text has low contrast and is not visible when text is entered)
- * - Use examples instead of instructions whenever possible
- * - Include “E.g.:” before an example
- *
- * #### Help / error text
- * - Clearly explain what  is expected (help) or what went wrong and how to fix it (error)
- * - Be short and concise, no more than a single sentence
- * - Use passive voice so users don't feel like they're being blamed for the error
- *
- * #### Designating optional fields
- * - Try to only ask for information that's required
- * - If you need to ask users to provide optional information, mark the field optional by placing the text “(optional)” at the end of the field's label
- * - Don't mark required fields with asterisks
+ * See the [Field documentation page](https://satellite.algolia.com/components/forms/field) for more information.
  */
 var Field = exports.Field = function Field(_ref) {
   var className = _ref.className,

package/cjs/Flag/Flag.d.ts

@@ -2,5 +2,10 @@ import type { VFC } from "react";
 import type { Notification } from "./types";
 export declare type FlagLocale = Notification["locale"];
 export declare type FlagProps = Omit<Notification, "id" | "content">;
+/**
+ * The `Toast` component is a brief notification that providing timely feedback to users before vanishing after a short duration.
+ *
+ * See the [Toast documentation page](https://satellite.algolia.com/components/feedback/toast) for more information.
+ */
 export declare const Flag: VFC<FlagProps>;
 export default Flag;

package/cjs/Flag/Flag.js

@@ -40,6 +40,12 @@ var VARIANT_SPINNER_CLASSNAMES = {
   orange: (0, _satellitePrefixer["default"])(_templateObject11 || (_templateObject11 = (0, _taggedTemplateLiteral2["default"])(["border-orange-500"]))),
   red: (0, _satellitePrefixer["default"])(_templateObject12 || (_templateObject12 = (0, _taggedTemplateLiteral2["default"])(["border-red-500"])))
 };
+
+/**
+ * The `Toast` component is a brief notification that providing timely feedback to users before vanishing after a short duration.
+ *
+ * See the [Toast documentation page](https://satellite.algolia.com/components/feedback/toast) for more information.
+ */
 var Flag = exports.Flag = function Flag(_ref) {
   var onDismiss = _ref.onDismiss,
     title = _ref.title,

package/cjs/FlexGrid/FlexGrid.d.ts

@@ -36,5 +36,10 @@ export interface FlexGridProps {
     spacing?: FlexGridSpacing;
     children: ReactNode;
 }
+/**
+ * The `FlexGrid` component is a wrapper component that allows you to easily create a flexbox layout.
+ *
+ * See the [Flex Grid documentation page](https://satellite.algolia.com/layouts/flex-grid) for more information.
+ */
 export declare const FlexGrid: VFC<FlexGridProps>;
 export default FlexGrid;

package/cjs/FlexGrid/FlexGrid.js

@@ -38,6 +38,12 @@ var DISTRIBUTION_CLASSNAMES = {
   fill: (0, _satellitePrefixer["default"])(_templateObject16 || (_templateObject16 = (0, _taggedTemplateLiteral2["default"])(["flex-grid-d-fill"]))),
   fillEvenly: (0, _satellitePrefixer["default"])(_templateObject17 || (_templateObject17 = (0, _taggedTemplateLiteral2["default"])(["flex-grid-d-fill-even"])))
 };
+
+/**
+ * The `FlexGrid` component is a wrapper component that allows you to easily create a flexbox layout.
+ *
+ * See the [Flex Grid documentation page](https://satellite.algolia.com/layouts/flex-grid) for more information.
+ */
 var FlexGrid = exports.FlexGrid = function FlexGrid(_ref) {
   var className = _ref.className,
     _ref$direction = _ref.direction,

package/cjs/HelpUnderline/HelpUnderline.d.ts

@@ -7,5 +7,10 @@ export declare type HelpUnderlineProps = {
     tooltipContent: TooltipWrapperProps["content"];
     children: string;
 } & Omit<TooltipWrapperBaseProps, "children">;
+/**
+ * The `HelpUnderline` component is used to display a help underline with a tooltip.
+ *
+ * See the [Help Underline documentation page](https://satellite.algolia.com/components/misc/help-underline) for more information.
+ */
 export declare const HelpUnderline: VFC<HelpUnderlineProps>;
 export default HelpUnderline;

package/cjs/HelpUnderline/HelpUnderline.js

@@ -16,6 +16,11 @@ var _templateObject, _templateObject2;
 var _excluded = ["className", "children", "tooltipClassName", "tooltipContent"];
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2["default"])(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/**
+ * The `HelpUnderline` component is used to display a help underline with a tooltip.
+ *
+ * See the [Help Underline documentation page](https://satellite.algolia.com/components/misc/help-underline) for more information.
+ */
 var HelpUnderline = exports.HelpUnderline = function HelpUnderline(_ref) {
   var className = _ref.className,
     children = _ref.children,

package/cjs/Input/Input.d.ts

@@ -20,11 +20,9 @@ export interface InputProps extends Omit<InputHTMLAttributes<HTMLInputElement>,
     locale?: InputPropsLocale;
 }
 /**
- * Use text fields to help users enter, select, and search for text. Text fields are normally found within a form but can also be part of a modal, search, or card
+ * The `Input` component is a flexible, user-friendly component for efficient text and number entry across forms and applications.
  *
- * ## Variations
- * #### Number input
- * - **Stepper (optional)**: consider using a stepper (number control) to let users increase or decrease the value of the input. This is an optional part of the number field so only use based on what you think will help the user
+ * See the [Input documentation page](https://satellite.algolia.com/components/forms/input) for more information.
  */
 export declare const Input: import("react").ForwardRefExoticComponent<InputProps & import("react").RefAttributes<HTMLInputElement>>;
 export default Input;

package/cjs/Input/Input.js

@@ -57,11 +57,9 @@ var ValidatedIcon = function ValidatedIcon() {
 };
 
 /**
- * Use text fields to help users enter, select, and search for text. Text fields are normally found within a form but can also be part of a modal, search, or card
+ * The `Input` component is a flexible, user-friendly component for efficient text and number entry across forms and applications.
  *
- * ## Variations
- * #### Number input
- * - **Stepper (optional)**: consider using a stepper (number control) to let users increase or decrease the value of the input. This is an optional part of the number field so only use based on what you think will help the user
+ * See the [Input documentation page](https://satellite.algolia.com/components/forms/input) for more information.
  */
 var Input = exports.Input = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, externalRef) {
   var className = _ref.className,

package/cjs/Insert/Insert.d.ts

@@ -11,35 +11,9 @@ export interface InsertProps {
     children: ReactNode;
 }
 /**
-* Put more emphasis on side content.
-
-* ## Examples
-* [See the component in Figma](https://www.figma.com/file/99l59il97k2n5y4n6Jucal/%5BSatellite%5D-Components?node-id=2912%3A279499)
-
-* ## Current Status
-* - [x] Figma
-* - [x] React
-* - [ ] Documentation
-
-* ## Component structure
-* The component is a simple and flexible container. It should include a Title and a short text. To give more context you can use optional badges and an optional link to forward users in the right direction.
-
-* ## Guidelines
-
-* ### How to use it?
-* Use the `Insert` if you want to give extra information to the user about the flow they are in or to highlight and define some terms used. This component can be use on the side of existing content or as a block.
-
-* ### How to NOT use it?
-* - Don't use this component to display temporary and/or critical information, use an Alert instead.
-
-* ### Variants
-* - Grey background
-
-* ### Do's and Don't
-* TODO
-
-* ## Accessibility
-* TODO
+ * The `Insert` component is used to give extra information to the user about the flow they are in or to highlight and define some terms used.
+ *
+ * See the [Insert documentation page](https://satellite.algolia.com/layouts/insert) for more information.
  */
 export declare const Insert: VFC<InsertProps>;
 export default Insert;

package/cjs/Insert/Insert.js

@@ -12,35 +12,9 @@ var _onlyText = _interopRequireDefault(require("../utils/onlyText"));
 var _jsxRuntime = require("react/jsx-runtime");
 var _templateObject, _templateObject2, _templateObject3, _templateObject4;
 /**
-* Put more emphasis on side content.
-
-* ## Examples
-* [See the component in Figma](https://www.figma.com/file/99l59il97k2n5y4n6Jucal/%5BSatellite%5D-Components?node-id=2912%3A279499)
-
-* ## Current Status
-* - [x] Figma
-* - [x] React
-* - [ ] Documentation
-
-* ## Component structure
-* The component is a simple and flexible container. It should include a Title and a short text. To give more context you can use optional badges and an optional link to forward users in the right direction.
-
-* ## Guidelines
-
-* ### How to use it?
-* Use the `Insert` if you want to give extra information to the user about the flow they are in or to highlight and define some terms used. This component can be use on the side of existing content or as a block.
-
-* ### How to NOT use it?
-* - Don't use this component to display temporary and/or critical information, use an Alert instead.
-
-* ### Variants
-* - Grey background
-
-* ### Do's and Don't
-* TODO
-
-* ## Accessibility
-* TODO
+ * The `Insert` component is used to give extra information to the user about the flow they are in or to highlight and define some terms used.
+ *
+ * See the [Insert documentation page](https://satellite.algolia.com/layouts/insert) for more information.
  */
 var Insert = exports.Insert = function Insert(_ref) {
   var title = _ref.title,

package/cjs/KeyboardKey/KeyboardKey.d.ts

@@ -4,4 +4,9 @@ export interface KeyboardKeyProps {
     className?: string;
     value: string;
 }
+/**
+ * The `KeyboardKey` component is used to display a keyboard key.
+ *
+ * See the [Keyboard Key documentation page](https://satellite.algolia.com/components/misc/keyboard-key) for more information.
+ */
 export declare const KeyboardKey: VFC<KeyboardKeyProps>;

package/cjs/KeyboardKey/KeyboardKey.js

@@ -20,6 +20,11 @@ var KEY_MAPPINGS = {
   enter: _reactFeather.CornerDownLeft,
   escape: "esc"
 };
+/**
+ * The `KeyboardKey` component is used to display a keyboard key.
+ *
+ * See the [Keyboard Key documentation page](https://satellite.algolia.com/components/misc/keyboard-key) for more information.
+ */
 var KeyboardKey = exports.KeyboardKey = function KeyboardKey(_ref) {
   var className = _ref.className,
     value = _ref.value;

package/cjs/Link/ButtonLink.d.ts

@@ -3,6 +3,11 @@ import { type PolymorphicButtonProps } from "../Button/PolymorphicButton";
 export declare type ButtonLinkProps = Omit<PolymorphicButtonProps<"a">, "as" | "ref"> & {
     href: string;
 };
+/**
+ * The `ButtonLink` component is used to display a link as a button.
+ *
+ * See the [Link documentation page](https://satellite.algolia.com/components/navigation/link) for more information.
+ */
 export declare const ButtonLink: import("react").ForwardRefExoticComponent<Omit<PolymorphicButtonProps<"a">, "ref" | "as"> & {
     href: string;
 } & import("react").RefAttributes<HTMLAnchorElement>>;

package/cjs/Link/ButtonLink.js

@@ -15,6 +15,11 @@ var _jsxRuntime = require("react/jsx-runtime");
 var _excluded = ["endIcon", "href", "onClick"];
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2["default"])(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/**
+ * The `ButtonLink` component is used to display a link as a button.
+ *
+ * See the [Link documentation page](https://satellite.algolia.com/components/navigation/link) for more information.
+ */
 var ButtonLink = exports.ButtonLink = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
   var EndIcon = _ref.endIcon,
     href = _ref.href,

package/cjs/Link/IconButtonLink.d.ts

@@ -3,6 +3,11 @@ import { type PolymorphicIconButtonProps } from "../Button/PolymorphicIconButton
 export declare type IconButtonLinkProps = Omit<PolymorphicIconButtonProps<"a">, "as" | "ref"> & {
     href: string;
 };
+/**
+ * The `ButtonLink` component is used to display a link as an icon button.
+ *
+ * See the [Link documentation page](https://satellite.algolia.com/components/navigation/link) for more information.
+ */
 export declare const IconButtonLink: import("react").ForwardRefExoticComponent<Omit<PolymorphicIconButtonProps<"a">, "ref" | "as"> & {
     href: string;
 } & import("react").RefAttributes<HTMLAnchorElement>>;

package/cjs/Link/IconButtonLink.js

@@ -14,6 +14,11 @@ var _jsxRuntime = require("react/jsx-runtime");
 var _excluded = ["href", "onClick"];
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2["default"])(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/**
+ * The `ButtonLink` component is used to display a link as an icon button.
+ *
+ * See the [Link documentation page](https://satellite.algolia.com/components/navigation/link) for more information.
+ */
 var IconButtonLink = exports.IconButtonLink = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
   var href = _ref.href,
     onClick = _ref.onClick,