reneco-hierarchized-picker 0.2.6-beta.3 → 0.3.0

package/dist/cjs/reneco-hierarchized-picker.cjs.entry.js

@@ -17843,6 +17843,9 @@ const HierarchizedPickerComponent = class {
     this.hasFocus = undefined;
     this.errorToLog = '';
   }
+  /**
+   * This method returns the current component's value
+   */
   getValue() {
     var _a, _b, _c, _d;
     if (!this.theOptions.output) {
@@ -17938,9 +17941,15 @@ const HierarchizedPickerComponent = class {
       return !isEqual;
     }
   }
+  /**
+   * This method replaces the current component's options with the ones passed to the method
+   */
   async setOptions(newOptions) {
     this.setNewOption(newOptions);
   }
+  /**
+   * This method triggers a search inside of the tree based on the value passed to the method and displays the result
+   */
   async filterTree(searchedValue) {
     this.search(searchedValue);
   }
@@ -19161,7 +19170,9 @@ const HierarchizedPickerComponent = class {
   collapseAllNodes() {
     document.querySelectorAll('#tree-area-' + this.componentID + ' .treejs-node').forEach((item) => item.classList.add('treejs-node__close'));
   }
-  // Displays all selected nodes by deploying nodes that contain selected
+  /**
+   * This method display the current selected node to the user by expanding all it's parent nodes and scrolling inside the tree
+   */
   async showSelectedNodes(addDelay = false) {
     if (this.theOptions.multiple) {
       console.warn("You are not allowed to scroll to selected nodes in multiple mode");
@@ -19505,6 +19516,9 @@ const HierarchizedPickerComponent = class {
       this.displayPickerError('Error(s) when loading tree default value(s)!');
     }
   }
+  /**
+   * This method clears the component from any selected value(s)
+   */
   async clearPicker() {
     let oldValue = await this.getValue();
     // Multiple picker : uncheck element

package/dist/collection/components/hierarchized-picker/hierarchized-picker.js

@@ -63,6 +63,9 @@ export class HierarchizedPickerComponent {
     this.hasFocus = undefined;
     this.errorToLog = '';
   }
+  /**
+   * This method returns the current component's value
+   */
   getValue() {
     var _a, _b, _c, _d;
     if (!this.theOptions.output) {
@@ -158,9 +161,15 @@ export class HierarchizedPickerComponent {
       return !isEqual;
     }
   }
+  /**
+   * This method replaces the current component's options with the ones passed to the method
+   */
   async setOptions(newOptions) {
     this.setNewOption(newOptions);
   }
+  /**
+   * This method triggers a search inside of the tree based on the value passed to the method and displays the result
+   */
   async filterTree(searchedValue) {
     this.search(searchedValue);
   }
@@ -1384,7 +1393,9 @@ export class HierarchizedPickerComponent {
   collapseAllNodes() {
     document.querySelectorAll('#tree-area-' + this.componentID + ' .treejs-node').forEach((item) => item.classList.add('treejs-node__close'));
   }
-  // Displays all selected nodes by deploying nodes that contain selected
+  /**
+   * This method display the current selected node to the user by expanding all it's parent nodes and scrolling inside the tree
+   */
   async showSelectedNodes(addDelay = false) {
     if (this.theOptions.multiple) {
       console.warn("You are not allowed to scroll to selected nodes in multiple mode");
@@ -1728,6 +1739,9 @@ export class HierarchizedPickerComponent {
       this.displayPickerError('Error(s) when loading tree default value(s)!');
     }
   }
+  /**
+   * This method clears the component from any selected value(s)
+   */
   async clearPicker() {
     let oldValue = await this.getValue();
     // Multiple picker : uncheck element
@@ -1840,7 +1854,7 @@ export class HierarchizedPickerComponent {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "The component's options as described in the IConf interface"
         }
       },
       "valueChangeCallback": {
@@ -1859,7 +1873,7 @@ export class HierarchizedPickerComponent {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "The callback Function called when the value change of the component is triggered"
         }
       },
       "disabled": {
@@ -1874,7 +1888,7 @@ export class HierarchizedPickerComponent {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "The disabled property allow the component to be locked when set at true as any standard HTML component would be"
         },
         "attribute": "disabled",
         "reflect": false
@@ -1891,7 +1905,7 @@ export class HierarchizedPickerComponent {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "When set, this property allows the replacement of the [options] property of the component with the set value as the method [setOptions] would\r\nThis property exists as an alternative for react context in which we can't directly call the component's method [setOptions]"
         },
         "attribute": "newoptions",
         "reflect": false
@@ -1908,7 +1922,7 @@ export class HierarchizedPickerComponent {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "When set, this property triggers a search of the set value inside the tree as the method [filterTree] would\r\nThis property exists as an alternative for react context in which we can't directly call the component's method [filterTree]"
         },
         "attribute": "newfilter",
         "reflect": false
@@ -1938,7 +1952,7 @@ export class HierarchizedPickerComponent {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "This event is emitted when the component's value is modified, providing the new value of the component"
         },
         "complexType": {
           "original": "any",
@@ -1953,7 +1967,7 @@ export class HierarchizedPickerComponent {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "This event can only be emitted when the component is in tree mode and the drag and drop feature enabled\r\nIt will fire when a node is dropped inside of the tree and provides the node after, before or in which the node is dropped along with it's ID"
         },
         "complexType": {
           "original": "any",
@@ -1968,7 +1982,7 @@ export class HierarchizedPickerComponent {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "This event can only be emitted when the component is in tree mode and the menu item context is set\r\nIt will fire when the user clicks in the menu item, providing the item which has been clicked in the menu along with the focused node's ID"
         },
         "complexType": {
           "original": "any",
@@ -1991,7 +2005,7 @@ export class HierarchizedPickerComponent {
           "return": "Promise<any>"
         },
         "docs": {
-          "text": "",
+          "text": "This method returns the current component's value",
           "tags": []
         }
       },
@@ -2014,7 +2028,7 @@ export class HierarchizedPickerComponent {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "",
+          "text": "This method replaces the current component's options with the ones passed to the method",
           "tags": []
         }
       },
@@ -2033,7 +2047,7 @@ export class HierarchizedPickerComponent {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "",
+          "text": "This method triggers a search inside of the tree based on the value passed to the method and displays the result",
           "tags": []
         }
       },
@@ -2055,7 +2069,7 @@ export class HierarchizedPickerComponent {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "",
+          "text": "This method display the current selected node to the user by expanding all it's parent nodes and scrolling inside the tree",
           "tags": []
         }
       },
@@ -2071,7 +2085,7 @@ export class HierarchizedPickerComponent {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "",
+          "text": "This method clears the component from any selected value(s)",
           "tags": []
         }
       }

package/dist/custom-elements/index.js

@@ -17841,6 +17841,9 @@ const HierarchizedPickerComponent = class extends HTMLElement {
     this.hasFocus = undefined;
     this.errorToLog = '';
   }
+  /**
+   * This method returns the current component's value
+   */
   getValue() {
     var _a, _b, _c, _d;
     if (!this.theOptions.output) {
@@ -17936,9 +17939,15 @@ const HierarchizedPickerComponent = class extends HTMLElement {
       return !isEqual;
     }
   }
+  /**
+   * This method replaces the current component's options with the ones passed to the method
+   */
   async setOptions(newOptions) {
     this.setNewOption(newOptions);
   }
+  /**
+   * This method triggers a search inside of the tree based on the value passed to the method and displays the result
+   */
   async filterTree(searchedValue) {
     this.search(searchedValue);
   }
@@ -19159,7 +19168,9 @@ const HierarchizedPickerComponent = class extends HTMLElement {
   collapseAllNodes() {
     document.querySelectorAll('#tree-area-' + this.componentID + ' .treejs-node').forEach((item) => item.classList.add('treejs-node__close'));
   }
-  // Displays all selected nodes by deploying nodes that contain selected
+  /**
+   * This method display the current selected node to the user by expanding all it's parent nodes and scrolling inside the tree
+   */
   async showSelectedNodes(addDelay = false) {
     if (this.theOptions.multiple) {
       console.warn("You are not allowed to scroll to selected nodes in multiple mode");
@@ -19503,6 +19514,9 @@ const HierarchizedPickerComponent = class extends HTMLElement {
       this.displayPickerError('Error(s) when loading tree default value(s)!');
     }
   }
+  /**
+   * This method clears the component from any selected value(s)
+   */
   async clearPicker() {
     let oldValue = await this.getValue();
     // Multiple picker : uncheck element

package/dist/esm/reneco-hierarchized-picker.entry.js

@@ -17839,6 +17839,9 @@ const HierarchizedPickerComponent = class {
     this.hasFocus = undefined;
     this.errorToLog = '';
   }
+  /**
+   * This method returns the current component's value
+   */
   getValue() {
     var _a, _b, _c, _d;
     if (!this.theOptions.output) {
@@ -17934,9 +17937,15 @@ const HierarchizedPickerComponent = class {
       return !isEqual;
     }
   }
+  /**
+   * This method replaces the current component's options with the ones passed to the method
+   */
   async setOptions(newOptions) {
     this.setNewOption(newOptions);
   }
+  /**
+   * This method triggers a search inside of the tree based on the value passed to the method and displays the result
+   */
   async filterTree(searchedValue) {
     this.search(searchedValue);
   }
@@ -19157,7 +19166,9 @@ const HierarchizedPickerComponent = class {
   collapseAllNodes() {
     document.querySelectorAll('#tree-area-' + this.componentID + ' .treejs-node').forEach((item) => item.classList.add('treejs-node__close'));
   }
-  // Displays all selected nodes by deploying nodes that contain selected
+  /**
+   * This method display the current selected node to the user by expanding all it's parent nodes and scrolling inside the tree
+   */
   async showSelectedNodes(addDelay = false) {
     if (this.theOptions.multiple) {
       console.warn("You are not allowed to scroll to selected nodes in multiple mode");
@@ -19501,6 +19512,9 @@ const HierarchizedPickerComponent = class {
       this.displayPickerError('Error(s) when loading tree default value(s)!');
     }
   }
+  /**
+   * This method clears the component from any selected value(s)
+   */
   async clearPicker() {
     let oldValue = await this.getValue();
     // Multiple picker : uncheck element

package/dist/types/components/hierarchized-picker/hierarchized-picker.d.ts

@@ -7,12 +7,29 @@ export declare class HierarchizedPickerComponent {
   el: HTMLElement;
   scrollable: HTMLDivElement;
   loader: HTMLDivElement;
+  /**
+   * The component's options as described in the IConf interface
+   */
   options: IConf;
+  /**
+   * The callback Function called when the value change of the component is triggered
+   */
   valueChangeCallback: Function;
+  /**
+   * The disabled property allow the component to be locked when set at true as any standard HTML component would be
+   */
   disabled: boolean;
   isDisabled: boolean;
   theOptions: IConf;
+  /**
+   * When set, this property allows the replacement of the [options] property of the component with the set value as the method [setOptions] would
+   * This property exists as an alternative for react context in which we can't directly call the component's method [setOptions]
+   */
   newoptions: string;
+  /**
+   * When set, this property triggers a search of the set value inside the tree as the method [filterTree] would
+   * This property exists as an alternative for react context in which we can't directly call the component's method [filterTree]
+   */
   newfilter: string;
   componentID: string;
   rawData: any;
@@ -32,9 +49,23 @@ export declare class HierarchizedPickerComponent {
     (message?: any, ...optionalParams: any[]): void;
   };
   errorToLog: string;
+  /**
+   * This event is emitted when the component's value is modified, providing the new value of the component
+   */
   valueChange: EventEmitter<any>;
+  /**
+   * This event can only be emitted when the component is in tree mode and the drag and drop feature enabled
+   * It will fire when a node is dropped inside of the tree and provides the node after, before or in which the node is dropped along with it's ID
+   */
   itemDropped: EventEmitter<any>;
+  /**
+   * This event can only be emitted when the component is in tree mode and the menu item context is set
+   * It will fire when the user clicks in the menu item, providing the item which has been clicked in the menu along with the focused node's ID
+   */
   itemContextMenuItemClick: EventEmitter<any>;
+  /**
+   * This method returns the current component's value
+   */
   getValue(): Promise<any>;
   logError(messageToLog: any): void;
   reloadCurrentValues(): void;
@@ -43,7 +74,13 @@ export declare class HierarchizedPickerComponent {
   setNewFilter(newfilter: any): void;
   optionsChange(newValue: any, oldValue: any): void;
   isChangeInOptions(newV: IConf, oldV: IConf): boolean;
+  /**
+   * This method replaces the current component's options with the ones passed to the method
+   */
   setOptions(newOptions: IConf): Promise<void>;
+  /**
+   * This method triggers a search inside of the tree based on the value passed to the method and displays the result
+   */
   filterTree(searchedValue: string): Promise<void>;
   isInstanceOfIConf(object: any): boolean;
   initComponent(): Promise<void>;
@@ -97,6 +134,9 @@ export declare class HierarchizedPickerComponent {
   focusMainInput(): Promise<void>;
   focusModal(): Promise<void>;
   collapseAllNodes(): void;
+  /**
+   * This method display the current selected node to the user by expanding all it's parent nodes and scrolling inside the tree
+   */
   showSelectedNodes(addDelay?: boolean): Promise<void>;
   showTree(focused: any): void;
   editValue(node: any): void;
@@ -112,6 +152,9 @@ export declare class HierarchizedPickerComponent {
   componentDidLoad(): void;
   checkFields(values: any, allowSetValueOnClick?: boolean): void;
   formatDefaultValue(): void;
+  /**
+   * This method clears the component from any selected value(s)
+   */
   clearPicker(): Promise<void>;
   focusInSearchEvent(_event: any): void;
   focusOutSearchEvent(_event: any): void;

package/dist/types/components.d.ts

@@ -8,15 +8,45 @@ import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
 import { IConf } from "./utils/utils";
 export namespace Components {
     interface RenecoHierarchizedPicker {
+        /**
+          * This method clears the component from any selected value(s)
+         */
         "clearPicker": () => Promise<void>;
+        /**
+          * The disabled property allow the component to be locked when set at true as any standard HTML component would be
+         */
         "disabled": boolean;
+        /**
+          * This method triggers a search inside of the tree based on the value passed to the method and displays the result
+         */
         "filterTree": (searchedValue: string) => Promise<void>;
+        /**
+          * This method returns the current component's value
+         */
         "getValue": () => Promise<any>;
+        /**
+          * When set, this property triggers a search of the set value inside the tree as the method [filterTree] would This property exists as an alternative for react context in which we can't directly call the component's method [filterTree]
+         */
         "newfilter": string;
+        /**
+          * When set, this property allows the replacement of the [options] property of the component with the set value as the method [setOptions] would This property exists as an alternative for react context in which we can't directly call the component's method [setOptions]
+         */
         "newoptions": string;
+        /**
+          * The component's options as described in the IConf interface
+         */
         "options": IConf;
+        /**
+          * This method replaces the current component's options with the ones passed to the method
+         */
         "setOptions": (newOptions: IConf) => Promise<void>;
+        /**
+          * This method display the current selected node to the user by expanding all it's parent nodes and scrolling inside the tree
+         */
         "showSelectedNodes": (addDelay?: boolean) => Promise<void>;
+        /**
+          * The callback Function called when the value change of the component is triggered
+         */
         "valueChangeCallback": Function;
     }
 }
@@ -37,13 +67,37 @@ declare global {
 }
 declare namespace LocalJSX {
     interface RenecoHierarchizedPicker {
+        /**
+          * The disabled property allow the component to be locked when set at true as any standard HTML component would be
+         */
         "disabled"?: boolean;
+        /**
+          * When set, this property triggers a search of the set value inside the tree as the method [filterTree] would This property exists as an alternative for react context in which we can't directly call the component's method [filterTree]
+         */
         "newfilter"?: string;
+        /**
+          * When set, this property allows the replacement of the [options] property of the component with the set value as the method [setOptions] would This property exists as an alternative for react context in which we can't directly call the component's method [setOptions]
+         */
         "newoptions"?: string;
+        /**
+          * This event can only be emitted when the component is in tree mode and the menu item context is set It will fire when the user clicks in the menu item, providing the item which has been clicked in the menu along with the focused node's ID
+         */
         "onItemContextMenuItemClick"?: (event: RenecoHierarchizedPickerCustomEvent<any>) => void;
+        /**
+          * This event can only be emitted when the component is in tree mode and the drag and drop feature enabled It will fire when a node is dropped inside of the tree and provides the node after, before or in which the node is dropped along with it's ID
+         */
         "onItemDropped"?: (event: RenecoHierarchizedPickerCustomEvent<any>) => void;
+        /**
+          * This event is emitted when the component's value is modified, providing the new value of the component
+         */
         "onValueChange"?: (event: RenecoHierarchizedPickerCustomEvent<any>) => void;
+        /**
+          * The component's options as described in the IConf interface
+         */
         "options"?: IConf;
+        /**
+          * The callback Function called when the value change of the component is triggered
+         */
         "valueChangeCallback"?: Function;
     }
     interface IntrinsicElements {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reneco-hierarchized-picker",
-  "version": "0.2.6-beta.3",
+  "version": "0.3.0",
   "description": "Stencil Component Starter",
   "main": "dist/index.cjs.js",
   "module": "dist/custom-elements/index.js",
@@ -19,7 +19,8 @@
     "start": "stencil build --dev --watch --serve",
     "test": "stencil test --spec --forceExit & echo ----------------!! If errors, solve issues in order and retry after each solving !!-------------- TODO > Stencil v3 !!",
     "test.watch": "stencil test --spec --e2e --watchAll",
-    "generate": "stencil generate"
+    "generate": "stencil generate",
+    "generate-doc": "del src\\components\\hierarchized-picker\\readme.md && npx stencil docs && node customize-readme.js"
   },
   "dependencies": {
     "@stencil/core": "^2.22.3",

package/readme.md

@@ -1,69 +0,0 @@
-# hierarchized-picker
-
-
-
-<!-- Auto Generated Below -->
-
-
-## Properties
-
-| Property              | Attribute  | Description | Type       | Default     |
-| --------------------- | ---------- | ----------- | ---------- | ----------- |
-| `disabled`            | `disabled` |             | `boolean`  | `undefined` |
-| `options`             | --         |             | `IConf`    | `undefined` |
-| `valueChangeCallback` | --         |             | `Function` | `undefined` |
-
-
-## Events
-
-| Event         | Description | Type               |
-| ------------- | ----------- | ------------------ |
-| `valueChange` |             | `CustomEvent<any>` |
-
-
-## Methods
-
-### `getValue() => Promise<any>`
-
-
-
-#### Returns
-
-Type: `Promise<any>`
-
-
-
-### `setOptions(newOptions: any) => Promise<void>`
-
-
-
-#### Returns
-
-Type: `Promise<void>`
-
-
-
-
-## Dependencies
-
-### Used by
-
- - [ns-schema-form](../ns-schema-form)
-
-### Depends on
-
-- ion-input
-- ion-spinner
-
-### Graph
-```mermaid
-graph TD;
-  hierarchized-picker --> ion-input
-  hierarchized-picker --> ion-spinner
-  ns-schema-form --> hierarchized-picker
-  style hierarchized-picker fill:#f9f,stroke:#333,stroke-width:4px
-```
-
-----------------------------------------------
-
-*Built with [StencilJS](https://stenciljs.com/)*