@hyphen/hyphen-components 7.3.2 → 7.3.4

package/dist/components/Sidebar/Sidebar.stories.d.ts

@@ -1,9 +0,0 @@
-import React from 'react';
-import { Meta } from '@storybook/react-vite';
-import { Sidebar } from './Sidebar';
-declare const meta: Meta<typeof Sidebar>;
-export default meta;
-export declare const SidebarExample: () => React.JSX.Element;
-export declare const SidebarRightExample: () => React.JSX.Element;
-export declare const SidebarBothSides: () => React.JSX.Element;
-export declare const SidebarCollapsed: () => React.JSX.Element;

package/dist/components/Spinner/Spinner.d.ts

@@ -1,12 +0,0 @@
-import { FC } from 'react';
-export interface SpinnerProps {
-    /**
-     * Custom className to be applied to spinner container div element.
-     */
-    className?: string;
-    /**
-     * Size of the spinner.
-     */
-    size?: 'sm' | 'md' | 'lg' | 'xl';
-}
-export declare const Spinner: FC<SpinnerProps>;

package/dist/components/Spinner/Spinner.stories.d.ts

@@ -1,8 +0,0 @@
-import type { Meta } from '@storybook/react-vite';
-import React from 'react';
-import { Spinner } from './Spinner';
-declare const meta: Meta<typeof Spinner>;
-export default meta;
-export declare const Default: () => React.JSX.Element;
-export declare const Color: () => React.JSX.Element;
-export declare const Sizes: () => React.JSX.Element;

package/dist/components/Switch/Switch.d.ts

@@ -1,64 +0,0 @@
-import React, { ChangeEvent, FC, FocusEvent, ReactNode } from 'react';
-import { ResponsiveProp } from '../../types';
-export type SwitchSize = 'sm' | 'md' | 'lg';
-export interface SwitchProps {
-    /**
-     * The id attribute of the input.
-     */
-    id: string;
-    /**
-     * The switch input "checked" attribute.
-     */
-    isChecked: boolean;
-    /**
-     * Custom content to be displayed to right of switch.
-     */
-    label: string;
-    /**
-     * Callback function when input is changed.
-     */
-    onChange: (event: ChangeEvent<HTMLInputElement>) => void;
-    /**
-     * Additional classes to add.
-     */
-    className?: string;
-    /**
-     * Mark the input field as invalid and display a validation message.
-     * Pass a string or node to render a validation message below the input.
-     */
-    error?: ReactNode;
-    /**
-     * Additional clarifying text to help describe the input
-     */
-    helpText?: ReactNode;
-    /**
-     * Determines if the label is not shown for stylistic reasons.
-     * Note the label is still a required prop and will be used as the aria-label for accessibility reasons.
-     */
-    hideLabel?: boolean;
-    /**
-     * If the input should be disabled and not focusable.
-     */
-    isDisabled?: boolean;
-    /**
-     * The required and aria-required attributes on the input
-     */
-    isRequired?: boolean;
-    /**
-     * Callback function when input is blurred.
-     */
-    onBlur?: (event: FocusEvent<HTMLInputElement>) => void;
-    /**
-     * Callback function when input is focused.
-     */
-    onFocus?: (event: FocusEvent<HTMLInputElement>) => void;
-    /**
-     * Visual indicator that the field is required, that gets appended to the label
-     */
-    requiredIndicator?: React.ReactNode;
-    /**
-     * The size of the switch.
-     */
-    size?: SwitchSize | ResponsiveProp<SwitchSize>;
-}
-export declare const Switch: FC<SwitchProps>;

package/dist/components/Switch/Switch.stories.d.ts

@@ -1,12 +0,0 @@
-import React from 'react';
-import type { Meta } from '@storybook/react-vite';
-import { Switch } from './Switch';
-declare const meta: Meta<typeof Switch>;
-export default meta;
-export declare const Overview: () => React.JSX.Element;
-export declare const Basic: () => React.JSX.Element;
-export declare const HelpText: () => React.JSX.Element;
-export declare const HiddenLabel: () => React.JSX.Element;
-export declare const Sizes: () => React.JSX.Element;
-export declare const Disabled: () => React.JSX.Element;
-export declare const Error: () => React.JSX.Element;

package/dist/components/Table/Table.d.ts

