@algolia/satellite 2.0.0-rc.1 → 2.0.0-rc.3

package/dist/cjs/Indicators/ProgressSpinner/ProgressSpinner.d.ts

@@ -1,8 +1,17 @@
 import type { FC, SVGAttributes } from "react";
 export declare type ProgressSpinnerAlign = "left" | "center" | "right";
 export interface ProgressSpinnerProps extends SVGAttributes<SVGSVGElement> {
+    /**
+     * The size of the progress spinner.
+     */
     size?: number;
+    /**
+     * The thickness of the progress spinner.
+     */
     thickness?: number;
+    /**
+     * The alignment of the progress spinner.
+     */
     align?: ProgressSpinnerAlign;
 }
 /**

package/dist/cjs/Indicators/ScrollIndicator/ScrollIndicator.d.ts

@@ -1,13 +1,25 @@
 import type { CSSProperties, FC, ReactHTML, ReactNode } from "react";
 export declare type ScrollIndicatorVariant = "light" | "dark";
 export interface ScrollIndicatorProps {
+    /**
+     * The className to apply to the wrapper element.
+     */
     wrapperClassName?: string;
     /** @ignore */
     className?: string;
     /** @ignore */
     style?: CSSProperties;
+    /**
+     * The tag name to use for the scroll indicator content.
+     */
     tagName?: keyof ReactHTML;
+    /**
+     * The variant of the scroll indicator.
+     */
     variant?: ScrollIndicatorVariant;
+    /**
+     * The content of the scroll indicator.
+     */
     children: ReactNode;
 }
 /**

package/dist/cjs/Indicators/Skeleton/Skeleton.d.ts

@@ -1,8 +1,20 @@
 import type { FC, PropsWithChildren } from "react";
 export interface SkeletonProps {
+    /**
+     * The className to apply to the skeleton element.
+     */
     className?: string;
+    /**
+     * The size of the skeleton.
+     */
     size?: keyof typeof DEFAULT_SKELETON_SIZES;
+    /**
+     * Whether the skeleton should be a circle.
+     */
     circle?: boolean;
