@oiz/stzh-components 2.0.0-beta → 2.1.0-alpha

package/dist/types/index.d.ts

@@ -2,6 +2,7 @@ import { StzhLocaleFormats } from './utils/translation-utils';
 export declare type WindowStzhComponents = {
   version: string;
   locale: string;
+  pathMedia: string;
   pathTranslations: string;
   cacheTranslations: boolean;
   formats: StzhLocaleFormats;
@@ -12,6 +13,7 @@ declare global {
     stzhComponents: WindowStzhComponents;
     ReadSpeaker: any;
     rspkr: any;
+    proj4: any;
   }
 }
 export declare type StzhSortableUpdateEvent = {
@@ -25,6 +27,47 @@ export declare type StzhSortableDisableEvent = {
   component: "stzh-sortable";
   disabled: boolean;
 };
+export declare type OlmapLayer = {
+  title?: string;
+  thumbnailUrl: string;
+  options: {
+    url: string;
+    layer: string;
+    matrixSet: string;
+    origin: number[];
+    extent: number[];
+  };
+};
+export declare type StzhOlmapInitializedEvent = {
+  component: "stzh-olmap";
+};
+export declare type StzhOlmapPostRenderEvent = {
+  component: "stzh-olmap";
+};
+export declare type StzhOlmapMoveStartEvent = {
+  component: "stzh-olmap";
+};
+export declare type StzhOlmapMoveEndEvent = {
+  component: "stzh-olmap";
+};
+export declare type StzhStickyStuckTopEvent = {
+  component: "stzh-sticky";
+  sticky: boolean;
+};
+export declare type StzhStickyStuckBottomEvent = {
+  component: "stzh-sticky";
+  sticky: boolean;
+};
+export declare type StzhAnchornavItem = {
+  label: string;
+  href?: string;
+  icon?: string;
+};
+export declare type StzhAnchornavItemClickEvent = {
+  component: "stzh-anchornav";
+  item: StzhAnchornavItem;
+  originalEvent: MouseEvent;
+};
 export declare type StzhActionsetItem = {
   id: string;
   label?: string;
@@ -32,6 +75,8 @@ export declare type StzhActionsetItem = {
   iconPosition?: "left" | "right";
   iconOnly?: boolean;
   badge?: string;
+  badgeEmpty?: boolean;
+  badgeType?: "default" | "success" | "warning" | "error" | "info";
   variant?: "default" | "secondary" | "input" | "tertiary";
   size?: "default" | "small" | "tiny";
   badgePosition?: "icon" | "button";
@@ -40,12 +85,37 @@ export declare type StzhActionsetItem = {
 export declare type StzhActionsetItemClickEvent = {
   component: "stzh-actionset";
   action: StzhActionsetItem;
+  originalEvent: MouseEvent;
+};
+export declare type StzhAudioPlayEvent = {
+  component: "stzh-audio";
+};
+export declare type StzhAudioPlayingEvent = {
+  component: "stzh-audio";
+};
+export declare type StzhAudioPauseEvent = {
+  component: "stzh-audio";
+};
+export declare type StzhAudioReplayEvent = {
+  component: "stzh-audio";
+};
+export declare type StzhAudioEndEvent = {
+  component: "stzh-audio";
+};
+export declare type StzhAudioEndedEvent = {
+  component: "stzh-audio";
+};
+export declare type StzhAudioErrorEvent = {
+  component: "stzh-audio";
+  originalEvent: ErrorEvent;
 };
 export declare type StzhCardHeaderAction = {
   id: string;
   label?: string;
   icon?: string;
   badge?: string;
+  badgeEmpty?: boolean;
+  badgeType?: "default" | "success" | "warning" | "error" | "info";
   onlyCollapseText?: boolean;
 };
 export declare type StzhCardSubtitleClickEvent = {
@@ -148,7 +218,7 @@ export declare type StzhDatalistItemEntry = {
   label?: string;
   meta?: string;
   icon?: string;
-  href: string;
+  href?: string;
 };
 export declare type StzhDatalistItemActionClickEvent = {
   component: "stzh-datalist";
@@ -187,6 +257,7 @@ export declare type StzhDatamessagelistItemActionClickEvent = {
 export declare type StzhChipSelectItem = {
   label: string;
   value: string;
+  disabled?: boolean;
   variant?: "tag" | "filter" | "input";
   type?: "default" | "secondary";
   counter?: string;

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

@@ -221,7 +221,9 @@ export declare type ErrorHandler = (err: any, element?: HTMLElement) => void;
  */
 export declare const setMode: (handler: ResolutionHandler) => void;
 /**
- * getMode
+ * `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: {
@@ -234,6 +236,9 @@ export declare function setPlatformHelpers(helpers: {
 /**
  * Get the base path to where the assets can be found. Use `setAssetPath(path)`
  * 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;
 /**
@@ -246,22 +251,29 @@ export declare function getAssetPath(path: string): string;
  * `setAssetPath(document.currentScript.src)`, or using a bundler's replace plugin to
  * dynamically set the path at build time, such as `setAssetPath(process.env.ASSET_PATH)`.
  * But do note that this configuration depends on how your script is bundled, or lack of
- * bunding, and where your assets can be loaded from. Additionally custom bundling
+ * 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;
 /**
- * getElement
+ * 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;
 /**
  * Schedules a new render of the given instance or element even if no state changed.
  *
- * Notice `forceUpdate()` is not syncronous and might perform the DOM render in the next frame.
+ * Notice `forceUpdate()` is not synchronous and might perform the DOM render in the next frame.
+ *
+ * @param ref the node/element to force the re-render of
  */
 export declare function forceUpdate(ref: any): void;
 /**
  * getRenderingRef
+ * @returns the rendering ref
  */
 export declare function getRenderingRef(): any;
 export interface HTMLStencilElement extends HTMLElement {
@@ -272,6 +284,8 @@ export interface HTMLStencilElement extends HTMLElement {
  * in the best moment to perform DOM mutation without causing layout thrashing.
  *
  * For further information: https://developers.google.com/web/fundamentals/performance/rendering/avoid-large-complex-layouts-and-layout-thrashing
+ *
+ * @param task the DOM-write to schedule
  */
 export declare function writeTask(task: RafCallback): void;
 /**
@@ -279,6 +293,8 @@ export declare function writeTask(task: RafCallback): void;
  * in the best moment to perform DOM reads without causing layout thrashing.
  *
  * For further information: https://developers.google.com/web/fundamentals/performance/rendering/avoid-large-complex-layouts-and-layout-thrashing
+ *
+ * @param task the DOM-read to schedule
  */
 export declare function readTask(task: RafCallback): void;
 /**