@ukic/canary-web-components 2.0.0-canary.4 → 2.0.0-canary.41

package/dist/collection/components/ic-data-table/ic-data-table.stories.js

@@ -0,0 +1,414 @@
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+import readme from "./readme.md";
+import { ActionElement, Basic, CellDescriptions, CellOverrides, ColumnOverrides, CustomIcons, CustomRowHeights, CustomTitleBar, DataTableSizing, Dense, DevArea, DisableSort, Embedded, Empty, EmptySlotted, ExcludeColumnsFromSort, HeaderTruncation, LargeDataSet, LinksHTMLElements, Loading, LongCellDescriptions, MissingCellData, Pagination, RowHeaders, RowOverrides, Scrollable, SelectedRowChangeEvent, SlottedElementsWithPagination, SlottedPagination, Sort, SortOptions, Spacious, TruncationShowHide, TruncationTextWrap, TruncationTooltip, TurnOffSelectedRowHighlighting, Updating, UpdatingData, } from "./story-data";
+export default {
+    title: "Web Components/Data Table",
+    component: "ic-data-table",
+    parameters: {
+        componentAPI: {
+            data: readme,
+        },
+    },
+};
+/**
+ * Use the data table component to display data in a tabular form.
+ * There are two required props for data table:
+ * - Caption: `string`
+ * - Columns: `IcDataTableColumnObject[]`
+ *
+ * Click the 'Component API' tab to view all the available props, events and slots for data tables.
+ *
+ * To use the data table component, import `@ukic/canary-web-components` into your application.
+ */
+export const BasicExample = {
+    render: () => Basic(),
+    name: "Basic",
+};
+export const LargeDataSetExample = {
+    render: () => LargeDataSet(),
+    name: "Large Data Set",
+};
+/**
+ * The `embedded` boolean adds a border around the table so it can be added as a standalone table and is not required to stretch the full width of its parent container.
+ */
+export const EmbeddedExample = {
+    render: () => Embedded(),
+    name: "Embedded",
+};
+/**
+ * The `density` variant provides three different styles for the data table:
+ * - `dense` reduces the padding and font size of the table cells to give the data a more dense style.
+ * - `default` provides a padding of `8px` which is the default spacing. This variant is seen in the first [basic](#basic) example.
+ * - `spacious` gives the data table a more spacious look and feel by increasing the vertical padding as well as the font size.
+ */
+export const DenseExample = {
+    render: () => Dense(),
+    name: "Dense",
+};
+export const SpaciousExample = {
+    render: () => Spacious(),
+    name: "Spacious",
+};
+/**
+ * When a height for the data table is set, the scroll bar will appear to the right. However, by default, the column headers will move up and out of view making it difficult to understand what the data means.
+ * This can be mitigated by using the `sticky-column-headers` prop which takes a boolean. This can be toggled within the example below.
+ */
+export const StickyColumnHeadersExample = {
+    render: () => Scrollable(),
+    name: "Sticky Column Headers",
+};
+/**
+ * By default, column header labels will wrap when they exceed the column width. To keep the column header height constant, the `columnHeaderTruncation` can be used. When set to `true`, the label will appear truncated and will display a tooltip with the full text when hovered over.
+ */
+export const ColumnHeaderTruncationExample = {
+    render: () => HeaderTruncation(),
+    name: "Column header truncation",
+};
+/**
+ * Row headers allow headings to be added to individual rows and styles them as column headings. The column collection includes an additional `header` key which aligns with the row headers. The structure of the `header` column is the same as the columns (i.e. key, title, dataType).
+ * The data array includes an additional `header` key which takes an object. The title of the row header is set by passing `title` as the key and a value.
+ */
+export const RowHeadersExample = {
+    render: () => RowHeaders(),
+    name: "Row Headers",
+};
+/**
+ * Set `sortable` to `true` to set the sort functionality on all columns. Sorting can be set to `unsorted`, `ascending` and `descending` by press the sort buttons next to the column heading.
+ */
+export const SortExample = {
+    render: () => Sort(),
+    name: "Sort",
+};
+/**
+ * It is possible to change the sort options for the sort buttons. The `sortOptions` prop takes an object with `sortOrders` and `defaultColumn`. `sortOrders` allows the sort order to be amended as we all as remove a sort type. Such as changing the order to `descending`, `unsorted` and remove `ascending`. `defaultColumn` sets which column is ordered by default. This is set by padding the column key as the `defaultColumn` value.
+ */
+export const SortOptionsExample = {
+    render: () => SortOptions(),
+    name: "Sort Options",
+};
+/**
+ * Set `sortable` to `true` and set `disable-auto-sort` to `true` to enable external sorting functionality.
+ */
+export const DisableSortExample = {
+    render: () => DisableSort(),
+    name: "Disable sort",
+};
+/**
+ * Adding `excludeColumnFromSort: true` to the column object excludes that column from displaying the sort button.
+ */
+export const ExcludeColumnsFromSortExample = {
+    render: () => ExcludeColumnsFromSort(),
+    name: "Exclude columns from sort",
+};
+/**
+ * Pagination allows large data sets to be split into pages in order to make the data easier to digest. Setting `show-pagination` to `true` will add the `ic-pagination` component to the bottom of the table. There a several sub components within pagination which are set via the `paginationBarOptions` prop:
+ * - `itemsPerPage` allows customization on the number of items on each page. This requires a collection with `label` and `value` key pairs.
+ * - `showItemsPerPageControl` shows or hides the `itemsPerPage` component using `true` or `false`.
+ * - `showGoToPageControl` displays controls which allows jumping between pages in a non-linear approach.
+ */
+export const PaginationExample = {
+    render: () => Pagination(),
+    name: "Pagination",
+};
+/**
+ * There may be a requirement to style a column differently to the rest of the data to add emphasis. For example, centre align data within the 'first name' column. To do this, add `columnAlignment` to the column. `columnAlignment` takes an object which sets the `horizontal` and `vertical` property:
+ * - `horizontal` accepts `left`, `right` or `center`.
+ * - `vertical` accepts `top`, `middle`, `bottom`.
+ *
+ * `emphasis` can be added to the column by setting `high` or `low`.
+ */
+export const ColumnOverridesExample = {
+    render: () => ColumnOverrides(),
+    name: "Column Overrides",
+};
+/**
+ * Row overrides allow styling to be applied at a row level and is set within the `header` object. The row overrides are used in conjunction with row headers. The following row overrides options apply:
+ * - `rowAlignment` accepts `left`, `right` and `center`.
+ * - `emphasis` accepts `high` or `low`.
+ */
+export const RowOverridesExample = {
+    render: () => RowOverrides(),
+    name: "Row Overrides",
+};
+/**
+ * Cell overrides allows styling to be applied at a cell level. The cell which requires an override accepts an object which requires `data` and can contain `cellAlignment` and/or `emphasis`:
+ * - `data` is the cell value.
+ * - `cellAlignment` accepts an object with the following key pairs:
+ * - `horizontal` accepts `left`, `right` or `center`.
+ * - `vertical` accepts `top`, `middle`, `bottom`.
+ * - `emphasis` accepts `high` or `low`.
+ */
+export const CellOverridesExample = {
+    render: () => CellOverrides(),
+    name: "Cell Overrides",
+};
+/**
+ * When the table receives no data (either `null` or an empty array) it will automatically show an `ic-empty-state` below the headers.
+ */
+export const DefaultEmptyStateExample = {
+    render: () => Empty(),
+    name: "Default Empty State",
+};
+/**
+ * You can customise your own `ic-empty-state` component and slot it into the data table using the `empty-state` slot, to reflect different scenarios.
+ */
+export const SlottedEmptyStateExample = {
+    render: () => EmptySlotted(),
+    name: "Slotted Empty State",
+};
+/**
+ * When a user wants to fetch their data asynchronously, a `loading` prop can be set to `true`, which then renders a circular variant of the `ic-loading-indicator`.
+ * The loading indicator can be customised using the `loadingOptions` prop:
+ * - `appearance` can be `light` or `dark`
+ * - `description` sets the aria-label of the component
+ * - `label` sets the visual message
+ * - `labelDuration` is the number of milliseconds before the label changes
+ * - `showBackground` allows for a white background and grey border to help the indicator stand out
+ * - `overlay` renders a dark overlay over the previous data set while new data is loaded (This also sets `showBackground` to `true` so the loading indicator stands out against the dark overlay.)
+ *
+ * If it needs to be determinate, use `max`, `min` and `progress`.
+ */
+export const LoadingStateExample = {
+    render: () => Loading(),
+    name: "Loading State",
+    height: "360px",
+};
+/**
+ * If data in the table has changed, an `updating` prop has been supplied to show a linear `ic-loading-indicator` just above the data rows.
+ *
+ * This prop is also accompanied by an `updatingOptions` prop, which contains similar options to `loadingOptions`, minus `label` and `labelDuration` since the linear version is displayed.
+ */
+export const UpdatingStateExample = {
+    render: () => Updating(),
+    name: "Updating State",
+};
+/**
+ * Custom HTML elements can be slotted or passed via the `data` prop to display in certain cells. When using the slotted method, the slot name follows the format of `{COLUMN_TAG}-{ROW_INDEX}`.
+ */
+export const LinksAndElementsInDataExample = {
+    render: () => LinksHTMLElements(),
+    name: "Links and Elements in data",
+};
+export const SlottedElementsWithPaginationExample = {
+    render: () => SlottedElementsWithPagination(),
+    name: "Slotted elements with pagination",
+};
+/**
+ * Custom icons can be added to cells, columns and headers in the data table. To add it to headers, set the icon via the `columns` prop:
+ * ```
+ * icon: {
+ *  icon: //ICON_STRING_GOES_HERE,
+ *  onAllCells: //Boolean to determine whether column header icon should be replicated on all cells in the column,
+ *  hideOnHeader: //Boolean for whether this icon should only be shown on cells and not on the header,
+ * }
+ * ```
+ * To add icons to individual cells, they can be added through the `data` prop, in a similar method to overriding the cell. Cell icons take priority over the `onAllCells` prop, meaning specific cells can be made to stand out.
+ *
+ * Both cells and headers can also have icons slotted in. Cells use the slot format: `{COLUMN_KEY}-{ROW_INDEX}-icon`, and headers use the format: `{COLUMN_KEY}-column-icon`. Slotted icons take priority over icons inserted via the `columns` and `data` props.
+ */
+export const CustomIconsExample = {
+    render: () => CustomIcons(),
+    name: "Custom Icons",
+};
+/**
+ * A data table can have its rows use custom heights, to help display more data per row. This involves using the `globalRowHeight` prop, which applies this custom height to all rows.
+ *
+ * For a more granular approach, `variableRowHeight` exists. This is passed through the data object for each row of data, as well as that row's `index`. Using these properties, you can write a custom function that will return a number for that row's height based on your criteria.
+ * Returning `null` from this function means that the row will use the `globalRowHeight` property value.
+ *
+ * **_NOTE:_** If the data table uses the `density` prop, then your custom value will be scaled depending on the density, in order to keep content readable as the text size changes:
+ * - `Dense` = 80% of `globalRowHeight` or `variableRowHeight`
+ * - `Spacious` = 120% of `globalRowHeight` or `variableRowHeight`
+ *
+ * E.G: If `globalRowHeight` = 100, a dense table will set the height to be **_80_**.
+ *
+ * **_NOTE:_** If a cell has a description (see "Description and icons within cells"), then the row height for that individual row will be increased by the description height in order to fully display it.
+ *
+ * E.G: If `globalRowHeight` = 100 and a cell has a description with a height of 20, then the row height for that cell's row will be set to **_120_**.
+ *
+ * To quickly reset all row heights to the default, you can run the `resetRowHeights` method.
+ *
+ * If you'd rather let the row calculate its own height based on its content, either set `globalRowHeight` to `auto`, or return `auto` from `variableRowHeight`.
+ */
+export const CustomRowHeightsExample = {
+    render: () => CustomRowHeights(),
+    name: "Custom Row Heights",
+};
+/**
+ * To add additional information about the data held in your data table, you can use the `title-bar` slot to add an `ic-data-table-title-bar`, which will appear above the column headers.
+ *
+ * The title bar can have a description and metadata added, to provide supporting information to display some context about the data to the user. Primary and custom action slots also exist to allow for actions to be performed that are related to the data, which can be prominently displayed.
+ *
+ * The `ic-data-table-title-bar` has a built-in density selector, which allows a user to quickly change the size and padding of cells to make it more readable. This can also be hidden if preferred.
+ *
+ * More details on `ic-data-table-title-bar` can be found in the <ic-link href="/?path=/story/web-components-data-table-title-bar--docs" inline="">data table title bar documentation</ic-link>.
+ */
+export const CustomTitleBarExample = {
+    render: () => CustomTitleBar(),
+    name: "Custom Title Bar",
+};
+/**
+ * The example below demonstrates how the pagination bar responds to changes within the data.
+ *
+ * More details on `ic-pagination-bar` can be found in the <ic-link href="/?path=/story/web-components-pagination-bar--docs" inline="">pagination bar documentation</ic-link>.
+ */
+export const UpdatingDataExample = {
+    render: () => UpdatingData(),
+    name: "Updating data",
+};
+/**
+ * There may be scenarios when using `ic-data-table` when pagination and data fetching is done using a backend API.
+ *
+ * To enable this behaviour, the `pagination-bar` slot can be utilised to provide a custom `ic-pagination-bar` component, allowing the user to have more control over how their data is displayed & interacted with.
+ */
+export const SlottedPaginationBarExample = {
+    render: () => SlottedPagination(),
+    name: "Slotted pagination bar",
+};
+/**
+ * When a row is given a set height, and has content that no longer fits into the cell area, the content becomes truncated. There are two types of truncation:
+ * - `tooltip`: Adds a line-clamp to the cell and displays the message in a tooltip.
+ * - `show-hide`: Adds a `See more/See less` button underneath the cell text, allowing the user to display the full content should they wish.
+ *
+ * These values are set using the `truncation-pattern` attribute.
+ *
+ * By default, `global-row-height` is set to `auto`. If the `truncation-pattern` attribute is set to `tooltip` or `show-hide` while `global-row-height` is `auto`, the data will not appear truncated due to the row height being set to the data which has the most height.
+ * To see the data truncated, the `global-row-height` or `variable-row-height` needs to be explicitly set to a height which is shorter than data which has the most lines.
+ *
+ * **_NOTE:_** `truncation-pattern` only applies to a cell's main data value. If a cell has a description (see "Description and icons within cells") then this will not be truncated and will still be visible beyond the truncation.
+ */
+export const DataTruncationTooltipExample = {
+    render: () => TruncationTooltip(),
+    name: "Data truncation tooltip",
+};
+export const DataTruncationSeeMoreSeeLessExample = {
+    render: () => TruncationShowHide(),
+    name: "Data truncation see more / see less",
+};
+/**
+ * Text can be set to wrap in a particular column, row or cell. Any column, row or cell that text wrap is applied to will ignore the custom height if the custom height is too small and the full content will be shown.
+ *
+ * To set text to wrap in a column, add `textWrap: true` as a key value:
+ * ```
+ * const column = [
+ *  { key: "name", title: "Name", dataType: "string" },
+ *  ...
+ * ]
+ * ```
+ *
+ * To set text to wrap in a row, add `rowOptions: { textWrap: true }` to an object within the data array:
+ * ```
+ * const data = [
+ *  {
+ *    name: "Tim Rayes",
+ *    age: 41,
+ *    department: "Sales and Marketing",
+ *    employeeNumber: 3,
+ *    jobTitle:
+ *      "Regional Sales and Marketing Strategy Director (Europe, the Middle East, and Africa)",
+ *    rowOptions: {
+ *      textWrap: true
+ *    }
+ *  },
+ *  ...
+ * ]
+ * ```
+ *
+ * To set text wrap in a cell, add `textWrap` to a data key within an object:
+ * ```
+ * const data = [
+ *  {
+ *    name: {
+ *      data:"Tim Rayes",
+ *      textWrap: true
+ *    }
+ *    age: 41,
+ *    department: "Sales and Marketing",
+ *    employeeNumber: 3,
+ *    jobTitle:
+ *      "Regional Sales and Marketing Strategy Director (Europe, the Middle East, and Africa)",
+ *  },
+ *  ...
+ * ]
+ * ```
+ */
+export const TextWrapExample = {
+    render: () => TruncationTextWrap(),
+    name: "Text Wrap",
+};
+/**
+ * The dimensions of the data table can be set using the `width` and `height` attributes. The attribute accepts dimensions in `px`, `%`, `rem` and `auto`.
+ * By default, the width is set to `100%` so the table spans across the viewport or parent container.
+ *
+ * To set the column widths, the `columnWidth` property should be added to the relevant column within the column array.
+ *
+ * The [table layout](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout) attribute is vital to how the table resizing and column widths behave. By default, the table layout is set to `fixed`. If no column width is set, the columns widths will be equally set within the viewport or parent container.
+ * A table with a `fixed` layout will force the table column widths to take precedence over the data with the table cells.
+ * For the column widths to be dictated by the content inside, set the `table-layout` attribute to `auto` and set the table `width` to `auto`.
+ * To set the min and max width of a table cell, set the `table-layout` attribute to `auto` and set a `minWidth` or `maxWidth` value into `columnWidth`. The min and max width accepts dimensions in `px`, `%`, `rem`.
+ */
+export const TableSizingAndColumnWidthExample = {
+    render: () => DataTableSizing(),
+    name: "Table sizing and column width",
+};
+/**
+ * The cell data can contain an `actionElement` which can be a string containing any html to be rendered. The `actionElement` will be displayed to the right of the cell data. An `actionOnClick` can be specified for the `actionElement`. This should be used with a keyboard accessible component such as `icButton` for a function to be run when the `actionElement` is clicked.
+ */
+export const ActionElementExample = {
+    render: () => ActionElement(),
+    name: "Action Element",
+};
+/**
+ * Descriptions and icons can be included in the cells by proving a `description` field in the data. This will populate the cell with an icon (if provided) and a text string underneath the cell data. This can be applied to any cell.
+ * You can provide a `description` object with or without an icon:
+ *
+ * With an icon
+ * ```
+ * firstName: {
+ *  data: "Joe",
+ *  description: {
+ *    data: "The name of Joe",
+ *    icon: '<svg xmlns="http://www.w3.org/2000/svg" height="20" viewBox="0 -960 960 960" width="20"><path d="M180-120q-24 0-42-18t-18-42v-600q0-24 18-42t42-18h600q24 0 42 18t18 42v600q0 24-18 42t-42 18H180Zm0-60h600v-600H180v600Zm56-97h489L578-473 446-302l-93-127-117 152Zm-56 97v-600 600Z"/></svg>',
+ *  },
+ * }
+ * ```
+ *
+ * Without an icon
+ * ```
+ * firstName: {
+ *  data: "Joe",
+ *  description: "The name of Joe"
+ * }
+ * ```
+ */
+export const DescriptionAndIconsWithinCellsExample = {
+    render: () => CellDescriptions(),
+    name: "Description and icons within cells",
+};
+export const DescriptionAndIconsWithinCellsWithLongTextExample = {
+    render: () => LongCellDescriptions(),
+    name: "Description and icons within cells with long text",
+};
+/**
+ * The example below demonstrates the table being able to handle empty cell values (null, undefined or empty string).
+ */
+export const MissingCellDataExample = {
+    render: () => MissingCellData(),
+    name: "Missing cell data",
+};
+/**
+ * The example below demonstrates the table being configured to not highlight the selected row.
+ */
+export const TurnOffSelectedRowHighlightingExample = {
+    render: () => TurnOffSelectedRowHighlighting(),
+    name: "Turn off selected row highlighting",
+};
+export const SelectedRowChangeEventExample = {
+    render: () => SelectedRowChangeEvent(),
+    name: "Selected row change event",
+};
+export const DevAreaExample = {
+    render: () => DevArea(),
+    name: "Dev Area",
+};
+//# sourceMappingURL=ic-data-table.stories.js.map