+    /**
+     * Whether the skeleton should display an image icon.
+     */
     image?: boolean;
 }
 declare const DEFAULT_SKELETON_SIZES: {

package/dist/cjs/Indicators/Tag/Tag.d.ts

@@ -6,21 +6,35 @@ export declare type TagLocale = {
     removeButton?: string | ((title: string) => string);
 };
 export interface TagProps extends DetailedHTMLProps<HTMLAttributes<HTMLSpanElement>, HTMLSpanElement> {
-    /** The "pink" variant should only be used for **Algolia admin** related things. */
+    /**
+     * The "pink" variant should only be used for **Algolia admin** related things.
+     */
     variant?: TagVariants;
-    /** Handler function called when the "add" button is clicked. */
+    /**
+     * Handler function called when the "add" button is clicked.
+     */
     onAdd?: MouseEventHandler<HTMLElement>;
-    /** The tooltip text to display when hovering over the "add" button. */
+    /**
+     * The tooltip text to display when hovering over the "add" button.
+     */
     addTooltip?: string;
-    /** Handler function called when the "remove" button is clicked. */
+    /**
+     * Handler function called when the "remove" button is clicked.
+     */
     onRemove?: MouseEventHandler<HTMLElement>;
-    /** The tooltip text to display when hovering over the "remove" button. */
+    /**
+     * The tooltip text to display when hovering over the "remove" button.
+     */
     removeTooltip?: string;
     /**
      * Customize the text describing the "add" and "remove" buttons.
      * If not provided, default values will be used.
      */
     locale?: TagLocale;
+    /**
+     * The content of the tag.
+     */
+    children: string;
 }
 /**
  * The `Tag` component is an interactive and customizable text label with varied color options.

package/dist/cjs/Layout/Card/Card.d.ts

@@ -4,6 +4,9 @@ import { CardTitle } from "./components/CardTitle";
 export declare type CardElevation = "100" | "200" | "300" | "400" | "500";
 declare type CardAs = "section" | "aside" | "main" | "div" | "span";
 export interface CardProps {
+    /**
+     * The `id` attribute of the `Card`.
+     */
     id?: string;
     /** @ignore */
     className?: string;
@@ -16,6 +19,9 @@ export interface CardProps {
     as?: CardAs;
     /** Should the content take up full full width of the `Card`. */
     fullBleed?: boolean;
+    /**
+     * The content of the `Card`.
+     */
     children: ReactNode;
     /**
      * Specify distance off the page for the `Card`.

package/dist/cjs/Layout/FlexGrid/FlexGrid.d.ts

@@ -6,22 +6,33 @@ export declare type FlexGridSpacing = "none" | "sm" | "md" | "lg" | "xl";
 export interface FlexGridProps {
     /** @ignore */
     className?: string;
-    /** Define which direction the content should flow */
+    /**
+     * Define which direction the content should flow.
+     * @default row
+     */
     direction?: FlexGridDirection;
     /**
-     * Define whether or not the contents be allowed to wrap
+     * Define whether or not the contents be allowed to wrap.
      * @default false
      */
     wrap?: boolean;
     /**
-     * Define whether or not the content be wrapped in an inline-flex container
+     * Define whether or not the content be wrapped in an inline-flex container.
      * @default false
      */
     inline?: boolean;
+    /**
+     * Define the alignment of the content.
+     * @default leading
+     */
     alignment?: FlexGridAlignment;
+    /**
+     * Define the distribution of the content.
+     * @default leading
+     */
     distribution?: FlexGridDistribution;
     /**
-     * The spacing directly corelates to our Tailwind spacing scale
+     * The spacing directly corelates to our Tailwind spacing scale.
      *
      * none: `spacing.0 → 0px`
      *
@@ -34,6 +45,9 @@ export interface FlexGridProps {
      * xl: `spacing.8 → 32px`
      */
     spacing?: FlexGridSpacing;
+    /**
+     * The content of the `FlexGrid`.
+     */
     children: ReactNode;
 }
 /**

package/dist/cjs/Layout/Insert/Insert.d.ts

@@ -5,9 +5,17 @@ declare type InsertContext = {
     variant?: BadgeVariants;
 };
 export interface InsertProps {
-    /** Descriptive title for the `Insert` */
+    /**
+     * Descriptive title for the `Insert`.
+     */
     title: ReactNode;
+    /**
+     * An array of contexts which will be rendered as `Badge`s.
+     */
     contexts?: Array<string | InsertContext>;
+    /**
+     * The content of the `Insert`.
+     */
     children: ReactNode;
 }
 /**

package/dist/cjs/Layout/Sidebar/Sidebar.d.ts

@@ -1,11 +1,23 @@
 import type { FC, PropsWithChildren } from "react";
 import type { SidebarLocale, SidebarLocation, SidebarVariant } from "./types";
 export declare type SidebarProps = PropsWithChildren<{
+    /**
+     * The ID of the `Sidebar`.
+     */
     id?: string;
     /** @ignore */
     className?: string;
+    /**
+     * Used for accessibility reasons, this label should be unique.
+     */
     label?: string;
+    /**
+     * The locale object to override the default locale.
+     */
     locale?: SidebarLocale;
+    /**
+     * Define whether the sidebar should be collapsed.
+     */
     collapsed?: boolean;
     /**
      * As the name of the variants imply,
@@ -23,10 +35,10 @@ export declare type SidebarProps = PropsWithChildren<{
      * @example <caption>with a location of /bar</caption>
      * isLinkActive('/foo', location) // returns false
      *
-     * */
+     */
     isLinkActive?: (href: string, location: SidebarLocation) => boolean;
     /**
-     * location is used in conjunction with `isLinkActive` to display active links properly.
+     * `location` is used in conjunction with `isLinkActive` to display active links properly.
      * It is injected from outside so that it can work with different router libraries and
      * re-render when necessary.
      */

package/dist/cjs/Layout/Sidebar/SidebarButtonLink.d.ts

