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

package/dist/types/components/ic-data-table/ic-data-table.d.ts

@@ -1,97 +1,97 @@
 import { IcDataTableColumnObject, IcDataTableDensityOptions, IcDataTableSortOrderOptions } from "./ic-data-table.types";
 import { IcPaginationAlignmentOptions, IcPaginationControlTypes, IcPaginationTypes } from "../ic-pagination/ic-pagination.types";
 export declare class DataTable {
-  private SORT_ICONS;
-  el: HTMLIcDataTableElement;
-  fromRow: number;
-  previousRowsPerPage: number;
-  rowsPerPage: number;
-  scrollable: boolean;
-  scrollOffset: number;
-  selectedRow: object;
-  sortedColumn: string;
-  sortedColumnOrder: IcDataTableSortOrderOptions;
-  toRow: number;
-  /**
-   * The title for the table only visible to screen readers.
-   */
-  caption: string;
-  /**
-   * The column headers for the table.
-   */
-  columns: IcDataTableColumnObject[];
-  /**
-   * The row content for the table.
-   */
-  data: {
-    [key: string]: any;
-  }[];
-  /**
-   * Set the density of the table including font and padding.
-   */
-  density?: IcDataTableDensityOptions;
-  /**
-   * Applies a border to the table container.
-   */
-  embedded?: boolean;
-  /**
-   * If `true`, column headers will not be visible.
-   */
-  hideColumnHeaders?: boolean;
-  /**
-   * Sets the props for the pagination bar.
-   */
-  paginationOptions?: {
-    itemsPerPage?: {
-      label: string;
-      value: string;
+    private SORT_ICONS;
+    el: HTMLIcDataTableElement;
+    fromRow: number;
+    previousRowsPerPage: number;
+    rowsPerPage: number;
+    scrollable: boolean;
+    scrollOffset: number;
+    selectedRow: object;
+    sortedColumn: string;
+    sortedColumnOrder: IcDataTableSortOrderOptions;
+    toRow: number;
+    /**
+     * The title for the table only visible to screen readers.
+     */
+    caption: string;
+    /**
+     * The column headers for the table.
+     */
+    columns: IcDataTableColumnObject[];
+    /**
+     * The row content for the table.
+     */
+    data: {
+        [key: string]: any;
     }[];
-    type?: IcPaginationTypes;
-    control?: IcPaginationControlTypes;
-    itemsPerPageControl?: boolean;
-    goToPageControl?: boolean;
-    alignment?: IcPaginationAlignmentOptions;
-  };
-  /**
-   * If `true`, adds a pagination bar to the bottom of the table.
-   */
-  showPagination?: boolean;
-  /**
-   * If `true`, allows table columns to be sorted using applied sort buttons.
-   */
-  sortable?: boolean;
-  /**
-   * Sets the order columns will be sorted in and allows for 'default' sorts to be added.
-   */
-  sortOptions?: {
-    sortOrders: IcDataTableSortOrderOptions[];
-    defaultColumn?: string;
-  };
-  /**
-   * If `true`, column headers will remain at the top of the table when scrolling vertically.
-   */
-  stickyColumnHeaders?: boolean;
-  /**
-   * If `true`, row headers will remain to the left when scrolling horizontally.
-   */
-  stickyRowHeaders?: boolean;
-  componentWillLoad(): void;
-  componentDidLoad(): void;
-  handleItemsPerPageChange(ev: CustomEvent): void;
-  handlePageChange(ev: CustomEvent): void;
-  clickListener(ev: MouseEvent): void;
-  private isObject;
-  private notDefaultDensity;
-  private getCellContent;
-  private getCellAlignment;
-  private createCells;
-  private createColumnHeaders;
-  private createRows;
-  private getObjectValue;
-  private getSortButtonLabel;
-  private getComparison;
-  private getSortFunction;
-  private sortRows;
-  private updateScrollOffset;
-  render(): any;
+    /**
+     * Set the density of the table including font and padding.
+     */
+    density?: IcDataTableDensityOptions;
+    /**
+     * Applies a border to the table container.
+     */
+    embedded?: boolean;
+    /**
+     * If `true`, column headers will not be visible.
+     */
+    hideColumnHeaders?: boolean;
+    /**
+     * Sets the props for the pagination bar.
+     */
+    paginationOptions?: {
+        itemsPerPage?: {
+            label: string;
+            value: string;
+        }[];
+        type?: IcPaginationTypes;
+        control?: IcPaginationControlTypes;
+        itemsPerPageControl?: boolean;
+        goToPageControl?: boolean;
+        alignment?: IcPaginationAlignmentOptions;
+    };
+    /**
+     * If `true`, adds a pagination bar to the bottom of the table.
+     */
+    showPagination?: boolean;
+    /**
+     * If `true`, allows table columns to be sorted using applied sort buttons.
+     */
+    sortable?: boolean;
+    /**
+     * Sets the order columns will be sorted in and allows for 'default' sorts to be added.
+     */
+    sortOptions?: {
+        sortOrders: IcDataTableSortOrderOptions[];
+        defaultColumn?: string;
+    };
+    /**
+     * If `true`, column headers will remain at the top of the table when scrolling vertically.
+     */
+    stickyColumnHeaders?: boolean;
+    /**
+     * If `true`, row headers will remain to the left when scrolling horizontally.
+     */
+    stickyRowHeaders?: boolean;
+    componentWillLoad(): void;
+    componentDidLoad(): void;
+    handleItemsPerPageChange(ev: CustomEvent): void;
+    handlePageChange(ev: CustomEvent): void;
+    clickListener(ev: MouseEvent): void;
+    private isObject;
+    private notDefaultDensity;
+    private getCellContent;
+    private getCellAlignment;
+    private createCells;
+    private createColumnHeaders;
+    private createRows;
+    private getObjectValue;
+    private getSortButtonLabel;
+    private getComparison;
+    private getSortFunction;
+    private sortRows;
+    private updateScrollOffset;
+    render(): any;
 }

package/dist/types/components/ic-data-table/ic-data-table.types.d.ts

@@ -2,14 +2,14 @@ export type IcDataTableSortOrderOptions = "unsorted" | "ascending" | "descending
 export type IcDataTableDensityOptions = "default" | "dense" | "spacious";
 export type IcDataTableColumnDataTypes = "string" | "number" | "address" | "element" | "date";
 export type IcDataTableColumnObject = {
-  key: string;
-  title: string;
-  dataType: IcDataTableColumnDataTypes;
-  columnAlignment?: {
-    horizontal?: string;
-    vertical?: string;
-  };
-  cellAlignment?: string;
-  emphasis?: string;
-  colspan?: number;
+    key: string;
+    title: string;
+    dataType: IcDataTableColumnDataTypes;
+    columnAlignment?: {
+        horizontal?: string;
+        vertical?: string;
+    };
+    cellAlignment?: string;
+    emphasis?: string;
+    colspan?: number;
 };

package/dist/types/components/ic-data-table/story-data.d.ts

@@ -2,92 +2,92 @@ import { IcDataTableColumnObject } from "./ic-data-table.types";
 export declare const COLS: IcDataTableColumnObject[];
 export declare const COLS_ALIGNMENT: IcDataTableColumnObject[];
 export declare const DATA: {
-  firstName: string;
-  lastName: string;
-  age: number;
-  jobTitle: string;
-  address: string;
+    firstName: string;
+    lastName: string;
+    age: number;
+    jobTitle: string;
+    address: string;
 }[];
 export declare const DATA_CELL_ALIGNMENT: ({
-  firstName: {
-    data: string;
-    cellAlignment: {
-      horizontal: string;
-      vertical: string;
+    firstName: {
+        data: string;
+        cellAlignment: {
+            horizontal: string;
+            vertical: string;
+        };
+        emphasis: string;
     };
-    emphasis: string;
-  };
-  lastName: string;
-  age: number;
-  jobTitle: string;
-  address: string;
+    lastName: string;
+    age: number;
+    jobTitle: string;
+    address: string;
 } | {
-  firstName: string;
-  lastName: string;
-  age: number;
-  jobTitle: string;
-  address: string;
+    firstName: string;
+    lastName: string;
+    age: number;
+    jobTitle: string;
+    address: string;
 })[];
 export declare const ROW_ALIGNMENT: ({
-  header: {
-    title: string;
-    rowAlignment: string;
-    emphasis: string;
-  };
-  firstName: string;
-  lastName: string;
-  age: number;
-  jobTitle: string;
-  address: string;
+    header: {
+        title: string;
+        rowAlignment: string;
+        emphasis: string;
+    };
+    firstName: string;
+    lastName: string;
+    age: number;
+    jobTitle: string;
+    address: string;
 } | {
-  header: {
-    title: string;
-    rowAlignment?: undefined;
-    emphasis?: undefined;
-  };
-  firstName: string;
-  lastName: string;
-  age: number;
-  jobTitle: string;
-  address: string;
+    header: {
+        title: string;
+        rowAlignment?: undefined;
+        emphasis?: undefined;
+    };
+    firstName: string;
+    lastName: string;
+    age: number;
+    jobTitle: string;
+    address: string;
 })[];
 export declare const LONG_COLS: IcDataTableColumnObject[];
 export declare const LONG_DATA: {
-  employeeNumber: number;
-  name: string;
-  age: number;
-  jobTitle: string;
-  address: string;
+    employeeNumber: number;
+    name: string;
+    age: number;
+    jobTitle: string;
+    address: string;
 }[];
 export declare const ROW_HEADER_COLS: IcDataTableColumnObject[];
 export declare const ROW_HEADER_DATA: {
-  firstName: string;
-  lastName: string;
-  age: number;
-  jobTitle: string;
-  address: string;
-  header: {
-    title: string;
-  };
+    firstName: string;
+    lastName: string;
+    age: number;
+    jobTitle: string;
+    address: string;
+    header: {
+        title: string;
+    };
 }[];
 export declare const COLS_ELEMENTS: IcDataTableColumnObject[];
 export declare const DATA_ELEMENTS: ({
-  firstName: {
-    data: string;
-    href: string;
-  };
-  lastName: string;
-  age: number;
-  jobTitle: string;
-  address: string;
-  actions: string;
+    firstName: {
+        data: string;
+        href: string;
+    };
+    lastName: string;
+    age: number;
+    jobTitle: string;
+    address: string;
+    actions: string;
 } | {
-  firstName: string;
-  lastName: string;
-  age: number;
-  jobTitle: string;
-  address: string;
-  actions: string;
+    firstName: string;
+    lastName: string;
+    age: number;
+    jobTitle: string;
+    address: string;
+    actions: string;
 })[];
 export declare const createDataTableElement: (caption: string, columns?: IcDataTableColumnObject[], data?: object[]) => HTMLIcDataTableElement;
 export declare const Basic: () => HTMLIcDataTableElement;

package/dist/types/components/ic-pagination/ic-pagination.types.d.ts

@@ -2,5 +2,5 @@ export type IcPaginationControlTypes = "simple" | "complex";
 export type IcPaginationAlignmentOptions = "left" | "right" | "space-between";
 export type IcPaginationTypes = "data" | "page";
 export interface IcChangeEventDetail {
-  value: number;
+    value: number;
 }

package/dist/types/components/ic-pagination-bar/ic-pagination-bar.d.ts

@@ -1,103 +1,103 @@
 import { EventEmitter } from "../../stencil-public-runtime";
-import { IcThemeForeground } from "../../interface";
+import { IcThemeForeground } from "@ukic/web-components/dist/types/interface";
 import { IcPaginationAlignmentOptions, IcPaginationControlTypes, IcPaginationTypes } from "../ic-pagination/ic-pagination.types";
 export declare class PaginationBar {
-  private PAGINATION;
-  private TEXT_FIELD;
-  private TOOLTIP;
-  private PAGE_INPUT_FIELD_ID;
-  private INVALID_PAGE_ERROR;
-  private NAN_ERROR;
-  private resizeObserver;
-  private paginationBarEl;
-  el: HTMLIcPaginationBarElement;
-  currentPage: number;
-  inputError: string;
-  itemsPerPage: string;
-  lowerBound: number;
-  paginationWidth: number;
-  paginationWrapped: boolean;
-  totalPages: number;
-  upperBound: number;
-  /**
-   * Sets the alignment of the items in the pagination bar.
-   */
-  alignment?: IcPaginationAlignmentOptions;
-  /**
-   * Sets the styling for the items in the pagination bar.
-   */
-  appearance?: IcThemeForeground;
-  /**
-   * The label which will be used in place of 'items' if paginationType is data. Should be capitalised.
-   */
-  itemLabel?: string;
-  /**
-   * The options which will be displayed for 'items per page' select input. Set a maximum of 4 options including a required 'All' option with value equal to total number of items.
-   */
-  itemsPerPageOptions?: {
-    label: string;
-    value: string;
-  }[];
-  /**
-   * Whether the displayed pagination is simple or complex.
-   */
-  paginationControl?: IcPaginationControlTypes;
-  /**
-   * Whether total number of items and current item range or total number of pages and current page is displayed.
-   */
-  paginationType?: IcPaginationTypes;
-  /**
-   * The label which will be used in place of 'Page' if paginationType is page. Should be capitalised.
-   */
-  pageLabel?: string;
-  /**
-   * If `true`, the 'go to page' control should be displayed.
-   */
-  showGoToPageControl?: boolean;
-  /**
-   * If `true`, the number of total items and current item range or number of total pages and current page should be displayed.
-   */
-  showItemsPerPage?: boolean;
-  /**
-   * If `true`, the select input to control 'items per page' should be displayed.
-   */
-  showItemsPerPageControl?: boolean;
-  /**
-   * Total number of items to be displayed across all pages.
-   */
-  totalItems: number;
-  /**
-   * Emitted when a page is navigated to via the 'go to' input.
-   */
-  icPageChange: EventEmitter<{
-    value: number;
-  }>;
-  /**
-   * Emitted when the items per page option is changed.
-   */
-  icItemsPerPageChange: EventEmitter<{
-    value: number;
-  }>;
-  disconnectedCallback(): void;
-  componentWillLoad(): void;
-  componentDidLoad(): void;
-  pageChangeHandler(ev: CustomEvent): void;
-  private changeItemsPerPage;
-  private changePage;
-  private goToPage;
-  private handleBlur;
-  private handleFocus;
-  private handleInputChange;
-  private handleKeydown;
-  private handleKeyUp;
-  private paginationShouldWrap;
-  private resizeObserverCallback;
-  private runResizeObserver;
-  private setDefaultItemsPerPage;
-  private setDefaultItemsPerPageOptions;
-  private setGoToPageInputStyles;
-  private setNumberPages;
-  private setUpperBound;
-  private trimItemsPerPageOptions;
-  render(): any;
+    private PAGINATION;
+    private TEXT_FIELD;
+    private TOOLTIP;
+    private PAGE_INPUT_FIELD_ID;
+    private INVALID_PAGE_ERROR;
+    private NAN_ERROR;
+    private resizeObserver;
+    private paginationBarEl;
+    el: HTMLIcPaginationBarElement;
+    currentPage: number;
+    inputError: string;
+    itemsPerPage: string;
+    lowerBound: number;
+    paginationWidth: number;
+    paginationWrapped: boolean;
+    totalPages: number;
+    upperBound: number;
+    /**
+     * Sets the alignment of the items in the pagination bar.
+     */
+    alignment?: IcPaginationAlignmentOptions;
+    /**
+     * Sets the styling for the items in the pagination bar.
+     */
+    appearance?: IcThemeForeground;
+    /**
+     * The label which will be used in place of 'items' if paginationType is data. Should be capitalised.
+     */
+    itemLabel?: string;
+    /**
+     * The options which will be displayed for 'items per page' select input. Set a maximum of 4 options including a required 'All' option with value equal to total number of items.
+     */
+    itemsPerPageOptions?: {
+        label: string;
+        value: string;
+    }[];
+    /**
+     * Whether the displayed pagination is simple or complex.
+     */
+    paginationControl?: IcPaginationControlTypes;
+    /**
+     * Whether total number of items and current item range or total number of pages and current page is displayed.
+     */
+    paginationType?: IcPaginationTypes;
+    /**
+     * The label which will be used in place of 'Page' if paginationType is page. Should be capitalised.
+     */
+    pageLabel?: string;
+    /**
+     * If `true`, the 'go to page' control should be displayed.
+     */
+    showGoToPageControl?: boolean;
+    /**
+     * If `true`, the number of total items and current item range or number of total pages and current page should be displayed.
+     */
+    showItemsPerPage?: boolean;
+    /**
+     * If `true`, the select input to control 'items per page' should be displayed.
+     */
+    showItemsPerPageControl?: boolean;
+    /**
+     * Total number of items to be displayed across all pages.
+     */
+    totalItems: number;
+    /**
+     * Emitted when a page is navigated to via the 'go to' input.
+     */
+    icPageChange: EventEmitter<{
+        value: number;
+    }>;
+    /**
+     * Emitted when the items per page option is changed.
+     */
+    icItemsPerPageChange: EventEmitter<{
+        value: number;
+    }>;
+    disconnectedCallback(): void;
+    componentWillLoad(): void;
+    componentDidLoad(): void;
+    pageChangeHandler(ev: CustomEvent): void;
+    private changeItemsPerPage;
+    private changePage;
+    private goToPage;
+    private handleBlur;
+    private handleFocus;
+    private handleInputChange;
+    private handleKeydown;
+    private handleKeyUp;
+    private paginationShouldWrap;
+    private resizeObserverCallback;
+    private runResizeObserver;
+    private setDefaultItemsPerPage;
+    private setDefaultItemsPerPageOptions;
+    private setGoToPageInputStyles;
+    private setNumberPages;
+    private setUpperBound;
+    private trimItemsPerPageOptions;
+    render(): any;
 }