widenarrow-ui 2.3.0 → 2.3.2

package/lib/index.d.ts

@@ -1082,6 +1082,8 @@ interface LinkProps {
     icon?: Partial<IconTypes>;
     /** @default ColorTypes.CURRENT */
     iconColor?: Partial<ColorTypes>;
+    /** @default SizeTypes.MEDIUM */
+    iconSize?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE | SizeTypes.AUTO | undefined;
     /** @default '_blank' */
     target?: '_blank' | '_self';
     children?: ReactNode;
@@ -1187,6 +1189,9 @@ interface ListButtonProps {
     labelClassName?: string;
     iconClassName?: string;
     icon?: Partial<IconTypes>;
+    /** Applied to the icon if in a Link component. Otherwise, size is inherited from the button's size.
+     * @default SizeTypes.SMALL */
+    iconSize?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE | SizeTypes.AUTO | undefined;
     /** Shown at the end of the row at all times, for badges, spinners or status dots. */
     rightComponent?: ReactNode;
     /**
@@ -1223,7 +1228,7 @@ interface ListButtonProps {
  * is an InlineButton and its props carry through; with `to` it is a link.
  */
 declare const ListButton: {
-    ({ text, to, className, buttonClassName, labelClassName, iconClassName, icon, rightComponent, hoverComponent, selected, disabled, size, id, ariaLabel, toolTip, tabIndex, autoFocus, buttonRef, onClickCallback }: ListButtonProps): JSX.Element;
+    ({ text, to, className, buttonClassName, labelClassName, iconClassName, icon, iconSize, rightComponent, hoverComponent, selected, disabled, size, id, ariaLabel, toolTip, tabIndex, autoFocus, buttonRef, onClickCallback }: ListButtonProps): JSX.Element;
     displayName: string;
 };
 
@@ -1416,7 +1421,63 @@ interface SortableTableProps {
      * @default TableTypes.RULED
      */
     type?: TableTypes.RULED | TableTypes.CARDS;
-    /** Column configuration, in render order. */
+    /**
+     * Column configuration, in render order. Each entry accepts:
+     *
+     * **`key`** — `string`, required
+     *
+     * Row key whose value fills the column when there is no `customCellComponent`. Always the sort key: it is what `onSortCallback` reports and what `sortBy` is matched against.
+     *
+     * **`title`** — `string`, required
+     *
+     * Heading text.
+     *
+     * **`width`** — `string`, required
+     *
+     * A percentage (`'25%'`) or a fixed value (`'120px'`), applied inline to the header and body cells.
+     *
+     * **`disableSort`** — `boolean`, defaults to `false`
+     *
+     * Renders the heading as static text with no sort button.
+     *
+     * **`alignRight`** — `boolean`, defaults to `false`
+     *
+     * Right-aligns the cell, and moves the sort chevron to the left of the heading.
+     *
+     * **`alignCenter`** — `boolean`, defaults to `false`
+     *
+     * Centres the cell.
+     *
+     * **`withEllipsis`** — `boolean`, defaults to `false`
+     *
+     * Truncates overflowing content with an ellipsis instead of wrapping.
+     *
+     * **`toolTip`** — `string`
+     *
+     * Tooltip on the heading. Falls back to `title` when omitted.
+     *
+     * **`className`** — `string`
+     *
+     * Applied to the content span inside each body cell, not to the cell itself.
+     *
+     * **`customHeaderCellComponent`** — `(cell) => ReactNode`
+     *
+     * Replaces the entire heading, sort button included.
+     *
+     * **`customCellComponent`** — `(row) => ReactNode`
+     *
+     * Replaces the cell value. Receives the whole row, so it can read keys other than `key`.
+     *
+     * ------------------------------------------------------------
+     *
+     * `width`, `alignRight`, `alignCenter`, `withEllipsis` and `className` apply whether or not the column
+     * has a `customCellComponent` — they sit on the cell and its content span, which wrap a custom cell too.
+     * Only `key` changes meaning: with a custom cell it still drives sorting, but no longer supplies the
+     * displayed value.
+     *
+     * A `customHeaderCellComponent` replaces the heading before any of it is built, so `title`, `toolTip`
+     * and `disableSort` stop having any effect on that column's heading — including its sort button.
+     */
     cells: Array<SortableTableCellInterface>;
     /** Row objects. Each is passed to `customCellComponent`, and indexed by `cell.key` otherwise. */
     data: Array<any>;
@@ -1466,86 +1527,6 @@ declare const SortableTable: {
     displayName: string;
 };
 
-interface TableAction {
-    icon: Partial<IconTypes>;
-    /** Tooltip, and the accessible name of the button. Required, because the button has no visible text. */
-    toolTip: string;
-    onClickCallback: (event: MouseEvent<HTMLButtonElement>) => void;
-    /** @default false */
-    disabled?: boolean;
-    id?: string;
-}
-interface TableActionsCellProps {
-    /** Buttons to render, in order. */
-    actions: Array<TableAction>;
-    /** Size of every button in the group. @default SizeTypes.SMALL */
-    size?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE;
-    /** Text shown before the buttons. For bulk headers, e.g. "3 selected". */
-    label?: string;
-    className?: string;
-}
-
-declare const TableActionsCell: FC<TableActionsCellProps>;
-
-interface TableSelectionCellProps {
-    /** Whether this row is selected. */
-    checked: boolean;
-    /** Fired with the next selected state. */
-    onChangeCallback: (checked: boolean) => void;
-    /** Accessible name for the checkbox, e.g. `Select ${row.name}`. Never rendered visibly. */
-    label: string;
-    /** @default false */
-    disabled?: boolean;
-    className?: string;
-}
-
-declare const TableSelectionCell: FC<TableSelectionCellProps>;
-
-interface TableSelectionHeaderCellProps {
-    /** How many rows are currently selected. Drives both the checked and indeterminate states. */
-    selectedCount: number;
-    /** How many rows are selectable in total. Usually the full result count, not just the loaded page. */
-    totalCount: number;
-    /** Fired with the next selected state: true to select every row, false to clear the selection. */
-    onChangeCallback: (selectAll: boolean) => void;
-    /** Accessible name for the checkbox. Never rendered visibly. */
-    label: string;
-    /**
-     * Bulk actions revealed once at least one row is selected. Supply already-translated tooltips.
-     * Omit to keep the header as a plain select-all checkbox.
-     */
-    actions?: Array<TableAction>;
-    /** Text beside the bulk actions, e.g. `${selectedCount} selected`. Only shown when `actions` are present. */
-    selectedLabel?: string;
-    /** @default false */
-    disabled?: boolean;
-    className?: string;
-}
-
-declare const TableSelectionHeaderCell: FC<TableSelectionHeaderCellProps>;
-
-interface TableTextCellProps {
-    /** Primary value. */
-    text: string | number;
-    /** Second line below `text`, rendered smaller and muted. For the common "name over email" cell. */
-    secondaryText?: string | number;
-    /** Colour of the primary line. Use for status values such as an inactive row. */
-    color?: Partial<ColorTypes>;
-    /** Weight of the primary line. @default '400' */
-    fontWeight?: TypographyFontWeight;
-    /**
-     * Truncates both lines with an ellipsis. A tooltip carrying the full text is added automatically,
-     * so truncated values stay readable.
-     * @default false
-     */
-    withEllipsis?: boolean;
-    /** Overrides the tooltip that `withEllipsis` derives from `text`. Set on its own to add a tooltip without truncating. */
-    toolTip?: string;
-    className?: string;
-}
-
-declare const TableTextCell: FC<TableTextCellProps>;
-
 interface SwitchButtonProps {
     checked: boolean;
     id?: string;
@@ -1838,4 +1819,4 @@ declare const NoDataMessage: {
     displayName: string;
 };
 
-export { AppColors, AspectRatioTypes, BorderInterface, Box, Button, Card, Checkbox, ColorStyleInterface, ColorTypes, DropDown, DropDownItem, DropDownRef, FacetButton, FlexStylingInterface, FontFamilyTypes, FormSkeleton, Grid, Heading, HierarchyInterface, HierarchyTypes, Icon, IconButton, IconStyleInterface, IconTypes, Image, InlineButton, Input, Label, Link, LinkTypes, ListButton, ListButtonProps, ListItem, ListSkeleton, MarginInterface, MultiActionButton, NoDataMessage, PaddingInterface, Pagination, Paragraph, RadioButton, SelectInput, Separator, SizeStyleInterface, SizeTypes, SkeletonItem, SolidSpinner, SortableTable, SortableTableCellInterface, SortableTableProps, Span, SwitchButton, Tab, TabGroup, TabGroupProps, TabIndicatorProps, TabProps, TabValue, TableAction, TableActionsCell, TableActionsCellProps, TableSelectionCell, TableSelectionCellProps, TableSelectionHeaderCell, TableSelectionHeaderCellProps, TableTextCell, TableTextCellProps, TableTypes, TextAreaInput, ToolTip, borderClassNames, flexClassNames, marginClassNames, paddingClassNames };
+export { AppColors, AspectRatioTypes, BorderInterface, Box, Button, Card, Checkbox, ColorStyleInterface, ColorTypes, DropDown, DropDownItem, DropDownRef, FacetButton, FlexStylingInterface, FontFamilyTypes, FormSkeleton, Grid, Heading, HierarchyInterface, HierarchyTypes, Icon, IconButton, IconStyleInterface, IconTypes, Image, InlineButton, Input, Label, Link, LinkTypes, ListButton, ListButtonProps, ListItem, ListSkeleton, MarginInterface, MultiActionButton, NoDataMessage, PaddingInterface, Pagination, Paragraph, RadioButton, SelectInput, Separator, SizeStyleInterface, SizeTypes, SkeletonItem, SolidSpinner, SortableTable, SortableTableCellInterface, SortableTableProps, Span, SwitchButton, Tab, TabGroup, TabGroupProps, TabIndicatorProps, TabProps, TabValue, TableTypes, TextAreaInput, ToolTip, borderClassNames, flexClassNames, marginClassNames, paddingClassNames };