@@ -5,16 +5,34 @@ export declare type SidebarButtonLinkIcon = IconComponentType | {
     inactive: IconComponentType;
 };
 export interface SidebarButtonLinkProps {
+    /**
+     * The ID of the `SidebarButtonLink`.
+     */
     id?: string;
+    /**
+     * The icon of the `SidebarButtonLink`.
+     */
     icon: SidebarButtonLinkIcon;
+    /**
+     * The href of the `SidebarButtonLink`.
+     */
     href: string;
+    /**
+     * The onClick handler of the `SidebarButtonLink`.
+     */
     onClick?: MouseEventHandler<HTMLAnchorElement>;
+    /**
+     * Define whether the `SidebarButtonLink` should be disabled.
+     */
     disabled?: boolean;
     /**
      * Alternative content for the tooltip.
      * @default children
      */
     tooltipContent?: ReactNode;
+    /**
+     * The content of the `SidebarButtonLink`.
+     */
     children: ReactNode;
 }
 export declare const SidebarButtonLink: FC<SidebarButtonLinkProps>;

package/dist/cjs/Layout/Sidebar/SidebarHeading.d.ts

@@ -1,8 +1,14 @@
 import type { FC, ReactNode } from "react";
 export declare type SidebarHeadingProps = {
+    /**
+     * The ID of the `SidebarHeading`.
+     */
     id?: string;
     /** @ignore */
     className?: string;
+    /**
+     * The content of the `SidebarHeading`.
+     */
     children: ReactNode;
 };
 export declare const SidebarHeading: FC<SidebarHeadingProps>;

package/dist/cjs/Layout/Sidebar/SidebarLink.d.ts

@@ -1,9 +1,21 @@
 import type { FC, ReactNode } from "react";
 import type { IconComponentType } from "../../Icons";
 export declare type SidebarLinkProps = {
+    /**
+     * The icon of the `SidebarLink`.
+     */
     icon: IconComponentType;
+    /**
+     * The href of the `SidebarLink`.
+     */
     href: string;
+    /**
+     * Define whether the `SidebarLink` should be disabled.
+     */
     disabled?: boolean;
+    /**
+     * The content of the `SidebarLink`.
+     */
     children: ReactNode;
 } & Pick<React.DetailedHTMLProps<React.AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, "id" | "className" | "target" | "rel" | "aria-label" | "onClick">;
 export declare const SidebarLink: FC<SidebarLinkProps>;

package/dist/cjs/Layout/Sidebar/SidebarLinksGroup/SidebarLinksGroup.d.ts

@@ -2,9 +2,15 @@ import type { FC, ReactNode } from "react";
 import { type IconComponentType } from "../../../Icons";
 import type { SidebarLinksGroupLink } from "./types";
 declare type SidebarLinksGroupBaseProps = {
+    /**
+     * The ID of the `SidebarLinksGroup`.
+     */
     id?: string;
     /** @ignore */
     className?: string;
+    /**
+     * The links of the `SidebarLinksGroup`.
+     */
     links: SidebarLinksGroupLink[];
 };
 export declare type StaticSidebarLinksGroupProps = SidebarLinksGroupBaseProps & {
@@ -14,9 +20,21 @@ export declare type StaticSidebarLinksGroupProps = SidebarLinksGroupBaseProps &
     onGroupToggle?: never;
 };
 export declare type CollapsibleSidebarLinksGroupProps = SidebarLinksGroupBaseProps & {
+    /**
+     * The title of the `SidebarLinksGroup`.
+     */
     title: ReactNode;
+    /**
+     * The icon of the `SidebarLinksGroup`.
+     */
     icon: IconComponentType;
+    /**
+     * Define whether the `SidebarLinksGroup` should be open.
+     */
     initialIsOpen?: boolean;
+    /**
+     * The callback function that is called when the `SidebarLinksGroup` is toggled.
+     */
     onGroupToggle?: (open: boolean) => void;
 };
 export declare type SidebarLinksGroupProps = StaticSidebarLinksGroupProps | CollapsibleSidebarLinksGroupProps;

package/dist/cjs/Layout/Sidebar/SidebarNav.d.ts