package/dist/collection/components/ic-data-table/ic-data-table.stories.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ic-data-table.stories.js","sourceRoot":"","sources":["../../../src/components/ic-data-table/ic-data-table.stories.js"],"names":[],"mappings":"AAAA,sEAAsE;AACtE,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EACL,aAAa,EACb,KAAK,EACL,gBAAgB,EAChB,aAAa,EACb,eAAe,EACf,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,eAAe,EACf,KAAK,EACL,OAAO,EACP,WAAW,EACX,QAAQ,EACR,KAAK,EACL,YAAY,EACZ,sBAAsB,EACtB,gBAAgB,EAChB,YAAY,EACZ,iBAAiB,EACjB,OAAO,EACP,oBAAoB,EACpB,eAAe,EACf,UAAU,EACV,UAAU,EACV,YAAY,EACZ,UAAU,EACV,sBAAsB,EACtB,6BAA6B,EAC7B,iBAAiB,EACjB,IAAI,EACJ,WAAW,EACX,QAAQ,EACR,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,8BAA8B,EAC9B,QAAQ,EACR,YAAY,GACb,MAAM,cAAc,CAAC;AAEtB,eAAe;IACb,KAAK,EAAE,2BAA2B;IAClC,SAAS,EAAE,eAAe;IAE1B,UAAU,EAAE;QACV,YAAY,EAAE;YACZ,IAAI,EAAE,MAAM;SACb;KACF;CACF,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK,EAAE;IACrB,IAAI,EAAE,OAAO;CACd,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,MAAM,EAAE,GAAG,EAAE,CAAC,YAAY,EAAE;IAC5B,IAAI,EAAE,gBAAgB;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,MAAM,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE;IACxB,IAAI,EAAE,UAAU;CACjB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK,EAAE;IACrB,IAAI,EAAE,OAAO;CACd,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,MAAM,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE;IACxB,IAAI,EAAE,UAAU;CACjB,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,MAAM,EAAE,GAAG,EAAE,CAAC,UAAU,EAAE;IAC1B,IAAI,EAAE,uBAAuB;CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG;IAC3C,MAAM,EAAE,GAAG,EAAE,CAAC,gBAAgB,EAAE;IAChC,IAAI,EAAE,0BAA0B;CACjC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,MAAM,EAAE,GAAG,EAAE,CAAC,UAAU,EAAE;IAC1B,IAAI,EAAE,aAAa;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE;IACpB,IAAI,EAAE,MAAM;CACb,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,MAAM,EAAE,GAAG,EAAE,CAAC,WAAW,EAAE;IAC3B,IAAI,EAAE,cAAc;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,MAAM,EAAE,GAAG,EAAE,CAAC,WAAW,EAAE;IAC3B,IAAI,EAAE,cAAc;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG;IAC3C,MAAM,EAAE,GAAG,EAAE,CAAC,sBAAsB,EAAE;IACtC,IAAI,EAAE,2BAA2B;CAClC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,MAAM,EAAE,GAAG,EAAE,CAAC,UAAU,EAAE;IAC1B,IAAI,EAAE,YAAY;CACnB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,MAAM,EAAE,GAAG,EAAE,CAAC,eAAe,EAAE;IAC/B,IAAI,EAAE,kBAAkB;CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,MAAM,EAAE,GAAG,EAAE,CAAC,YAAY,EAAE;IAC5B,IAAI,EAAE,eAAe;CACtB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,MAAM,EAAE,GAAG,EAAE,CAAC,aAAa,EAAE;IAC7B,IAAI,EAAE,gBAAgB;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACtC,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK,EAAE;IACrB,IAAI,EAAE,qBAAqB;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACtC,MAAM,EAAE,GAAG,EAAE,CAAC,YAAY,EAAE;IAC5B,IAAI,EAAE,qBAAqB;CAC5B,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE;IACvB,IAAI,EAAE,eAAe;IACrB,MAAM,EAAE,OAAO;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,MAAM,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE;IACxB,IAAI,EAAE,gBAAgB;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG;IAC3C,MAAM,EAAE,GAAG,EAAE,CAAC,iBAAiB,EAAE;IACjC,IAAI,EAAE,4BAA4B;CACnC,CAAC;AAEF,MAAM,CAAC,MAAM,oCAAoC,GAAG;IAClD,MAAM,EAAE,GAAG,EAAE,CAAC,6BAA6B,EAAE;IAC7C,IAAI,EAAE,kCAAkC;CACzC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,MAAM,EAAE,GAAG,EAAE,CAAC,WAAW,EAAE;IAC3B,IAAI,EAAE,cAAc;CACrB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,MAAM,EAAE,GAAG,EAAE,CAAC,gBAAgB,EAAE;IAChC,IAAI,EAAE,oBAAoB;CAC3B,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,MAAM,EAAE,GAAG,EAAE,CAAC,cAAc,EAAE;IAC9B,IAAI,EAAE,kBAAkB;CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,MAAM,EAAE,GAAG,EAAE,CAAC,YAAY,EAAE;IAC5B,IAAI,EAAE,eAAe;CACtB,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG;IACzC,MAAM,EAAE,GAAG,EAAE,CAAC,iBAAiB,EAAE;IACjC,IAAI,EAAE,wBAAwB;CAC/B,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG;IAC1C,MAAM,EAAE,GAAG,EAAE,CAAC,iBAAiB,EAAE;IACjC,IAAI,EAAE,yBAAyB;CAChC,CAAC;AAEF,MAAM,CAAC,MAAM,mCAAmC,GAAG;IACjD,MAAM,EAAE,GAAG,EAAE,CAAC,kBAAkB,EAAE;IAClC,IAAI,EAAE,qCAAqC;CAC5C,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,MAAM,EAAE,GAAG,EAAE,CAAC,kBAAkB,EAAE;IAClC,IAAI,EAAE,WAAW;CAClB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG;IAC9C,MAAM,EAAE,GAAG,EAAE,CAAC,eAAe,EAAE;IAC/B,IAAI,EAAE,+BAA+B;CACtC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,MAAM,EAAE,GAAG,EAAE,CAAC,aAAa,EAAE;IAC7B,IAAI,EAAE,gBAAgB;CACvB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,MAAM,qCAAqC,GAAG;IACnD,MAAM,EAAE,GAAG,EAAE,CAAC,gBAAgB,EAAE;IAChC,IAAI,EAAE,oCAAoC;CAC3C,CAAC;AAEF,MAAM,CAAC,MAAM,iDAAiD,GAAG;IAC/D,MAAM,EAAE,GAAG,EAAE,CAAC,oBAAoB,EAAE;IACpC,IAAI,EAAE,mDAAmD;CAC1D,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,MAAM,EAAE,GAAG,EAAE,CAAC,eAAe,EAAE;IAC/B,IAAI,EAAE,mBAAmB;CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,qCAAqC,GAAG;IACnD,MAAM,EAAE,GAAG,EAAE,CAAC,8BAA8B,EAAE;IAC9C,IAAI,EAAE,oCAAoC;CAC3C,CAAC;AAEF,MAAM,CAAC,MAAM,6BAA6B,GAAG;IAC3C,MAAM,EAAE,GAAG,EAAE,CAAC,sBAAsB,EAAE;IACtC,IAAI,EAAE,2BAA2B;CAClC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE;IACvB,IAAI,EAAE,UAAU;CACjB,CAAC","sourcesContent":["/* eslint-disable @typescript-eslint/explicit-module-boundary-types */\nimport readme from \"./readme.md\";\nimport {\n  ActionElement,\n  Basic,\n  CellDescriptions,\n  CellOverrides,\n  ColumnOverrides,\n  CustomIcons,\n  CustomRowHeights,\n  CustomTitleBar,\n  DataTableSizing,\n  Dense,\n  DevArea,\n  DisableSort,\n  Embedded,\n  Empty,\n  EmptySlotted,\n  ExcludeColumnsFromSort,\n  HeaderTruncation,\n  LargeDataSet,\n  LinksHTMLElements,\n  Loading,\n  LongCellDescriptions,\n  MissingCellData,\n  Pagination,\n  RowHeaders,\n  RowOverrides,\n  Scrollable,\n  SelectedRowChangeEvent,\n  SlottedElementsWithPagination,\n  SlottedPagination,\n  Sort,\n  SortOptions,\n  Spacious,\n  TruncationShowHide,\n  TruncationTextWrap,\n  TruncationTooltip,\n  TurnOffSelectedRowHighlighting,\n  Updating,\n  UpdatingData,\n} from \"./story-data\";\n\nexport default {\n  title: \"Web Components/Data Table\",\n  component: \"ic-data-table\",\n\n  parameters: {\n    componentAPI: {\n      data: readme,\n    },\n  },\n};\n\n/**\n * Use the data table component to display data in a tabular form.\n * There are two required props for data table:\n * - Caption: `string`\n * - Columns: `IcDataTableColumnObject[]`\n *\n * Click the 'Component API' tab to view all the available props, events and slots for data tables.\n *\n * To use the data table component, import `@ukic/canary-web-components` into your application.\n */\nexport const BasicExample = {\n  render: () => Basic(),\n  name: \"Basic\",\n};\n\nexport const LargeDataSetExample = {\n  render: () => LargeDataSet(),\n  name: \"Large Data Set\",\n};\n\n/**\n * The `embedded` boolean adds a border around the table so it can be added as a standalone table and is not required to stretch the full width of its parent container.\n */\nexport const EmbeddedExample = {\n  render: () => Embedded(),\n  name: \"Embedded\",\n};\n\n/**\n * The `density` variant provides three different styles for the data table:\n * - `dense` reduces the padding and font size of the table cells to give the data a more dense style.\n * - `default` provides a padding of `8px` which is the default spacing. This variant is seen in the first [basic](#basic) example.\n * - `spacious` gives the data table a more spacious look and feel by increasing the vertical padding as well as the font size.\n */\nexport const DenseExample = {\n  render: () => Dense(),\n  name: \"Dense\",\n};\n\nexport const SpaciousExample = {\n  render: () => Spacious(),\n  name: \"Spacious\",\n};\n\n/**\n * When a height for the data table is set, the scroll bar will appear to the right. However, by default, the column headers will move up and out of view making it difficult to understand what the data means.\n * This can be mitigated by using the `sticky-column-headers` prop which takes a boolean. This can be toggled within the example below.\n */\nexport const StickyColumnHeadersExample = {\n  render: () => Scrollable(),\n  name: \"Sticky Column Headers\",\n};\n\n/**\n * By default, column header labels will wrap when they exceed the column width. To keep the column header height constant, the `columnHeaderTruncation` can be used. When set to `true`, the label will appear truncated and will display a tooltip with the full text when hovered over.\n */\nexport const ColumnHeaderTruncationExample = {\n  render: () => HeaderTruncation(),\n  name: \"Column header truncation\",\n};\n\n/**\n * Row headers allow headings to be added to individual rows and styles them as column headings. The column collection includes an additional `header` key which aligns with the row headers. The structure of the `header` column is the same as the columns (i.e. key, title, dataType).\n * The data array includes an additional `header` key which takes an object. The title of the row header is set by passing `title` as the key and a value.\n */\nexport const RowHeadersExample = {\n  render: () => RowHeaders(),\n  name: \"Row Headers\",\n};\n\n/**\n * Set `sortable` to `true` to set the sort functionality on all columns. Sorting can be set to `unsorted`, `ascending` and `descending` by press the sort buttons next to the column heading.\n */\nexport const SortExample = {\n  render: () => Sort(),\n  name: \"Sort\",\n};\n\n/**\n * It is possible to change the sort options for the sort buttons. The `sortOptions` prop takes an object with `sortOrders` and `defaultColumn`. `sortOrders` allows the sort order to be amended as we all as remove a sort type. Such as changing the order to `descending`, `unsorted` and remove `ascending`. `defaultColumn` sets which column is ordered by default. This is set by padding the column key as the `defaultColumn` value.\n */\nexport const SortOptionsExample = {\n  render: () => SortOptions(),\n  name: \"Sort Options\",\n};\n\n/**\n * Set `sortable` to `true` and set `disable-auto-sort` to `true` to enable external sorting functionality.\n */\nexport const DisableSortExample = {\n  render: () => DisableSort(),\n  name: \"Disable sort\",\n};\n\n/**\n * Adding `excludeColumnFromSort: true` to the column object excludes that column from displaying the sort button.\n */\nexport const ExcludeColumnsFromSortExample = {\n  render: () => ExcludeColumnsFromSort(),\n  name: \"Exclude columns from sort\",\n};\n\n/**\n * Pagination allows large data sets to be split into pages in order to make the data easier to digest. Setting `show-pagination` to `true` will add the `ic-pagination` component to the bottom of the table. There a several sub components within pagination which are set via the `paginationBarOptions` prop:\n * - `itemsPerPage` allows customization on the number of items on each page. This requires a collection with `label` and `value` key pairs.\n * - `showItemsPerPageControl` shows or hides the `itemsPerPage` component using `true` or `false`.\n * - `showGoToPageControl` displays controls which allows jumping between pages in a non-linear approach.\n */\nexport const PaginationExample = {\n  render: () => Pagination(),\n  name: \"Pagination\",\n};\n\n/**\n * There may be a requirement to style a column differently to the rest of the data to add emphasis. For example, centre align data within the 'first name' column. To do this, add `columnAlignment` to the column. `columnAlignment` takes an object which sets the `horizontal` and `vertical` property:\n * - `horizontal` accepts `left`, `right` or `center`.\n * - `vertical` accepts `top`, `middle`, `bottom`.\n *\n * `emphasis` can be added to the column by setting `high` or `low`.\n */\nexport const ColumnOverridesExample = {\n  render: () => ColumnOverrides(),\n  name: \"Column Overrides\",\n};\n\n/**\n * Row overrides allow styling to be applied at a row level and is set within the `header` object. The row overrides are used in conjunction with row headers. The following row overrides options apply:\n * - `rowAlignment` accepts `left`, `right` and `center`.\n * - `emphasis` accepts `high` or `low`.\n */\nexport const RowOverridesExample = {\n  render: () => RowOverrides(),\n  name: \"Row Overrides\",\n};\n\n/**\n * Cell overrides allows styling to be applied at a cell level. The cell which requires an override accepts an object which requires `data` and can contain `cellAlignment` and/or `emphasis`:\n * - `data` is the cell value.\n * - `cellAlignment` accepts an object with the following key pairs:\n * - `horizontal` accepts `left`, `right` or `center`.\n * - `vertical` accepts `top`, `middle`, `bottom`.\n * - `emphasis` accepts `high` or `low`.\n */\nexport const CellOverridesExample = {\n  render: () => CellOverrides(),\n  name: \"Cell Overrides\",\n};\n\n/**\n * When the table receives no data (either `null` or an empty array) it will automatically show an `ic-empty-state` below the headers.\n */\nexport const DefaultEmptyStateExample = {\n  render: () => Empty(),\n  name: \"Default Empty State\",\n};\n\n/**\n * You can customise your own `ic-empty-state` component and slot it into the data table using the `empty-state` slot, to reflect different scenarios.\n */\nexport const SlottedEmptyStateExample = {\n  render: () => EmptySlotted(),\n  name: \"Slotted Empty State\",\n};\n\n/**\n * When a user wants to fetch their data asynchronously, a `loading` prop can be set to `true`, which then renders a circular variant of the `ic-loading-indicator`.\n * The loading indicator can be customised using the `loadingOptions` prop:\n * - `appearance` can be `light` or `dark`\n * - `description` sets the aria-label of the component\n * - `label` sets the visual message\n * - `labelDuration` is the number of milliseconds before the label changes\n * - `showBackground` allows for a white background and grey border to help the indicator stand out\n * - `overlay` renders a dark overlay over the previous data set while new data is loaded (This also sets `showBackground` to `true` so the loading indicator stands out against the dark overlay.)\n *\n * If it needs to be determinate, use `max`, `min` and `progress`.\n */\nexport const LoadingStateExample = {\n  render: () => Loading(),\n  name: \"Loading State\",\n  height: \"360px\",\n};\n\n/**\n * If data in the table has changed, an `updating` prop has been supplied to show a linear `ic-loading-indicator` just above the data rows.\n *\n * This prop is also accompanied by an `updatingOptions` prop, which contains similar options to `loadingOptions`, minus `label` and `labelDuration` since the linear version is displayed.\n */\nexport const UpdatingStateExample = {\n  render: () => Updating(),\n  name: \"Updating State\",\n};\n\n/**\n * Custom HTML elements can be slotted or passed via the `data` prop to display in certain cells. When using the slotted method, the slot name follows the format of `{COLUMN_TAG}-{ROW_INDEX}`.\n */\nexport const LinksAndElementsInDataExample = {\n  render: () => LinksHTMLElements(),\n  name: \"Links and Elements in data\",\n};\n\nexport const SlottedElementsWithPaginationExample = {\n  render: () => SlottedElementsWithPagination(),\n  name: \"Slotted elements with pagination\",\n};\n\n/**\n * Custom icons can be added to cells, columns and headers in the data table. To add it to headers, set the icon via the `columns` prop:\n * ```\n * icon: {\n *  icon: //ICON_STRING_GOES_HERE,\n *  onAllCells: //Boolean to determine whether column header icon should be replicated on all cells in the column,\n *  hideOnHeader: //Boolean for whether this icon should only be shown on cells and not on the header,\n * }\n * ```\n * To add icons to individual cells, they can be added through the `data` prop, in a similar method to overriding the cell. Cell icons take priority over the `onAllCells` prop, meaning specific cells can be made to stand out.\n *\n * Both cells and headers can also have icons slotted in. Cells use the slot format: `{COLUMN_KEY}-{ROW_INDEX}-icon`, and headers use the format: `{COLUMN_KEY}-column-icon`. Slotted icons take priority over icons inserted via the `columns` and `data` props.\n */\nexport const CustomIconsExample = {\n  render: () => CustomIcons(),\n  name: \"Custom Icons\",\n};\n\n/**\n * A data table can have its rows use custom heights, to help display more data per row. This involves using the `globalRowHeight` prop, which applies this custom height to all rows.\n *\n * For a more granular approach, `variableRowHeight` exists. This is passed through the data object for each row of data, as well as that row's `index`. Using these properties, you can write a custom function that will return a number for that row's height based on your criteria.\n * Returning `null` from this function means that the row will use the `globalRowHeight` property value.\n *\n * **_NOTE:_** If the data table uses the `density` prop, then your custom value will be scaled depending on the density, in order to keep content readable as the text size changes:\n * - `Dense` = 80% of `globalRowHeight` or `variableRowHeight`\n * - `Spacious` = 120% of `globalRowHeight` or `variableRowHeight`\n *\n * E.G: If `globalRowHeight` = 100, a dense table will set the height to be **_80_**.\n *\n * **_NOTE:_** If a cell has a description (see \"Description and icons within cells\"), then the row height for that individual row will be increased by the description height in order to fully display it.\n *\n * E.G: If `globalRowHeight` = 100 and a cell has a description with a height of 20, then the row height for that cell's row will be set to **_120_**.\n *\n * To quickly reset all row heights to the default, you can run the `resetRowHeights` method.\n *\n * If you'd rather let the row calculate its own height based on its content, either set `globalRowHeight` to `auto`, or return `auto` from `variableRowHeight`.\n */\nexport const CustomRowHeightsExample = {\n  render: () => CustomRowHeights(),\n  name: \"Custom Row Heights\",\n};\n\n/**\n * To add additional information about the data held in your data table, you can use the `title-bar` slot to add an `ic-data-table-title-bar`, which will appear above the column headers.\n *\n * The title bar can have a description and metadata added, to provide supporting information to display some context about the data to the user. Primary and custom action slots also exist to allow for actions to be performed that are related to the data, which can be prominently displayed.\n *\n * The `ic-data-table-title-bar` has a built-in density selector, which allows a user to quickly change the size and padding of cells to make it more readable. This can also be hidden if preferred.\n *\n * More details on `ic-data-table-title-bar` can be found in the <ic-link href=\"/?path=/story/web-components-data-table-title-bar--docs\" inline=\"\">data table title bar documentation</ic-link>.\n */\nexport const CustomTitleBarExample = {\n  render: () => CustomTitleBar(),\n  name: \"Custom Title Bar\",\n};\n\n/**\n * The example below demonstrates how the pagination bar responds to changes within the data.\n *\n * More details on `ic-pagination-bar` can be found in the <ic-link href=\"/?path=/story/web-components-pagination-bar--docs\" inline=\"\">pagination bar documentation</ic-link>.\n */\nexport const UpdatingDataExample = {\n  render: () => UpdatingData(),\n  name: \"Updating data\",\n};\n\n/**\n * There may be scenarios when using `ic-data-table` when pagination and data fetching is done using a backend API.\n *\n * To enable this behaviour, the `pagination-bar` slot can be utilised to provide a custom `ic-pagination-bar` component, allowing the user to have more control over how their data is displayed & interacted with.\n */\nexport const SlottedPaginationBarExample = {\n  render: () => SlottedPagination(),\n  name: \"Slotted pagination bar\",\n};\n\n/**\n * When a row is given a set height, and has content that no longer fits into the cell area, the content becomes truncated. There are two types of truncation:\n * - `tooltip`: Adds a line-clamp to the cell and displays the message in a tooltip.\n * - `show-hide`: Adds a `See more/See less` button underneath the cell text, allowing the user to display the full content should they wish.\n *\n * These values are set using the `truncation-pattern` attribute.\n *\n * By default, `global-row-height` is set to `auto`. If the `truncation-pattern` attribute is set to `tooltip` or `show-hide` while `global-row-height` is `auto`, the data will not appear truncated due to the row height being set to the data which has the most height.\n * To see the data truncated, the `global-row-height` or `variable-row-height` needs to be explicitly set to a height which is shorter than data which has the most lines.\n *\n * **_NOTE:_** `truncation-pattern` only applies to a cell's main data value. If a cell has a description (see \"Description and icons within cells\") then this will not be truncated and will still be visible beyond the truncation.\n */\nexport const DataTruncationTooltipExample = {\n  render: () => TruncationTooltip(),\n  name: \"Data truncation tooltip\",\n};\n\nexport const DataTruncationSeeMoreSeeLessExample = {\n  render: () => TruncationShowHide(),\n  name: \"Data truncation see more / see less\",\n};\n\n/**\n * Text can be set to wrap in a particular column, row or cell. Any column, row or cell that text wrap is applied to will ignore the custom height if the custom height is too small and the full content will be shown.\n *\n * To set text to wrap in a column, add `textWrap: true` as a key value:\n * ```\n * const column = [\n *  { key: \"name\", title: \"Name\", dataType: \"string\" },\n *  ...\n * ]\n * ```\n *\n * To set text to wrap in a row, add `rowOptions: { textWrap: true }` to an object within the data array:\n * ```\n * const data = [\n *  {\n *    name: \"Tim Rayes\",\n *    age: 41,\n *    department: \"Sales and Marketing\",\n *    employeeNumber: 3,\n *    jobTitle:\n *      \"Regional Sales and Marketing Strategy Director (Europe, the Middle East, and Africa)\",\n *    rowOptions: {\n *      textWrap: true\n *    }\n *  },\n *  ...\n * ]\n * ```\n *\n * To set text wrap in a cell, add `textWrap` to a data key within an object:\n * ```\n * const data = [\n *  {\n *    name: {\n *      data:\"Tim Rayes\",\n *      textWrap: true\n *    }\n *    age: 41,\n *    department: \"Sales and Marketing\",\n *    employeeNumber: 3,\n *    jobTitle:\n *      \"Regional Sales and Marketing Strategy Director (Europe, the Middle East, and Africa)\",\n *  },\n *  ...\n * ]\n * ```\n */\nexport const TextWrapExample = {\n  render: () => TruncationTextWrap(),\n  name: \"Text Wrap\",\n};\n\n/**\n * The dimensions of the data table can be set using the `width` and `height` attributes. The attribute accepts dimensions in `px`, `%`, `rem` and `auto`.\n * By default, the width is set to `100%` so the table spans across the viewport or parent container.\n *\n * To set the column widths, the `columnWidth` property should be added to the relevant column within the column array.\n *\n * The [table layout](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout) attribute is vital to how the table resizing and column widths behave. By default, the table layout is set to `fixed`. If no column width is set, the columns widths will be equally set within the viewport or parent container.\n * A table with a `fixed` layout will force the table column widths to take precedence over the data with the table cells.\n * For the column widths to be dictated by the content inside, set the `table-layout` attribute to `auto` and set the table `width` to `auto`.\n * To set the min and max width of a table cell, set the `table-layout` attribute to `auto` and set a `minWidth` or `maxWidth` value into `columnWidth`. The min and max width accepts dimensions in `px`, `%`, `rem`.\n */\nexport const TableSizingAndColumnWidthExample = {\n  render: () => DataTableSizing(),\n  name: \"Table sizing and column width\",\n};\n\n/**\n * The cell data can contain an `actionElement` which can be a string containing any html to be rendered. The `actionElement` will be displayed to the right of the cell data. An `actionOnClick` can be specified for the `actionElement`. This should be used with a keyboard accessible component such as `icButton` for a function to be run when the `actionElement` is clicked.\n */\nexport const ActionElementExample = {\n  render: () => ActionElement(),\n  name: \"Action Element\",\n};\n\n/**\n * Descriptions and icons can be included in the cells by proving a `description` field in the data. This will populate the cell with an icon (if provided) and a text string underneath the cell data. This can be applied to any cell.\n * You can provide a `description` object with or without an icon:\n *\n * With an icon\n * ```\n * firstName: {\n *  data: \"Joe\",\n *  description: {\n *    data: \"The name of Joe\",\n *    icon: '<svg xmlns=\"http://www.w3.org/2000/svg\" height=\"20\" viewBox=\"0 -960 960 960\" width=\"20\"><path d=\"M180-120q-24 0-42-18t-18-42v-600q0-24 18-42t42-18h600q24 0 42 18t18 42v600q0 24-18 42t-42 18H180Zm0-60h600v-600H180v600Zm56-97h489L578-473 446-302l-93-127-117 152Zm-56 97v-600 600Z\"/></svg>',\n *  },\n * }\n * ```\n *\n * Without an icon\n * ```\n * firstName: {\n *  data: \"Joe\",\n *  description: \"The name of Joe\"\n * }\n * ```\n */\nexport const DescriptionAndIconsWithinCellsExample = {\n  render: () => CellDescriptions(),\n  name: \"Description and icons within cells\",\n};\n\nexport const DescriptionAndIconsWithinCellsWithLongTextExample = {\n  render: () => LongCellDescriptions(),\n  name: \"Description and icons within cells with long text\",\n};\n\n/**\n * The example below demonstrates the table being able to handle empty cell values (null, undefined or empty string).\n */\nexport const MissingCellDataExample = {\n  render: () => MissingCellData(),\n  name: \"Missing cell data\",\n};\n\n/**\n * The example below demonstrates the table being configured to not highlight the selected row.\n */\nexport const TurnOffSelectedRowHighlightingExample = {\n  render: () => TurnOffSelectedRowHighlighting(),\n  name: \"Turn off selected row highlighting\",\n};\n\nexport const SelectedRowChangeEventExample = {\n  render: () => SelectedRowChangeEvent(),\n  name: \"Selected row change event\",\n};\n\nexport const DevAreaExample = {\n  render: () => DevArea(),\n  name: \"Dev Area\",\n};\n"]}

