@ukic/canary-web-components 2.0.0-canary.15 → 2.0.0-canary.17

package/dist/types/components.d.ts

@@ -7,15 +7,15 @@
 import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
 import { IcDataTableColumnObject, IcDataTableDensityOptions, IcDataTableRowHeights, IcDataTableSortOrderOptions, IcDensityUpdateEventDetail } from "./components/ic-data-table/ic-data-table.types";
 import { IcActivationTypes, IcMenuOption, IcThemeForegroundNoDefault } from "@ukic/web-components/dist/types/utils/types";
-import { IcPaginationAlignmentOptions, IcPaginationLabelTypes, IcPaginationTypes } from "@ukic/web-components/dist/types/components/ic-pagination/ic-pagination.types";
-import { IcDateFormat, IcInformationStatusOrEmpty, IcSearchMatchPositions, IcSizes, IcValueEventDetail, IcWeekDays } from "./utils/types";
+import { IcDateFormat, IcInformationStatusOrEmpty, IcPaginationBarOptions, IcSearchMatchPositions, IcSizes, IcValueEventDetail, IcWeekDays } from "./utils/types";
 import { IcMenuChangeEventDetail, IcMenuOptionIdEventDetail, IcOptionSelectEventDetail, IcSearchBarSearchModes } from "@ukic/web-components/dist/types/components";
+import { IcPaginationAlignmentOptions, IcPaginationLabelTypes, IcPaginationTypes } from "@ukic/web-components/dist/types/components/ic-pagination/ic-pagination.types";
 import { IcThemeForeground } from "@ukic/web-components/dist/types/interface";
 export { IcDataTableColumnObject, IcDataTableDensityOptions, IcDataTableRowHeights, IcDataTableSortOrderOptions, IcDensityUpdateEventDetail } from "./components/ic-data-table/ic-data-table.types";
 export { IcActivationTypes, IcMenuOption, IcThemeForegroundNoDefault } from "@ukic/web-components/dist/types/utils/types";
-export { IcPaginationAlignmentOptions, IcPaginationLabelTypes, IcPaginationTypes } from "@ukic/web-components/dist/types/components/ic-pagination/ic-pagination.types";
-export { IcDateFormat, IcInformationStatusOrEmpty, IcSearchMatchPositions, IcSizes, IcValueEventDetail, IcWeekDays } from "./utils/types";
+export { IcDateFormat, IcInformationStatusOrEmpty, IcPaginationBarOptions, IcSearchMatchPositions, IcSizes, IcValueEventDetail, IcWeekDays } from "./utils/types";
 export { IcMenuChangeEventDetail, IcMenuOptionIdEventDetail, IcOptionSelectEventDetail, IcSearchBarSearchModes } from "@ukic/web-components/dist/types/components";