@@ -1,11 +1,23 @@
 import type { FC, ReactNode } from "react";
 export declare type SidebarNavSpacing = "small" | "large";
 export declare type SidebarNavProps = {
+    /**
+     * The ID of the `SidebarNav`.
+     */
     id?: string;
     /** @ignore */
     className?: string;
+    /**
+     * The spacing of the `SidebarNav`.
+     */
     spacing?: SidebarNavSpacing;
+    /**
+     * The label of the `SidebarNav`.
+     */
     label: string;
+    /**
+     * The children of the `SidebarNav`.
+     */
     children: ReactNode;
 };
 export declare const SidebarNav: FC<SidebarNavProps>;

package/dist/cjs/Layout/Tables/DataTable/DataTable.d.ts

@@ -19,9 +19,11 @@ interface BaseDataTableProps<Item> {
     itemId?: GetItemId<Item>;
     /** The columns define the layout of your table and the respective rows and cells */
     columns: ColumnDefinition<Item>[];
+    /** Whether the table should have pagination. */
     pagination?: PaginationConfiguration;
-    /** the `onChange` is triggered when either sorting or paginating */
+    /** The `onChange` callback is triggered when either sorting or paginating. */
     onChange?(dataConfiguration: DataConfiguration): void;
+    /** The display mode of the table. */
     mode?: DisplayMode;
     /** Specify the global status of the table */
     status?: Status;
@@ -29,22 +31,35 @@ interface BaseDataTableProps<Item> {
     noDataContent?: ReactNode;
     /** Allows for specifying a custom error state */
     errorContent?: ReactNode;
+    /** Whether the table can hover rows. */
     canHoverRow?(row: Row<Item>): boolean;
+    /** The callback triggered when the hovered row changes. */
     onRowHoveredChanged?(row: Row<Item> | null): void;
+    /** The current sorting configuration. */
     sorting?: Sorting[];
+    /** The sort mode of the table. */
     sortMode?: SortMode;
+    /** The locale configuration for the table. */
     locale?: DataTableLocale;
 }
 declare type DataTableWithSelectMode<Item> = {
+    /** The selection mode of the table. */
     selectMode: Exclude<SelectMode, "none">;
+    /** The currently selected rows. */
     selection?: string[];
+    /** The callback triggered when the selection changes. */
     onSelectionChange?(rowId: string[]): void;
+    /** Whether the table can select items. */
     canSelectItem?: CanSelectItem<Item>;
 };
 declare type DataTableWithoutSelectMode = {
+    /** Whether the table has selection. */
     selectMode?: Extract<SelectMode, "none">;
+    /** The currently selected rows. */
     selection?: never;
+    /** The callback triggered when the selection changes. */
     onSelectionChange?: never;
+    /** Whether the table can select items. */
     canSelectItem?: never;
 };
 export declare type DataTableProps<Item> = BaseDataTableProps<Item> & (DataTableWithSelectMode<Item> | DataTableWithoutSelectMode);

package/dist/cjs/Layout/Tables/DataTable/components/Body.d.ts

@@ -2,13 +2,21 @@ import type { ReactNode } from "react";
 import type { DataTableLocale, DataTableProps } from "../DataTable";
 import type { AdvancedColumnDefinition, Row, SelectMode, Status } from "../types";
 export interface DataTableBodyProps<Item> extends Pick<DataTableProps<Item>, "selection" | "onSelectionChange" | "canHoverRow"> {
+    /** The rows to display in the body. */
     rows: Row<Item>[];
+    /** The status of the body. */
     status?: Status;
+    /** The content to display when there is no data. */
     noDataContent?: ReactNode;
+    /** The content to display when there is an error. */
     errorContent?: ReactNode;
+    /** The columns to display in the body. */
     columns: AdvancedColumnDefinition<Item>[];
+    /** The callback triggered when the hovered row changes. */
     onRowHoverChange(row: Row<Item> | null): void;
+    /** The selection mode of the table. */
     selectMode: SelectMode;
+    /** The locale configuration for the table. */
     locale: Required<DataTableLocale>;
 }
 export declare const DataTableBody: <Item extends object>({ rows, columns, status, noDataContent, errorContent, selectMode, selection, onSelectionChange, onRowHoverChange, canHoverRow, locale, }: DataTableBodyProps<Item>) => import("react/jsx-runtime").JSX.Element;

package/dist/cjs/Layout/Tables/DataTable/components/Footer.d.ts

@@ -1,7 +1,9 @@
 import type { FC } from "react";
 import type { DataConfiguration, PaginationConfiguration } from "../types";
 export interface DataTableFooterProps {
+    /** The pagination configuration for the table. */
     pagination: PaginationConfiguration;
+    /** The callback triggered when the pagination changes. */
     onChange(dataConfiguration: DataConfiguration): void;
 }
 export declare const DataTableFooter: FC<DataTableFooterProps>;

package/dist/cjs/Layout/Tables/DataTable/components/Header.d.ts

@@ -1,8 +1,12 @@
 import type { AdvancedColumnDefinition, Sorting, SortingDirection } from "../types";
 export interface DataTableHeaderProps<Item> {
+    /** The columns to display in the header. */
     columns: AdvancedColumnDefinition<Item>[];
+    /** The current sorting configuration. */
     sorting?: Sorting[];
+    /** The callback triggered when the sorting changes. */
     onToggleSort: (columnId: string, direction: SortingDirection) => void;
+    /** Whether the header is disabled. */
     disabled?: boolean;
 }
 export declare const DataTableHeader: <Item extends object>({ columns, sorting, onToggleSort, disabled, }: DataTableHeaderProps<Item>) => import("react/jsx-runtime").JSX.Element;

package/dist/cjs/Layout/Tables/DataTable/components/HeaderCell.d.ts

@@ -1,11 +1,17 @@
 import type { HTMLAttributes, ReactNode } from "react";
 import type { AdvancedColumnDefinition, SortingDirection } from "../types";
 export interface DataTableHeaderCellProps<Item> extends HTMLAttributes<HTMLTableCellElement> {
+    /** The column to display in the header cell. */
     column: AdvancedColumnDefinition<Item>;
+    /** Whether the header cell is disabled. */
     disabled?: boolean;
+    /** Whether sorting is enabled for the column. */
     isSortingEnabled?: boolean;
+    /** The current sorting direction for the column. */
     sortingDirection?: SortingDirection;
+    /** The callback triggered when the sorting changes. */
     onToggleSort: (columnId: string, sortingDirection: SortingDirection) => void;
+    /** The content to display in the header cell. */
     children: ReactNode;
 }
 export declare const DataTableHeaderCell: <Item extends object>({ sortingDirection, onToggleSort, column: { id, className, sort }, disabled, children, ...props }: DataTableHeaderCellProps<Item>) => import("react/jsx-runtime").JSX.Element;

package/dist/cjs/Layout/Tables/DataTable/components/Loader.d.ts

@@ -3,6 +3,7 @@ import type { DataTableLocale } from "../DataTable";
 export interface DataTableLoaderProps {
     /** @ignore */
     className?: string;
+    /** The locale configuration for the table. */
     locale: Required<DataTableLocale>;
 }
 export declare const DataTableLoader: FC<DataTableLoaderProps>;

package/dist/cjs/Layout/Tables/Table/Table.d.ts

@@ -1,10 +1,25 @@
 import type { DetailedHTMLProps, FC, ReactNode, TableHTMLAttributes } from "react";
 export declare type DisplayMode = "comfortable" | "compact";
 export interface TableProps extends DetailedHTMLProps<TableHTMLAttributes<HTMLTableElement>, HTMLTableElement> {
+    /**
+     * The content to display in the footer of the table.
+     */
     footer?: ReactNode;
+    /**
+     * Whether the footer should be displayed in a smaller size.
+     */
     smallFooter?: boolean;
+    /**
+     * Whether the table has actions.
+     */
     hasActions?: boolean;
+    /**
+     * Whether the table should have a highlight.
+     */
     highlight?: boolean;
+    /**
+     * The display mode of the table.
+     */
     mode?: DisplayMode;
 }
 /**

package/dist/cjs/Layout/Tables/Table/components/TableFooter.d.ts

@@ -1,6 +1,9 @@
 import type { FC, PropsWithChildren } from "react";
 export declare type FooterSizes = "default" | "small";
 export declare type FooterProps = PropsWithChildren<{
+    /**
+     * The size of the footer.
+     */
     size?: FooterSizes;
 }>;
 export declare const TableFooter: FC<FooterProps>;

