@ukic/canary-web-components 2.0.0-canary.26 → 2.0.0-canary.28

package/dist/types/components.d.ts

@@ -12,6 +12,7 @@ import { IcDateFormat, IcInformationStatusOrEmpty, IcPaginationBarOptions, IcSea
 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";
+import { IcPageChangeEventDetail } from "./components/ic-pagination-bar/ic-pagination-bar.types";
 export { IcCardSizes } from "./components/ic-card-horizontal/ic-card-horizontal.types";
 export { IcDataTableColumnObject, IcDataTableDataType, IcDataTableDensityOptions, IcDataTableRowHeights, IcDataTableSortOrderOptions, IcDataTableTruncationTypes, IcDensityUpdateEventDetail, IcSortEventDetail } from "./components/ic-data-table/ic-data-table.types";
 export { IcActivationTypes, IcMenuOption, IcThemeForegroundNoDefault } from "@ukic/web-components/dist/types/utils/types";
@@ -19,6 +20,7 @@ export { IcDateFormat, IcInformationStatusOrEmpty, IcPaginationBarOptions, IcSea
 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 { IcPageChangeEventDetail } from "./components/ic-pagination-bar/ic-pagination-bar.types";
 export namespace Components {
     interface IcCardHorizontal {
         /**
@@ -257,6 +259,10 @@ export namespace Components {
           * If `true`, the helper text will be visually hidden, but still read out by screenreaders.
          */
         "hideHelperText": boolean;
+        /**
+          * If `true`, the label will be visually hidden, but will still be read out by screen readers.
+         */
+        "hideLabel"?: boolean;
         /**
           * The ID for the input.
          */
@@ -351,6 +357,10 @@ export namespace Components {
           * If `true`, the helper text will be visually hidden, but still read out by screenreaders.
          */
         "hideHelperText": boolean;
+        /**
+          * If `true`, the label will be visually hidden, but the required label will still be read out by screen readers.
+         */
+        "hideLabel"?: boolean;
         /**
           * The ID for the input field. The default will be an automatically generated value.
          */
@@ -498,6 +508,14 @@ export namespace Components {
           * Sets the styling for the items in the pagination bar.
          */
         "appearance"?: IcThemeForeground;
+        /**
+          * The current page number to be displayed on the pagination bar.
+         */
+        "currentPage"?: number;
+        /**
+          * If `true`, the 'All' option will be hidden from the 'items per page' select input.
+         */
+        "hideAllFromItemsPerPage"?: boolean;
         /**
           * If `true`, the number of total items and current item range or number of total pages and current page will be hidden.
          */
@@ -507,7 +525,7 @@ export namespace Components {
          */
         "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.
+          * The options which will be displayed for 'items per page' select input.
          */
         "itemsPerPageOptions"?: {
     label: string;
@@ -694,6 +712,9 @@ export namespace Components {
           * If `true`, the tree item appears in the disabled state.
          */
         "disabled"?: boolean;
+        /**
+          * If `true`, the tree item appears in the expanded state.
+         */
         "expanded": boolean;
         "hasParentExpanded": boolean;
         /**
@@ -883,7 +904,7 @@ declare global {
         new (): HTMLIcMenuWithMultiElement;
     };
     interface HTMLIcPaginationBarElementEventMap {
-        "icPageChange": { value: number };
+        "icPageChange": IcPageChangeEventDetail;
         "icItemsPerPageChange": { value: number };
     }
     interface HTMLIcPaginationBarElement extends Components.IcPaginationBar, HTMLStencilElement {
@@ -1197,6 +1218,10 @@ declare namespace LocalJSX {
           * If `true`, the helper text will be visually hidden, but still read out by screenreaders.
          */
         "hideHelperText"?: boolean;
+        /**
+          * If `true`, the label will be visually hidden, but will still be read out by screen readers.
+         */
+        "hideLabel"?: boolean;
         /**
           * The ID for the input.
          */
@@ -1299,6 +1324,10 @@ declare namespace LocalJSX {
           * If `true`, the helper text will be visually hidden, but still read out by screenreaders.
          */
         "hideHelperText"?: boolean;
+        /**
+          * If `true`, the label will be visually hidden, but the required label will still be read out by screen readers.
+         */
+        "hideLabel"?: boolean;
         /**
           * The ID for the input field. The default will be an automatically generated value.
          */
@@ -1439,6 +1468,14 @@ declare namespace LocalJSX {
           * Sets the styling for the items in the pagination bar.
          */
         "appearance"?: IcThemeForeground;
+        /**
+          * The current page number to be displayed on the pagination bar.
+         */
+        "currentPage"?: number;
+        /**
+          * If `true`, the 'All' option will be hidden from the 'items per page' select input.
+         */
+        "hideAllFromItemsPerPage"?: boolean;
         /**
           * If `true`, the number of total items and current item range or number of total pages and current page will be hidden.
          */
@@ -1448,7 +1485,7 @@ declare namespace LocalJSX {
          */
         "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.
+          * The options which will be displayed for 'items per page' select input.
          */
         "itemsPerPageOptions"?: {
     label: string;
@@ -1459,9 +1496,9 @@ declare namespace LocalJSX {
          */
         "onIcItemsPerPageChange"?: (event: IcPaginationBarCustomEvent<{ value: number }>) => void;
         /**
-          * Emitted when a page is navigated to via the 'go to' input.
+          * Emitted when a page is navigated to via the 'go to' input. The `detail` property contains `value` (i.e. the page number) and a `fromItemsPerPage` flag to indicate if the event was triggered by the `icItemsPerPageChange` event also occurring.
          */
-        "onIcPageChange"?: (event: IcPaginationBarCustomEvent<{ value: number }>) => void;
+        "onIcPageChange"?: (event: IcPaginationBarCustomEvent<IcPageChangeEventDetail>) => void;
         /**
           * The text which will be used in place of 'Page' on the pagination bar.
          */
@@ -1670,6 +1707,10 @@ declare namespace LocalJSX {
           * If `true`, the tree item appears in the disabled state.
          */
         "disabled"?: boolean;
+        /**
+          * If `true`, the tree item appears in the expanded state.
+         */
+        "expanded"?: boolean;
         /**
           * The URL that the tree item link points to. If set, the tree item will render as an "a" tag, otherwise it will render as a div.
          */

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

@@ -73,6 +73,7 @@ export interface IcPaginationBarOptions {
     itemLabel?: string;
     pageLabel?: string;
     hideRangeLabel?: boolean;
+    hideAllFromItemsPerPage?: boolean;
 }
 export type IcCallbackFunctionNoReturn = (...args: unknown[]) => void;
 export type IcDateFormat = "DD/MM/YYYY" | "MM/DD/YYYY" | "YYYY/MM/DD";