@@ -1,86 +0,0 @@
-import { FC } from 'react';
-import { Column, Row, EventWithColumnKey } from '../../types';
-export interface TableProps {
-    /**
-     * Columns for the table. See Column definition below for details.
-     */
-    columns: Column[];
-    /**
-     * The data rows to be displayed
-     */
-    rows: Row[];
-    /**
-     * Key that represents a unique value for a row. This is necessary in
-     * order to supply React with a node key on each row.
-     */
-    rowKey: string;
-    /**
-     * Additional classes to add.
-     */
-    className?: string;
-    /**
-     * Text alignment for all table cells. Can be superseded by passing the same prop into the `Column` object
-     * for a specific column.
-     */
-    align?: 'left' | 'right' | 'center';
-    /**
-     * Global placeholder for empty cells. Can be overwritten by setting the same attribute
-     * in the `Column` config.
-     */
-    emptyCellPlaceholder?: string | number | undefined;
-    /**
-     * Enable a hover state on table rows.
-     */
-    hoverableRows?: boolean;
-    /**
-     * Remove borders around table, thead, tbody, td, etc.
-     */
-    isBorderless?: boolean;
-    /**
-     * Make Table more compact by cutting cell padding in half.
-     */
-    isCompact?: boolean;
-    /**
-     * If table scrolls vertically, header will remain stuck to the top of the table, and not scroll away.
-     */
-    hasStickyHeader?: boolean;
-    /**
-     * Set to true if data is loading.
-     */
-    isLoading?: boolean;
-    /**
-     * Set the maximum width and height and enable scrolling within the container when the table grows
-     * past those values. Useful for when we want to render a large table but not force the parent container
-     * to grow and instead make the user scroll. Set values to boolean `true` to enable `overflow: scroll` on the table
-     * without specifying a width/height
-     */
-    isScrollable?: {
-        x?: boolean;
-        y?: boolean;
-    };
-    /**
-     * Adds zebra-striping to any table row within the table body.
-     */
-    isStriped?: boolean;
-    /**
-     * Callback function to fire on sorting one of the table headers.
-     */
-    onSort?: (event: EventWithColumnKey) => void;
-    /**
-     * The key of the sorted column and its sort direction.
-     */
-    sortedColumn?: {
-        dataKey: string | undefined;
-        sortDirection: 'none' | 'ascending' | 'descending' | undefined;
-    };
-    /**
-     * Control the `table-layout` css property for the table.
-     */
-    useFixedTableLayout?: boolean;
-    /**
-     * Truncate overflow inside column based on column width. Can be overwritten on specific columns,
-     * by passing `truncateOverflow` value on a specific Column
-     */
-    truncateOverflow?: boolean;
-}
-export declare const Table: FC<TableProps>;

package/dist/components/Table/Table.stories.d.ts

@@ -1,31 +0,0 @@
-import type { Meta } from '@storybook/react-vite';
-import React from 'react';
-import { Table } from './Table';
-declare const meta: Meta<typeof Table>;
-export default meta;
-export declare const Column: () => React.JSX.Element;
-export declare const CommonExample: () => React.JSX.Element;
-export declare const Loading: () => React.JSX.Element;
-export declare const Sortable: () => React.JSX.Element;
-export declare const SortablewithDefaultSortedColumn: () => React.JSX.Element;
-export declare const SortableAndLoading: () => React.JSX.Element;
-export declare const Scrollable: () => React.JSX.Element;
-export declare const ScrollablewithStickyHeader: () => React.JSX.Element;
-export declare const ScrollablewithFirstColumnStuckToLeft: () => React.JSX.Element;
-export declare const ScrollablewithStickyHeaderAndNthColumnStuckToLeft: () => React.JSX.Element;
-export declare const ScrollableWithLastColumnStuckToRight: () => React.JSX.Element;
-export declare const ScrollableWithStickyHeaderAndFirstColumnStuckToLeft: () => React.JSX.Element;
-export declare const ScrollableAndLoading: () => React.JSX.Element;
-export declare const FixedWidthColumns: () => React.JSX.Element;
-export declare const FixedTableLayout: () => React.JSX.Element;
-export declare const TruncateOverflow: () => React.JSX.Element;
-export declare const CustomActions: () => React.JSX.Element;
-export declare const EmptyCellPlaceholder: () => React.JSX.Element;
-export declare const Borderless: () => React.JSX.Element;
-export declare const Compact: () => React.JSX.Element;
-export declare const Striped: () => React.JSX.Element;
-export declare const Hoverable: () => React.JSX.Element;
-export declare const StripedAndHoverable: () => React.JSX.Element;
-export declare const AligningCellText: () => React.JSX.Element;
-export declare const GlobalAlign: () => React.JSX.Element;
-export declare const ComponentAsColumnHeader: () => React.JSX.Element;

package/dist/components/Table/TableBody/TableBody.d.ts