package/dist/collection/components/ic-data-table/ic-data-table.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"ic-data-table.types.js","sourceRoot":"","sources":["../../../src/components/ic-data-table/ic-data-table.types.tsx"],"names":[],"mappings":"","sourcesContent":["export type IcDataTableSortOrderOptions =\n  | \"unsorted\"\n  | \"ascending\"\n  | \"descending\";\n\nexport type IcDataTableDensityOptions = \"default\" | \"dense\" | \"spacious\";\n\nexport type IcDataTableColumnDataTypes =\n  | \"string\"\n  | \"number\"\n  | \"address\"\n  | \"element\"\n  | \"date\";\n\nexport type IcDataTableColumnObject = {\n  key: string;\n  title: string;\n  dataType: IcDataTableColumnDataTypes;\n  columnAlignment?: {\n    horizontal?: string;\n    vertical?: string;\n  };\n  cellAlignment?: string;\n  emphasis?: string;\n  colspan?: number;\n};\n"]}
+{"version":3,"file":"ic-data-table.types.js","sourceRoot":"","sources":["../../../src/components/ic-data-table/ic-data-table.types.tsx"],"names":[],"mappings":"","sourcesContent":["import { IcThemeForegroundNoDefault } from \"@ukic/web-components\";\n\nexport type IcDataTableSortOrderOptions =\n  | \"unsorted\"\n  | \"ascending\"\n  | \"descending\";\n\nexport type IcDataTableDensityOptions = \"default\" | \"dense\" | \"spacious\";\n\nexport type IcDataTableColumnDataTypes =\n  | \"string\"\n  | \"number\"\n  | \"address\"\n  | \"element\"\n  | \"date\";\n\nexport type IcDataTableColumnWidthTypes = {\n  width?: string;\n  minWidth?: string;\n  maxWidth?: string;\n};\n\nexport type IcDataTableColumnObject = {\n  key: string;\n  title: string;\n  dataType: IcDataTableColumnDataTypes;\n  columnAlignment?: {\n    horizontal?: string;\n    vertical?: string;\n  };\n  rowOptions?: {\n    textWrap: boolean;\n  };\n  columnWidth?: string | IcDataTableColumnWidthTypes;\n  textWrap?: boolean;\n  cellAlignment?: string;\n  emphasis?: string;\n  colspan?: number;\n  icon?: {\n    icon: string;\n    onAllCells?: boolean;\n    hideOnHeader?: boolean;\n  };\n  excludeColumnFromSort?: boolean;\n};\n\nexport type IcLoadingOptions = {\n  appearance?: IcThemeForegroundNoDefault;\n  description?: string;\n  label?: string;\n  labelDuration?: number;\n  max?: number;\n  min?: number;\n  progress?: number;\n  showBackground?: boolean;\n  overlay?: boolean;\n};\n\nexport type IcDataTableRowHeights = number | \"auto\";\n\nexport interface IcDensityUpdateEventDetail {\n  value: IcDataTableDensityOptions;\n}\nexport type IcDataTableTruncationTypes = \"tooltip\" | \"show-hide\" | undefined;\n\nexport interface IcSortEventDetail {\n  columnName: string;\n  sorted: IcDataTableSortOrderOptions;\n}\n\nexport type truncWrapperDetailsTypes = {\n  scrollHeight: number | null;\n};\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type IcDataTableDataType = { [key: string]: any };\n"]}