@public-ui/components 1.1.10-rc.1 → 1.1.10-rc.11

package/dist/types/stencil-public-runtime.d.ts

@@ -223,6 +223,7 @@ export declare const setMode: (handler: ResolutionHandler) => void;
 /**
  * `getMode()` is used for libraries which provide multiple "modes" for styles.
  * @param ref a reference to the node to get styles for
+ * @returns the current mode or undefined, if not found
  */
 export declare function getMode<T = string | undefined>(ref: any): T;
 export declare function setPlatformHelpers(helpers: {
@@ -237,6 +238,7 @@ export declare function setPlatformHelpers(helpers: {
  * if the path needs to be customized.
  * @param path the path to use in calculating the asset path. this value will be
  * used in conjunction with the base asset path
+ * @returns the base path
  */
 export declare function getAssetPath(path: string): string;
 /**
@@ -252,11 +254,13 @@ export declare function getAssetPath(path: string): string;
  * bundling, and where your assets can be loaded from. Additionally custom bundling
  * will have to ensure the static assets are copied to its build directory.
  * @param path the asset path to set
+ * @returns the set path
  */
 export declare function setAssetPath(path: string): string;
 /**
  * Retrieve a Stencil element for a given reference
  * @param ref the ref to get the Stencil element for
+ * @returns a reference to the element
  */
 export declare function getElement(ref: any): HTMLStencilElement;
 /**
@@ -269,6 +273,7 @@ export declare function getElement(ref: any): HTMLStencilElement;
 export declare function forceUpdate(ref: any): void;
 /**
  * getRenderingRef
+ * @returns the rendering ref
  */
 export declare function getRenderingRef(): any;
 export interface HTMLStencilElement extends HTMLElement {

package/dist/types/types/button-link.d.ts

@@ -4,9 +4,8 @@ import { Generic } from '@public-ui/core';
 import { EventCallback } from './callbacks';
 import { Alignment, KoliBriCustomIcon, KoliBriIconProp } from './icon';
 export declare type AriaCurrent = boolean | 'page' | 'step' | 'location' | 'date' | 'time';
-export declare type KoliBriButtonLinkShowAs = 'button' | 'link';
-declare type RequiredButtonLinkProps = unknown;
-declare type OptionalButtonLinkProps = {
+declare type RequiredButtonAndLinkProps = unknown;
+declare type OptionalButtonAndLinkProps = {
   ariaControls: string;
   ariaCurrent: AriaCurrent;
   ariaExpanded: boolean;
@@ -15,10 +14,9 @@ declare type OptionalButtonLinkProps = {
   icon: KoliBriIconProp;
   iconAlign: Alignment;
   iconOnly: boolean;
-  showAs: KoliBriButtonLinkShowAs;
   tooltipAlign: TooltipAlignment;
 };
-declare type RequiredButtonLinkStates = {
+declare type RequiredButtonAndLinkStates = {
   ariaLabel: string;
   icon: {
     top?: KoliBriCustomIcon;
@@ -27,9 +25,8 @@ declare type RequiredButtonLinkStates = {
     left?: KoliBriCustomIcon;
   };
   iconAlign: Alignment;
-  showAs: KoliBriButtonLinkShowAs;
 };
-declare type OptionalButtonLinkStates = {
+declare type OptionalButtonAndLinkStates = {
   ariaControls: string;
   ariaCurrent: AriaCurrent;
   ariaExpanded: boolean;
@@ -46,33 +43,37 @@ export declare type KoliBriButtonVariantCustomClass = {
   customClass: string;
   variant: KoliBriButtonVariant;
 };
-export declare type RequiredButtonProps = RequiredButtonLinkProps & {
+export declare type RequiredButtonLinkProps = RequiredButtonAndLinkProps & {
   label: string;
 };
-export declare type OptionalButtonProps = OptionalButtonLinkProps & KoliBriButtonVariantCustomClass & {
+export declare type OptionalButtonLinkProps = OptionalButtonAndLinkProps & {
   accessKey: string;
   id: string;
   on: KoliBriButtonCallbacks;
   type: KoliBriButtonType;
 };
-export declare type ButtonProps = Generic.Element.Members<RequiredButtonProps, OptionalButtonProps>;
-export declare type RequiredButtonStates = RequiredButtonLinkStates & {
+export declare type RequiredButtonLinkStates = RequiredButtonAndLinkStates & {
   label: string;
   type: KoliBriButtonType;
 };
-export declare type OptionalButtonStates = OptionalButtonLinkStates & KoliBriButtonVariantCustomClass & {
+export declare type OptionalButtonLinkStates = OptionalButtonAndLinkStates & KoliBriButtonVariantCustomClass & {
   accessKey: string;
   id: string;
   on: KoliBriButtonCallbacks;
 };
+export declare type RequiredButtonProps = RequiredButtonLinkProps;
+export declare type OptionalButtonProps = OptionalButtonLinkProps & KoliBriButtonVariantCustomClass;
+export declare type ButtonProps = Generic.Element.Members<RequiredButtonProps, OptionalButtonProps>;
+export declare type RequiredButtonStates = RequiredButtonLinkStates;
+export declare type OptionalButtonStates = OptionalButtonLinkStates & KoliBriButtonVariantCustomClass;
 export declare type ButtonStates = Generic.Element.Members<RequiredButtonStates, OptionalButtonStates>;
 export declare type LinkOnCallbacks = {
   [Events.onClick]?: EventCallback<Event>;
 };
 export declare type LinkTarget = '_blank' | '_parent' | '_self' | '_top' | string;
 export declare type LinkUseCase = 'text' | 'image' | 'nav';
-export declare type RequiredLinkProps = RequiredButtonLinkProps & unknown;
-export declare type OptionalLinkProps = OptionalButtonLinkProps & {
+export declare type RequiredLinkProps = RequiredButtonAndLinkProps & unknown;
+export declare type OptionalLinkProps = OptionalButtonAndLinkProps & {
   ariaSelected: boolean;
   fill: boolean;
   href: string;
@@ -86,8 +87,8 @@ export declare type OptionalLinkProps = OptionalButtonLinkProps & {
   useCase: LinkUseCase;
 };
 export declare type LinkProps = Generic.Element.Members<RequiredLinkProps, OptionalLinkProps>;
-export declare type RequiredLinkStates = RequiredButtonLinkStates & unknown;
-export declare type OptionalLinkStates = OptionalButtonLinkStates & {
+export declare type RequiredLinkStates = RequiredButtonAndLinkStates & unknown;
+export declare type OptionalLinkStates = OptionalButtonAndLinkStates & {
   ariaSelected: boolean;
   fill: boolean;
   href: string;
@@ -101,6 +102,10 @@ export declare type OptionalLinkStates = OptionalButtonLinkStates & {
   useCase: LinkUseCase;
 };
 export declare type LinkStates = Generic.Element.Members<RequiredLinkStates, OptionalLinkStates>;
-export declare const watchShowAs: (component: Generic.Element.Component, value?: KoliBriButtonLinkShowAs) => void;
+export declare type RequiredLinkButtonProps = RequiredLinkProps;
+export declare type OptionalLinkButtonProps = OptionalLinkProps & KoliBriButtonVariantCustomClass;
+export declare type RequiredLinkButtonStates = RequiredLinkStates;
+export declare type OptionalLinkButtonStates = OptionalLinkStates & KoliBriButtonVariantCustomClass;
+export declare type LinkButtonStates = Generic.Element.Members<RequiredLinkButtonStates, OptionalLinkButtonStates>;
 export declare const watchTooltipAlignment: (component: Generic.Element.Component, propName: string, value?: TooltipAlignment) => void;
 export {};

package/dist/types/types/input/control/number.d.ts

@@ -1 +1,28 @@
-export declare type InputNumberType = 'number' | 'date' | 'datetime-local' | 'month' | 'time' | 'week';
+import { KoliBriInputIcon } from '../../../components/input-text/types';
+import { ButtonProps } from '../../button-link';
+import { Stringified } from '../../common';
+import { InputTypeOnDefault, InputTypeOnOff } from '../types';
+export declare type InputDateType = 'date' | 'datetime-local' | 'month' | 'time' | 'week';
+export declare type InputNumberType = 'number' | InputDateType;
+export declare type OptionalInputProps<T> = {
+  accessKey: string;
+  alert: boolean;
+  autoComplete: InputTypeOnOff;
+  disabled: boolean;
+  error: string;
+  hideLabel: boolean;
+  hint: string;
+  icon: Stringified<KoliBriInputIcon>;
+  list: Stringified<string[]>;
+  max: T;
+  min: T;
+  name: string;
+  on: InputTypeOnDefault;
+  readOnly: boolean;
+  required: boolean;
+  smartButton: ButtonProps;
+  step: number;
+  tabIndex: number;
+  touched: boolean;
+  value: T;
+};

package/dist/types/types/input/iso8601.d.ts

@@ -0,0 +1,25 @@
+declare type D1 = '1';
+declare type D2 = D1 | '2';
+declare type D3 = D2 | '3';
+declare type D4 = D3 | '4';
+declare type D5 = D4 | '5';
+declare type D6 = D5 | '6';
+declare type D7 = D6 | '7';
+declare type D8 = D7 | '8';
+declare type D9 = D8 | '9';
+declare type D01 = D1 | '0';
+declare type D02 = D2 | '0';
+declare type D03 = D3 | '0';
+declare type D09 = D9 | '0';
+declare type Hour = `0${D9}` | `1${D09}` | `2${D03}`;
+declare type Year = `${number}`;
+declare type Month = `0${D9}` | `1${D02}`;
+declare type Day = `0${D9}` | `${D2}${D09}` | `3${D01}`;
+declare type CalendarWeek = `0${D9}` | `${D4}${D09}` | `5${D03}`;
+declare type IsoDate = `${Year}-${Month}-${Day}`;
+declare type IsoTime = `${Hour}:${number}:${number}` | `${Hour}:${number}:${number}.${number}`;
+declare type IsoLocalDateTime = `${IsoDate}T${IsoTime}`;
+declare type IsoMonth = `${Year}-${Month}`;
+declare type IsoWeek = `${Year}-W${CalendarWeek}`;
+export declare type Iso8601 = IsoDate | IsoTime | IsoLocalDateTime | IsoMonth | IsoWeek;
+export {};

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

@@ -26,7 +26,7 @@ declare type WatchNumberOptions = WatchOptions & {
   min?: number;
   max?: number;
 };
-export declare const watchValidator: <T extends unknown>(component: Generic.Element.Component, propName: string, validationFunction: (value?: T | undefined) => boolean, requiredGeneric: Set<string | null | undefined>, value?: T | undefined, options?: WatchOptions) => void;
+export declare const watchValidator: <T>(component: Generic.Element.Component, propName: string, validationFunction: (value?: T | undefined) => boolean, requiredGeneric: Set<string | null | undefined>, value?: T | undefined, options?: WatchOptions) => void;
 export declare const watchBoolean: (component: Generic.Element.Component, propName: string, value?: boolean, options?: WatchBooleanOptions) => void;
 export declare const watchString: (component: Generic.Element.Component, propName: string, value?: string, options?: WatchStringOptions) => void;
 export declare const watchNumber: (component: Generic.Element.Component, propName: string, value?: number, options?: WatchNumberOptions) => void;