@@ -1,52 +0,0 @@
-import { FC, Key } from 'react';
-import { Column, Row } from '../../../types';
-export interface TableBodyProps {
-    /**
-     * The table columns to be rendered
-     */
-    columns: Column[];
-    /**
-     * The unique key to identify a React node for each row.
-     */
-    rowKey: Key;
-    /**
-     * The table rows to be rendered
-     */
-    rows: Row[];
-    /**
-     * Text alignment for all table cells. Can be superseded by passing the same prop into the `Column` object
-     * for a specific column.
-     */
-    align?: 'left' | 'right' | 'center';
-    /**
-     * A custom class to apply to the table body.
-     */
-    className?: string;
-    /**
-     * A global placeholder for empty cells. Note: can be overwriten by
-     * the same attribute passed for an individual column config object.
-     */
-    emptyCellPlaceholder?: string | number | undefined;
-    /**
-     * Enable a hover state on table rows.
-     */
-    hoverableRows?: boolean;
-    /**
-     * Whether the table has borders or not.
-     */
-    isBorderless?: boolean;
-    /**
-     * Whether the table rows have smaller padding
-     */
-    isCompact?: boolean;
-    /**
-     * Whether the table rows have a striped pattern
-     */
-    isStriped?: boolean;
-    /**
-     * Truncate overflow inside column based on column width. Can be overwritten on specific columns,
-     * by passing `truncateOverflow` value on a specific Column
-     */
-    truncateOverflow?: boolean;
-}
-export declare const TableBody: FC<TableBodyProps>;

package/dist/components/Table/TableBody/TableBodyCell/TableBodyCell.d.ts

@@ -1,45 +0,0 @@
-import { FC, ReactNode } from 'react';
-export interface TableBodyCellProps {
-    /**
-     * Text alignment for all table cells. Can be superseded by passing the same prop into the `Column` object
-     * for a specific column.
-     */
-    align?: 'left' | 'right' | 'center';
-    /**
-     * Children node to be rendered.
-     */
-    children?: ReactNode;
-    /**
-     * Custom class to be applied to `<tr>` element.
-     */
-    className?: string;
-    /**
-     * Remove borders around td elements.
-     */
-    isBorderless?: boolean;
-    /**
-     * Reduces padding inside table cells.
-     */
-    isCompact?: boolean;
-    /**
-     * Will stick to either the left or right side of a table during horizontal scroll.
-     */
-    sticky?: 'left' | 'right';
-    /**
-     * Truncates the cell contents based on width established by `Column`
-     * NOTE: Truncate only on cells with primitive data types.
-     */
-    truncateOverflow?: boolean;
-    /**
-     * Placeholder for an empty cell, will be rendered when content is `null` `undefined`
-     * or `''`. Placeholders will not be rendered on values of `0`.
-     */
-    emptyCellPlaceholder?: ReactNode;
-    /**
-     * Fixed width for a particular cell.
-     * Value should be taken from column config so it matches its parent.
-     */
-    width?: number;
-}
-declare const TableBodyCell: FC<TableBodyCellProps>;
-export default TableBodyCell;

package/dist/components/Table/TableHead/TableHead.d.ts

@@ -1,46 +0,0 @@
-import { FC } from 'react';
-import { Column, EventWithColumnKey } from '../../../types';
-export interface TableHeadProps {
-    /**
-     * The table columns to be rendered
-     */
-    columns: Column[];
-    /**
-     * Text alignment for all table cells. Can be superseded by passing the same prop into the `Column` object
-     * for a specific column.
-     */
-    align?: 'left' | 'right' | 'center';
-    /**
-     * Custom class to be applied to the `<thead>` element.
-     */
-    className?: string;
-    /**
-     * Whether the table has borders or not.
-     */
-    isBorderless?: boolean;
-    /**
-     * Whether the table rows have smaller padding
-     */
-    isCompact?: boolean;
-    /**
-     * If table scrolls vertically, header will remain stuck to the top of the table, and not scroll away.
-     */
-    hasStickyHeader?: boolean;
-    /**
-     * Callback function to fire on sorting one of the table headers.
-     */
-    onSort?: (event: EventWithColumnKey) => void;
-    /**
-     * The key of the sorted column and its sort direction.
-     */
-    sortedColumn?: {
-        dataKey: string | undefined;
-        sortDirection: 'none' | 'ascending' | 'descending' | undefined;
-    };
-    /**
-     * Truncate overflow inside column based on column width. Can be overwritten on specific columns,
-     * by passing `truncateOverflow` value on a specific Column
-     */
-    truncateOverflow?: boolean;
-}
-export declare const TableHead: FC<TableHeadProps>;