+export { IcPaginationAlignmentOptions, IcPaginationLabelTypes, IcPaginationTypes } from "@ukic/web-components/dist/types/components/ic-pagination/ic-pagination.types";
 export { IcThemeForeground } from "@ukic/web-components/dist/types/interface";
 export namespace Components {
     interface IcDataTable {
@@ -71,14 +71,7 @@ export namespace Components {
         /**
           * Sets the props for the pagination bar.
          */
-        "paginationOptions"?: {
-    itemsPerPage?: { label: string; value: string }[];
-    rangeLabelType?: IcPaginationLabelTypes;
-    type?: IcPaginationTypes;
-    itemsPerPageControl?: boolean;
-    goToPageControl?: boolean;
-    alignment?: IcPaginationAlignmentOptions;
-  };
+        "paginationBarOptions"?: IcPaginationBarOptions;
         /**
           * Resets the `globalRowHeight` prop to `40px` and sets the `variableRowHeight` prop to `null`.
          */
@@ -421,6 +414,10 @@ export namespace Components {
           * If `true`, the number of total items and current item range or number of total pages and current page will be hidden.
          */
         "hideRangeLabel"?: boolean;
+        /**
+          * The text which will be used in place of 'Item' on the pagination bar.
+         */
+        "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.
          */
@@ -429,13 +426,9 @@ export namespace Components {
     value: string;
   }[];
         /**
-          * The label which will be used in place of 'Page' if rangeLabelType is page. Should be capitalised.
+          * The text which will be used in place of 'Page' on the pagination bar.
          */
         "pageLabel"?: string;
-        /**
-          * The label which will be used in place of 'items' if type is data. Should be capitalised.
-         */
-        "rangeItemLabel"?: string;
         /**
           * Whether total number of items and current item range or total number of pages and current page is displayed.
          */
@@ -842,14 +835,7 @@ declare namespace LocalJSX {
         /**
           * Sets the props for the pagination bar.
          */
-        "paginationOptions"?: {
-    itemsPerPage?: { label: string; value: string }[];
-    rangeLabelType?: IcPaginationLabelTypes;
-    type?: IcPaginationTypes;
-    itemsPerPageControl?: boolean;
-    goToPageControl?: boolean;
-    alignment?: IcPaginationAlignmentOptions;
-  };
+        "paginationBarOptions"?: IcPaginationBarOptions;
         /**
           * If `true`, adds a pagination bar to the bottom of the table.
          */
@@ -1188,6 +1174,10 @@ declare namespace LocalJSX {
           * If `true`, the number of total items and current item range or number of total pages and current page will be hidden.
          */
         "hideRangeLabel"?: boolean;
+        /**
+          * The text which will be used in place of 'Item' on the pagination bar.
+         */
+        "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.
          */
@@ -1204,13 +1194,9 @@ declare namespace LocalJSX {
          */
         "onIcPageChange"?: (event: IcPaginationBarCustomEvent<{ value: number }>) => void;
         /**
-          * The label which will be used in place of 'Page' if rangeLabelType is page. Should be capitalised.
+          * The text which will be used in place of 'Page' on the pagination bar.
          */
         "pageLabel"?: string;
-        /**
-          * The label which will be used in place of 'items' if type is data. Should be capitalised.
-         */
-        "rangeItemLabel"?: string;
         /**
           * Whether total number of items and current item range or total number of pages and current page is displayed.
          */

package/dist/types/utils/helpers.d.ts

@@ -141,3 +141,4 @@ export declare const removeFormResetListener: (el: HTMLElement, callbackFn: IcCa
 export declare const removeDisabledFalse: (disabled: boolean, element: HTMLElement) => void;
 export declare const isMacDevice: () => boolean;
 export declare function waitForHydration(): Promise<boolean>;
+export declare const capitalize: (text: string) => string;

package/dist/types/utils/types.d.ts

@@ -1,3 +1,4 @@
+import { IcPaginationLabelTypes, IcPaginationTypes, IcPaginationAlignmentOptions } from "../components";
 export type IcFocusableComponents = HTMLIcBreadcrumbElement | HTMLIcButtonElement | HTMLIcCardElement | HTMLIcCheckboxElement | HTMLIcChipElement | HTMLIcLinkElement | HTMLIcNavigationButtonElement | HTMLIcNavigationGroupElement | HTMLIcNavigationItemElement | HTMLIcRadioOptionElement | HTMLIcSearchBarElement | HTMLIcSelectElement | HTMLIcSwitchElement | HTMLIcTabElement | HTMLIcTextFieldElement;
 export type IcStatusVariants = "neutral" | "info" | "warning" | "error" | "success";
 export declare enum IcInformationStatus {
@@ -58,6 +59,21 @@ export interface IcMenuOption {
     icon?: any;
 }
 export type IcSearchMatchPositions = "start" | "anywhere";
+export interface IcPaginationBarOptions {
+    itemsPerPageOptions?: {
+        label: string;
+        value: string;
+    }[];
+    rangeLabelType?: IcPaginationLabelTypes;
+    type?: IcPaginationTypes;
+    showItemsPerPageControl?: boolean;
+    showGoToPageControl?: boolean;
+    alignment?: IcPaginationAlignmentOptions;
+    appearance?: IcThemeForeground;
+    itemLabel?: string;
+    pageLabel?: string;
+    hideRangeLabel?: boolean;
+}
 export type IcCallbackFunctionNoReturn = (...args: unknown[]) => void;
 export type IcDateFormat = "DD/MM/YYYY" | "MM/DD/YYYY" | "YYYY/MM/DD";
 export declare enum IcDateInputMonths {