@biggive/components 1.0.96 → 1.0.98

package/dist/types/components.d.ts

@@ -345,18 +345,40 @@ export namespace Components {
         "spaceBelow": number;
     }
     interface BiggiveCampaignCardFilterGrid {
+        /**
+          * JSON array of beneficary key/values
+         */
+        "beneficaryOptions": string;
         /**
           * Defines the text on the search button
          */
         "buttonText": string;
+        /**
+          * JSON array of category key/values
+         */
+        "categoryOptions": string;
+        "filterBeneficary": string;
+        "filterCategory": string;
+        "filterFunding": string;
+        "filterLocation": string;
+        /**
+          * JSON array of funding key/values
+         */
+        "fundingOptions": string;
         /**
           * Intro
          */
         "intro": string;
+        /**
+          * JSON array of location key/values
+         */
+        "locationOptions": string;
         /**
           * Defines the text displayed as the placeholder in the input field before the user types anything
          */
         "placeholderText": string;
+        "searchText": string;
+        "sortBy": string;
         /**
           * Space below component
          */
@@ -443,6 +465,26 @@ export namespace Components {
     interface BiggiveForm {
     }
     interface BiggiveFormFieldSelect {
+        /**
+          * Placeholder
+         */
+        "placeholder": string;
+        "selectedLabel": string;
+        "selectedValue": string;
+        /**
+          * Space below component
+         */
+        "spaceBelow": number;
+    }
+    interface BiggiveFormFieldSelectOption {
+        /**
+          * Label
+         */
+        "label": string;
+        /**
+          * Value
+         */
+        "value": string;
     }
     interface BiggiveFormattedText {
         /**
@@ -533,6 +575,14 @@ export namespace Components {
           * Full URL of a main hero image.
          */
         "mainImage": string;
+        /**
+          * Horizontal alignment of image
+         */
+        "mainImageAlignHorizontal": string;
+        /**
+          * Vertical alignment of image
+         */
+        "mainImageAlignVertical": string;
         /**
           * Hero image title, typically the page.
          */
@@ -666,6 +716,26 @@ export namespace Components {
          */
         "url": string;
     }
+    interface BiggiveNavGroup {
+        /**
+          * Inline
+         */
+        "inline": boolean;
+    }
+    interface BiggiveNavItem {
+        /**
+          * URL
+         */
+        "iconColour": string;
+        /**
+          * Label
+         */
+        "label": string;
+        /**
+          * URL
+         */
+        "url": string;
+    }
     interface BiggivePageColumn {
     }
     interface BiggivePageColumns {
@@ -692,6 +762,9 @@ export namespace Components {
          */
         "spaceBelow": number;
     }
+    interface BiggivePopup {
+        "open": () => Promise<void>;
+    }
     interface BiggiveProgressBar {
         /**
           * Colour Scheme
@@ -881,6 +954,14 @@ export interface BiggiveCampaignCardFilterGridCustomEvent<T> extends CustomEvent
     detail: T;
     target: HTMLBiggiveCampaignCardFilterGridElement;
 }
+export interface BiggiveFormFieldSelectCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLBiggiveFormFieldSelectElement;
+}
+export interface BiggiveFormFieldSelectOptionCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLBiggiveFormFieldSelectOptionElement;
+}
 export interface BiggiveSearchCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLBiggiveSearchElement;
@@ -976,6 +1057,12 @@ declare global {
         prototype: HTMLBiggiveFormFieldSelectElement;
         new (): HTMLBiggiveFormFieldSelectElement;
     };
+    interface HTMLBiggiveFormFieldSelectOptionElement extends Components.BiggiveFormFieldSelectOption, HTMLStencilElement {
+    }
+    var HTMLBiggiveFormFieldSelectOptionElement: {
+        prototype: HTMLBiggiveFormFieldSelectOptionElement;
+        new (): HTMLBiggiveFormFieldSelectOptionElement;
+    };
     interface HTMLBiggiveFormattedTextElement extends Components.BiggiveFormattedText, HTMLStencilElement {
     }
     var HTMLBiggiveFormattedTextElement: {
@@ -1030,6 +1117,18 @@ declare global {
         prototype: HTMLBiggiveMiscIconElement;
         new (): HTMLBiggiveMiscIconElement;
     };
+    interface HTMLBiggiveNavGroupElement extends Components.BiggiveNavGroup, HTMLStencilElement {
+    }
+    var HTMLBiggiveNavGroupElement: {
+        prototype: HTMLBiggiveNavGroupElement;
+        new (): HTMLBiggiveNavGroupElement;
+    };
+    interface HTMLBiggiveNavItemElement extends Components.BiggiveNavItem, HTMLStencilElement {
+    }
+    var HTMLBiggiveNavItemElement: {
+        prototype: HTMLBiggiveNavItemElement;
+        new (): HTMLBiggiveNavItemElement;
+    };
     interface HTMLBiggivePageColumnElement extends Components.BiggivePageColumn, HTMLStencilElement {
     }
     var HTMLBiggivePageColumnElement: {
@@ -1048,6 +1147,12 @@ declare global {
         prototype: HTMLBiggivePageSectionElement;
         new (): HTMLBiggivePageSectionElement;
     };
+    interface HTMLBiggivePopupElement extends Components.BiggivePopup, HTMLStencilElement {
+    }
+    var HTMLBiggivePopupElement: {
+        prototype: HTMLBiggivePopupElement;
+        new (): HTMLBiggivePopupElement;
+    };
     interface HTMLBiggiveProgressBarElement extends Components.BiggiveProgressBar, HTMLStencilElement {
     }
     var HTMLBiggiveProgressBarElement: {
@@ -1124,6 +1229,7 @@ declare global {
         "biggive-footer": HTMLBiggiveFooterElement;
         "biggive-form": HTMLBiggiveFormElement;
         "biggive-form-field-select": HTMLBiggiveFormFieldSelectElement;
+        "biggive-form-field-select-option": HTMLBiggiveFormFieldSelectOptionElement;
         "biggive-formatted-text": HTMLBiggiveFormattedTextElement;
         "biggive-grid": HTMLBiggiveGridElement;
         "biggive-header": HTMLBiggiveHeaderElement;
@@ -1133,9 +1239,12 @@ declare global {
         "biggive-image": HTMLBiggiveImageElement;
         "biggive-image-feature": HTMLBiggiveImageFeatureElement;
         "biggive-misc-icon": HTMLBiggiveMiscIconElement;
+        "biggive-nav-group": HTMLBiggiveNavGroupElement;
+        "biggive-nav-item": HTMLBiggiveNavItemElement;
         "biggive-page-column": HTMLBiggivePageColumnElement;
         "biggive-page-columns": HTMLBiggivePageColumnsElement;
         "biggive-page-section": HTMLBiggivePageSectionElement;
+        "biggive-popup": HTMLBiggivePopupElement;
         "biggive-progress-bar": HTMLBiggiveProgressBarElement;
         "biggive-quote": HTMLBiggiveQuoteElement;
         "biggive-search": HTMLBiggiveSearchElement;
@@ -1488,22 +1597,44 @@ declare namespace LocalJSX {
         "spaceBelow"?: number;
     }
     interface BiggiveCampaignCardFilterGrid {
+        /**
+          * JSON array of beneficary key/values
+         */
+        "beneficaryOptions"?: string;
         /**
           * Defines the text on the search button
          */
         "buttonText"?: string;
+        /**
+          * JSON array of category key/values
+         */
+        "categoryOptions"?: string;
+        "filterBeneficary"?: string;
+        "filterCategory"?: string;
+        "filterFunding"?: string;
+        "filterLocation"?: string;
+        /**
+          * JSON array of funding key/values
+         */
+        "fundingOptions"?: string;
         /**
           * Intro
          */
         "intro"?: string;
         /**
-          * This event `doTextSearch` event is emitted and propogates to the parent component which handles it
+          * JSON array of location key/values
          */
-        "onDoTextSearch"?: (event: BiggiveCampaignCardFilterGridCustomEvent<string>) => void;
+        "locationOptions"?: string;
+        /**
+          * This event `doChange` event is emitted and propogates to the parent component which handles it
+         */
+        "onDoSearchAndFilterUpdate"?: (event: BiggiveCampaignCardFilterGridCustomEvent<object>) => void;
         /**
           * Defines the text displayed as the placeholder in the input field before the user types anything
          */
         "placeholderText"?: string;
+        "searchText"?: string;
+        "sortBy"?: string;
         /**
           * Space below component
          */
@@ -1590,6 +1721,34 @@ declare namespace LocalJSX {
     interface BiggiveForm {
     }
     interface BiggiveFormFieldSelect {
+        /**
+          * This event `doChange` event is emitted and propogates to the parent component which handles it
+         */
+        "onDoSelectChange"?: (event: BiggiveFormFieldSelectCustomEvent<object>) => void;
+        /**
+          * Placeholder
+         */
+        "placeholder"?: string;
+        "selectedLabel"?: string;
+        "selectedValue"?: string;
+        /**
+          * Space below component
+         */
+        "spaceBelow"?: number;
+    }
+    interface BiggiveFormFieldSelectOption {
+        /**
+          * Label
+         */
+        "label"?: string;
+        /**
+          * This event `doOptionSelect` event is emitted and propogates to the parent component which handles it
+         */
+        "onDoOptionSelect"?: (event: BiggiveFormFieldSelectOptionCustomEvent<object>) => void;
+        /**
+          * Value
+         */
+        "value"?: string;
     }
     interface BiggiveFormattedText {
         /**
@@ -1680,6 +1839,14 @@ declare namespace LocalJSX {
           * Full URL of a main hero image.
          */
         "mainImage"?: string;
+        /**
+          * Horizontal alignment of image
+         */
+        "mainImageAlignHorizontal"?: string;
+        /**
+          * Vertical alignment of image
+         */
+        "mainImageAlignVertical"?: string;
         /**
           * Hero image title, typically the page.
          */
@@ -1813,6 +1980,26 @@ declare namespace LocalJSX {
          */
         "url"?: string;
     }
+    interface BiggiveNavGroup {
+        /**
+          * Inline
+         */
+        "inline"?: boolean;
+    }
+    interface BiggiveNavItem {
+        /**
+          * URL
+         */
+        "iconColour"?: string;
+        /**
+          * Label
+         */
+        "label"?: string;
+        /**
+          * URL
+         */
+        "url"?: string;
+    }
     interface BiggivePageColumn {
     }
     interface BiggivePageColumns {
@@ -1839,6 +2026,8 @@ declare namespace LocalJSX {
          */
         "spaceBelow"?: number;
     }
+    interface BiggivePopup {
+    }
     interface BiggiveProgressBar {
         /**
           * Colour Scheme
@@ -2043,6 +2232,7 @@ declare namespace LocalJSX {
         "biggive-footer": BiggiveFooter;
         "biggive-form": BiggiveForm;
         "biggive-form-field-select": BiggiveFormFieldSelect;
+        "biggive-form-field-select-option": BiggiveFormFieldSelectOption;
         "biggive-formatted-text": BiggiveFormattedText;
         "biggive-grid": BiggiveGrid;
         "biggive-header": BiggiveHeader;
@@ -2052,9 +2242,12 @@ declare namespace LocalJSX {
         "biggive-image": BiggiveImage;
         "biggive-image-feature": BiggiveImageFeature;
         "biggive-misc-icon": BiggiveMiscIcon;
+        "biggive-nav-group": BiggiveNavGroup;
+        "biggive-nav-item": BiggiveNavItem;
         "biggive-page-column": BiggivePageColumn;
         "biggive-page-columns": BiggivePageColumns;
         "biggive-page-section": BiggivePageSection;
+        "biggive-popup": BiggivePopup;
         "biggive-progress-bar": BiggiveProgressBar;
         "biggive-quote": BiggiveQuote;
         "biggive-search": BiggiveSearch;
@@ -2086,6 +2279,7 @@ declare module "@stencil/core" {
             "biggive-footer": LocalJSX.BiggiveFooter & JSXBase.HTMLAttributes<HTMLBiggiveFooterElement>;
             "biggive-form": LocalJSX.BiggiveForm & JSXBase.HTMLAttributes<HTMLBiggiveFormElement>;
             "biggive-form-field-select": LocalJSX.BiggiveFormFieldSelect & JSXBase.HTMLAttributes<HTMLBiggiveFormFieldSelectElement>;
+            "biggive-form-field-select-option": LocalJSX.BiggiveFormFieldSelectOption & JSXBase.HTMLAttributes<HTMLBiggiveFormFieldSelectOptionElement>;
             "biggive-formatted-text": LocalJSX.BiggiveFormattedText & JSXBase.HTMLAttributes<HTMLBiggiveFormattedTextElement>;
             "biggive-grid": LocalJSX.BiggiveGrid & JSXBase.HTMLAttributes<HTMLBiggiveGridElement>;
             "biggive-header": LocalJSX.BiggiveHeader & JSXBase.HTMLAttributes<HTMLBiggiveHeaderElement>;
@@ -2095,9 +2289,12 @@ declare module "@stencil/core" {
             "biggive-image": LocalJSX.BiggiveImage & JSXBase.HTMLAttributes<HTMLBiggiveImageElement>;
             "biggive-image-feature": LocalJSX.BiggiveImageFeature & JSXBase.HTMLAttributes<HTMLBiggiveImageFeatureElement>;
             "biggive-misc-icon": LocalJSX.BiggiveMiscIcon & JSXBase.HTMLAttributes<HTMLBiggiveMiscIconElement>;
+            "biggive-nav-group": LocalJSX.BiggiveNavGroup & JSXBase.HTMLAttributes<HTMLBiggiveNavGroupElement>;
+            "biggive-nav-item": LocalJSX.BiggiveNavItem & JSXBase.HTMLAttributes<HTMLBiggiveNavItemElement>;
             "biggive-page-column": LocalJSX.BiggivePageColumn & JSXBase.HTMLAttributes<HTMLBiggivePageColumnElement>;
             "biggive-page-columns": LocalJSX.BiggivePageColumns & JSXBase.HTMLAttributes<HTMLBiggivePageColumnsElement>;
             "biggive-page-section": LocalJSX.BiggivePageSection & JSXBase.HTMLAttributes<HTMLBiggivePageSectionElement>;
+            "biggive-popup": LocalJSX.BiggivePopup & JSXBase.HTMLAttributes<HTMLBiggivePopupElement>;
             "biggive-progress-bar": LocalJSX.BiggiveProgressBar & JSXBase.HTMLAttributes<HTMLBiggiveProgressBarElement>;
             "biggive-quote": LocalJSX.BiggiveQuote & JSXBase.HTMLAttributes<HTMLBiggiveQuoteElement>;
             "biggive-search": LocalJSX.BiggiveSearch & JSXBase.HTMLAttributes<HTMLBiggiveSearchElement>;

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;
 /**

package/hydrate/index.d.ts

@@ -1,4 +1,4 @@
-// Generated by dts-bundle-generator v5.3.0
+// Generated by dts-bundle-generator v7.0.0
 
 export declare function createWindowFromHtml(templateHtml: string, uniqueId: string): any;
 export interface HydrateDocumentOptions {