package/dist/cjs/Navigation/Link/Link.d.ts

@@ -1,8 +1,17 @@
 import type { AnchorHTMLAttributes } from "react";
 import type { IconComponentType } from "../../Icons";
 export declare type LinkProps = {
+    /**
+     * The URL of the link.
+     */
     href: string;
+    /**
+     * The icon to display at the start of the link.
+     */
     startIcon?: IconComponentType;
+    /**
+     * The icon to display at the end of the link.
+     */
     endIcon?: IconComponentType;
 } & AnchorHTMLAttributes<HTMLAnchorElement>;
 /**
@@ -11,7 +20,16 @@ export declare type LinkProps = {
  * See the [Link documentation page](https://satellite.algolia.com/components/navigation/link) for more information.
  */
 export declare const Link: import("react").ForwardRefExoticComponent<{
+    /**
+     * The URL of the link.
+     */
     href: string;
+    /**
+     * The icon to display at the start of the link.
+     */
     startIcon?: IconComponentType | undefined;
+    /**
+     * The icon to display at the end of the link.
+     */
     endIcon?: IconComponentType | undefined;
 } & AnchorHTMLAttributes<HTMLAnchorElement> & import("react").RefAttributes<HTMLAnchorElement>>;

package/dist/cjs/Navigation/Pagination/CompactPagination/CompactPagination.d.ts