package/dist/components/Table/TableHead/TableHeaderCell/TableHeaderCell.d.ts

@@ -1,65 +0,0 @@
-import { FC, Key } from 'react';
-import { Column, EventWithColumnKey } from '../../../../types';
-export interface TableHeaderCellProps {
-    /**
-     * Title to display for the column.
-     */
-    column: Column;
-    /**
-     * Text alignment for all table cells. Can be superseded by passing the same prop into the `Column` object
-     * for a specific column.
-     */
-    align?: 'left' | 'right' | 'center';
-    /**
-     * Custom class to apply to the `<th>` element.
-     */
-    className?: string;
-    /**
-     * Key of corresponding data value in the table.
-     */
-    dataKey?: Key;
-    /**
-     * Remove borders around th elements.
-     */
-    isBorderless?: boolean;
-    /**
-     * Determines if table header cells should render as compact (less padding);
-     */
-    isCompact?: boolean;
-    /**
-     * If table scrolls vertically, header will remain stuck to the top of the table, and not scroll away.
-     */
-    hasStickyHeader?: boolean;
-    /**
-     * Boolean to mark if a column is sortable. This will show the sorting icons. Use
-     * in conjunction with the `sortDirection` prop to determine which icon is shown.
-     */
-    isSortable?: boolean;
-    /**
-     * Callback function to execute when a sortable column's header is clicked.
-     * Column can be sorted without providing an onSort method, it means that the arrows
-     * will not be clickable, but they will still represent the sort state
-     * of a column as determined by the `sortDirection` prop.
-     */
-    onSort?: (event: EventWithColumnKey) => void;
-    /**
-     * The key of the sorted column and its sort direction.
-     */
-    sortedColumn?: {
-        dataKey: string | undefined;
-        sortDirection: 'none' | 'ascending' | 'descending' | undefined;
-    };
-    /**
-     * Will stick to either the left or right side of a table during horizontal scroll.
-     */
-    sticky?: 'left' | 'right';
-    /**
-     * Whether the text should be cut off with ellipsis if it exceeds the width of the column.
-     */
-    truncateOverflow?: boolean;
-    /**
-     * Width of the column, if using the `useFixedWidthColumns` prop is set to true.
-     */
-    width?: number;
-}
-export declare const TableHeaderCell: FC<TableHeaderCellProps>;

package/dist/components/Table/common/TableRow/TableRow.d.ts

@@ -1,67 +0,0 @@
-import { FC } from 'react';
-import { Column, EventWithColumnKey, Row } from '../../../../types';
-export interface TableRowProps {
-    /**
-     * The table columns to be rendered
-     */
-    columns: Column[];
-    /**
-     * Text alignment for all table cells. Can be superseded by passing the same prop into the `Column` object
-     * for a specific column.
-     */
-    align?: 'left' | 'right' | 'center';
-    /**
-     * Custom class to be applied to `<tr>` element.
-     */
-    className?: string;
-    /**
-     * A global placeholder for empty cells. Note: can be overwriten by
-     * the same attribute passed for an individual column config object.
-     */
-    emptyCellPlaceholder?: string | number | undefined;
-    /**
-     * Whether the table has borders or not.
-     */
-    isBorderless?: boolean;
-    /**
-     * Whether the table rows have smaller padding
-     */
-    isCompact?: boolean;
-    /**
-     * If table scrolls vertically, header will remain stuck to the top of the table, and not scroll away.
-     */
-    hasStickyHeader?: boolean;
-    /**
-     * Determine whether row is hoverable
-     */
-    isHoverable?: boolean;
-    /**
-     * Whether the row is inside the table head (thead).
-     */
-    isTableHead?: boolean;
-    /**
-     * Callback function to fire on sorting one of the table headers.
-     */
-    onSort?: (event: EventWithColumnKey) => void;
-    /**
-     * The specific row to be rendered.
-     */
-    row?: Row;
-    /**
-     * The unique key to identify a React node for each row.
-     */
-    rowIndex?: number;
-    /**
-     * The key of the sorted column and its sort direction.
-     */
-    sortedColumn?: {
-        dataKey: string | undefined;
-        sortDirection: 'none' | 'ascending' | 'descending' | undefined;
-    };
-    /**
-     * Truncate overflow inside column based on column width. Can be overwritten on specific columns,
-     * by passing `truncateOverflow` value on a specific Column
-     */
-    truncateOverflow?: boolean;
-}
-export declare const TableRow: FC<TableRowProps>;

package/dist/components/TextInput/TextInput.d.ts

@@ -1,106 +0,0 @@
-import { BoxProps } from '../Box/Box';
-import { ChangeEvent, FocusEvent, ForwardRefExoticComponent, HTMLProps, InputHTMLAttributes, KeyboardEvent, MouseEvent, ReactNode } from 'react';
-import { ResponsiveProp } from '../../types';
-export type TextInputSizeType = 'sm' | 'md' | 'lg';
-export interface TextInputProps {
-    /**
-     * The input's id attribute. Used to programmatically tie the input with its label.
-     */
-    id: string;
-    /**
-     * Custom content to be displayed above the input. If the label is hidden, will be used to set aria-label attribute.
-     */
-    label: string;
-    /**
-     * Callback function to call on change event.
-     */
-    onChange: (event: ChangeEvent<HTMLInputElement>) => void;
-    /**
-     * The text value of the input. Required since our Input is a controlled component.
-     */
-    value: InputHTMLAttributes<HTMLInputElement>['value'];
-    /**
-     * Automatically focus the input when the page is loaded.
-     */
-    autoFocus?: boolean;
-    /**
-     * Custom class to be added to standard input classes.
-     */
-    className?: string;
-    /**
-     * Mark the input field as invalid and display a validation message.
-     * Pass a string or node to render a validation message below the input.
-     */
-    error?: ReactNode;
-    /**
-     * Visually hide the label.
-     */
-    hideLabel?: boolean;
-    /**
-     * Additional clarifying text to help describe the input
-     */
-    helpText?: ReactNode;
-    /**
-     * Props passed directly to the input element of the component
-     */
-    inputProps?: BoxProps & HTMLProps<HTMLInputElement>;
-    /**
-     * The input's disabled attribute
-     */
-    isDisabled?: boolean;
-    /**
-     * The required and aria-required attributes on the input
-     */
-    isRequired?: boolean;
-    /**
-     * The input's 'maxlength' attribute.
-     * NOTE: initializing the input with a value longer than the desired maxlength will not trim this value.
-     */
-    maxLength?: number;
-    /**
-     * The input's 'name' attribute.
-     */
-    name?: string;
-    /**
-     * Callback function to call on blur event.
-     */
-    onBlur?: (event: FocusEvent<HTMLInputElement>) => void;
-    /**
-     * Callback function to call when input us cleared. When this is passed,
-     * the input will display an icon on the right side, for triggering this callback.
-     */
-    onClear?: (event: MouseEvent<HTMLButtonElement> | KeyboardEvent<HTMLButtonElement>) => void;
-    /**
-     * Callback function to call on focus event.
-     */
-    onFocus?: (event: FocusEvent<HTMLInputElement>) => void;
-    /**
-     * The input placeholder attribute.
-     */
-    placeholder?: string;
-    /**
-     * An input helper rendered before the input field value
-     */
-    prefix?: ReactNode;
-    /**
-     * Visual indicator that the field is required, that gets appended to the label
-     */
-    requiredIndicator?: ReactNode;
-    /**
-     * The size of the text input.
-     */
-    size?: TextInputSizeType | ResponsiveProp<TextInputSizeType>;
-    /**
-     * An input helper rendered after the input field value
-     */
-    suffix?: ReactNode;
-    /**
-     * The input 'type' value. Defaults to type 'text'.
-     */
-    type?: InputHTMLAttributes<HTMLInputElement>['type'];
-    /**
-     * Additional props to be spread to rendered element
-     */
-    [x: string]: any;
-}
-export declare const TextInput: ForwardRefExoticComponent<TextInputProps>;

package/dist/components/TextInput/TextInput.stories.d.ts

@@ -1,19 +0,0 @@
-import type { Meta } from '@storybook/react-vite';
-import React from 'react';
-import { TextInput } from './TextInput';
-declare const meta: Meta<typeof TextInput>;
-export default meta;
-export declare const Basic: () => React.JSX.Element;
-export declare const Examples: () => React.JSX.Element;
-export declare const Required: () => React.JSX.Element;
-export declare const CustomRequiredIndicator: () => React.JSX.Element;
-export declare const WithHelpText: () => React.JSX.Element;
-export declare const Placeholder: () => React.JSX.Element;
-export declare const Autofocus: () => React.JSX.Element;
-export declare const HiddenLabel: () => React.JSX.Element;
-export declare const Disabled: () => React.JSX.Element;
-export declare const PrefixAndSuffix: () => React.JSX.Element;
-export declare const Clearable: () => React.JSX.Element;
-export declare const Sizes: () => React.JSX.Element;
-export declare const MaxLength: () => React.JSX.Element;
-export declare const ValidationError: () => React.JSX.Element;