@@ -8,18 +8,41 @@ export declare type CompactPaginationLocale = {
     label?(page: number, nbPages?: number): string;
 };
 declare type BaseCompactPaginationProps = {
-    /** Currently selected page (1 based index) */
+    /**
+     * The current page number. (1-indexed)
+     */
     currentPage: number;
+    /**
+     * The function to call when the page changes.
+     */
     onChange: (page: number) => void;
+    /**
+     * Whether to show the "Go to first page" button.
+     */
     showGoToFirstPage?: boolean;
+    /**
+     * The label to display.
+     */
     label?: CompactPaginationLabel;
+    /**
+     * The locale to use.
+     */
     locale?: CompactPaginationLocale;
 };
 export declare type DeterminateCompactPaginationProps = BaseCompactPaginationProps & {
+    /**
+     * The total number of pages.
+     */
     nbPages: number;
+    /**
+     * Whether the "Go to last page" button should be shown.
+     */
     showGoToLastPage?: boolean;
 };
 export declare type IndeterminateCompactPaginationProps = BaseCompactPaginationProps & {
+    /**
+     * Whether the "Go to next page" button should be disabled.
+     */
     nextDisabled?: boolean;
 };
 export declare type CompactPaginationProps = DeterminateCompactPaginationProps | IndeterminateCompactPaginationProps;

package/dist/cjs/Navigation/Pagination/DotPagination/DotPagination.d.ts

@@ -3,11 +3,25 @@ export declare type DotPaginationLocale = {
     goToPageText?(page: number): string;
 };
 export declare type DotPaginationProps<T extends number> = {
-    /** Currently selected page (1 based index) */
+    /**
+     * The current page number. (1-indexed)
+     */
     currentPage: NumberUnion<T>;
+    /**
+     * The function to call when the page changes.
+     */
     onChange: (page: NumberUnion<T>) => void;
+    /**
+     * The total number of pages.
+     */
     nbPages: T;
+    /**
+     * The size of the dots.
+     */
     size?: "small" | "medium";
+    /**
+     * The locale to use.
+     */
     locale?: DotPaginationLocale;
 };
 /**

package/dist/cjs/Navigation/Pagination/Pagination/Pagination.d.ts

@@ -5,10 +5,25 @@ export declare type PaginationLocale = {
     goToPreviousPage?: string;
 };
 export interface PaginationProps {
+    /**
+     * The total number of pages.
+     */
     nbPages: number;
+    /**
+     * The current page number. (1-indexed)
+     */
     currentPage: number;
+    /**
+     * The maximum number of buttons to display.
+     */
     maxButtons?: number;
+    /**
+     * The function to call when the page changes.
+     */
     onChange: (page: number) => void;
+    /**
+     * The locale to use.
+     */
     locale?: PaginationLocale;
 }
 /**