@sankhyalabs/sankhyablocks 9.2.0-dev.14 → 9.2.0-dev.15

package/dist/collection/components/snk-pesquisa/snk-pesquisa.js

@@ -416,8 +416,20 @@ export class SnkPesquisa {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Fun\u00E7\u00E3o respons\u00E1vel em carregar os itens do componente snk-pesquisa."
+          "tags": [{
+              "name": "type",
+              "text": "{(text: string) => Promise<any>}"
+            }, {
+              "name": "param",
+              "text": "text Texto utilizado como argumento de pesquisa."
+            }, {
+              "name": "returns",
+              "text": "Promise com os dados da pesquisa."
+            }, {
+              "name": "example",
+              "text": "searchLoader={(text) => fetchItems(text)}"
+            }],
+          "text": "Fun\u00E7\u00E3o respons\u00E1vel em carregar os itens do componente snk-pesquisa.\nDeve retornar uma Promise com os dados encontrados."
         }
       },
       "treeLoader": {
@@ -435,8 +447,17 @@ export class SnkPesquisa {
         "required": false,
         "optional": true,
         "docs": {
-          "tags": [],
-          "text": "Fun\u00E7\u00E3o respons\u00E1vel por carregar a \u00E1rvore hier\u00E1rquica do componente"
+          "tags": [{
+              "name": "type",
+              "text": "{(text: string) => Promise<any>}"
+            }, {
+              "name": "param",
+              "text": "text Texto utilizado como argumento de pesquisa para a \u00E1rvore."
+            }, {
+              "name": "returns",
+              "text": "Promise com os dados da \u00E1rvore."
+            }],
+          "text": "Fun\u00E7\u00E3o respons\u00E1vel por carregar a \u00E1rvore hier\u00E1rquica do componente.\nOpcional. Caso n\u00E3o seja fornecida, o modo \u00E1rvore n\u00E3o estar\u00E1 dispon\u00EDvel."
         }
       },
       "selectItem": {
@@ -455,8 +476,20 @@ export class SnkPesquisa {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Fun\u00E7\u00E3o disparada ao selecionar um item."
+          "tags": [{
+              "name": "type",
+              "text": "{(option: IOption) => void}"
+            }, {
+              "name": "param",
+              "text": "option Item selecionado."
+            }, {
+              "name": "returns",
+              "text": "void"
+            }, {
+              "name": "example",
+              "text": "selectItem={(option) => handleSelect(option)}"
+            }],
+          "text": "Fun\u00E7\u00E3o disparada ao selecionar um item da pesquisa."
         }
       },
       "entityName": {
@@ -470,8 +503,14 @@ export class SnkPesquisa {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Nome da entidade onde a pesquisa \u00E9 aplicada."
+          "tags": [{
+              "name": "type",
+              "text": "{string}"
+            }, {
+              "name": "example",
+              "text": "entityName=\"Produto\""
+            }],
+          "text": "Nome da entidade sobre a qual a pesquisa ser\u00E1 realizada."
         },
         "attribute": "entity-name",
         "reflect": false
@@ -487,8 +526,17 @@ export class SnkPesquisa {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Argumentos que ser\u00E3o usados ao chamar a fun\u00E7\u00E3o searchLoader."
+          "tags": [{
+              "name": "type",
+              "text": "{string}"
+            }, {
+              "name": "mutable",
+              "text": undefined
+            }, {
+              "name": "example",
+              "text": "argument=\"Texto para pesquisa\""
+            }],
+          "text": "Argumento utilizado ao chamar a fun\u00E7\u00E3o searchLoader.\nPode ser alterado externamente."
         },
         "attribute": "argument",
         "reflect": false
@@ -504,8 +552,17 @@ export class SnkPesquisa {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Define se a popup de pesquisa possuir\u00E1 ou n\u00E3o modo Hierarquico."
+          "tags": [{
+              "name": "type",
+              "text": "{boolean}"
+            }, {
+              "name": "default",
+              "text": "false"
+            }, {
+              "name": "example",
+              "text": "isHierarchyEntity={true}"
+            }],
+          "text": "Define se a popup de pesquisa ter\u00E1 ou n\u00E3o modo hier\u00E1rquico."
         },
         "attribute": "is-hierarchy-entity",
         "reflect": false,
@@ -522,8 +579,17 @@ export class SnkPesquisa {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Define se permite sele\u00E7\u00E3o de items n\u00E3o anal\u00EDticos"
+          "tags": [{
+              "name": "type",
+              "text": "{boolean}"
+            }, {
+              "name": "default",
+              "text": "false"
+            }, {
+              "name": "example",
+              "text": "allowsNonAnalytic={true}"
+            }],
+          "text": "Define se permite a sele\u00E7\u00E3o de itens n\u00E3o anal\u00EDticos."
         },
         "attribute": "allows-non-analytic",
         "reflect": false,

package/dist/types/components/snk-pesquisa/snk-pesquisa.d.ts

@@ -28,30 +28,68 @@ export declare class SnkPesquisa {
   private _valideDataSource;
   /**
    * Função responsável em carregar os itens do componente snk-pesquisa.
+   * Deve retornar uma Promise com os dados encontrados.
+   *
+   * @type {(text: string) => Promise<any>}
+   * @param text Texto utilizado como argumento de pesquisa.
+   * @returns Promise com os dados da pesquisa.
+   * @example
+   * searchLoader={(text) => fetchItems(text)}
    */
   searchLoader: (text: string) => Promise<any>;
   /**
-   * Função responsável por carregar a árvore hierárquica do componente
+   * Função responsável por carregar a árvore hierárquica do componente.
+   * Opcional. Caso não seja fornecida, o modo árvore não estará disponível.
+   *
+   * @type {(text: string) => Promise<any>}
+   * @param text Texto utilizado como argumento de pesquisa para a árvore.
+   * @returns Promise com os dados da árvore.
    */
   treeLoader?: (text: string) => Promise<any>;
   /**
-   * Função disparada ao selecionar um item.
+   * Função disparada ao selecionar um item da pesquisa.
+   *
+   * @type {(option: IOption) => void}
+   * @param option Item selecionado.
+   * @returns void
+   * @example
+   * selectItem={(option) => handleSelect(option)}
    */
   selectItem: (option: IOption) => void;
   /**
-   * Nome da entidade onde a pesquisa é aplicada.
+   * Nome da entidade sobre a qual a pesquisa será realizada.
+   *
+   * @type {string}
+   * @example
+   * entityName="Produto"
    */
   entityName: string;
   /**
-   * Argumentos que serão usados ao chamar a função searchLoader.
+   * Argumento utilizado ao chamar a função searchLoader.
+   * Pode ser alterado externamente.
+   *
+   * @type {string}
+   * @mutable
+   * @example
+   * argument="Texto para pesquisa"
    */
   argument: string;
   /**
-   * Define se a popup de pesquisa possuirá ou não modo Hierarquico.
+   * Define se a popup de pesquisa terá ou não modo hierárquico.
+   *
+   * @type {boolean}
+   * @default false
+   * @example
+   * isHierarchyEntity={true}
    */
   isHierarchyEntity: boolean;
   /**
-   * Define se permite seleção de items não analíticos
+   * Define se permite a seleção de itens não analíticos.
+   *
+   * @type {boolean}
+   * @default false
+   * @example
+   * allowsNonAnalytic={true}
    */
   allowsNonAnalytic: boolean;
   observeArgument(): void;

package/dist/types/components.d.ts

@@ -2151,31 +2151,53 @@ export namespace Components {
     }
     interface SnkPesquisa {
         /**
-          * Define se permite seleção de items não analíticos
+          * Define se permite a seleção de itens não analíticos.
+          * @type {boolean}
+          * @default false
+          * @example allowsNonAnalytic={true}
          */
         "allowsNonAnalytic": boolean;
         /**
-          * Argumentos que serão usados ao chamar a função searchLoader.
+          * Argumento utilizado ao chamar a função searchLoader. Pode ser alterado externamente.
+          * @type {string}
+          * @mutable 
+          * @example argument="Texto para pesquisa"
          */
         "argument": string;
         /**
-          * Nome da entidade onde a pesquisa é aplicada.
+          * Nome da entidade sobre a qual a pesquisa será realizada.
+          * @type {string}
+          * @example entityName="Produto"
          */
         "entityName": string;
         /**
-          * Define se a popup de pesquisa possuirá ou não modo Hierarquico.
+          * Define se a popup de pesquisa terá ou não modo hierárquico.
+          * @type {boolean}
+          * @default false
+          * @example isHierarchyEntity={true}
          */
         "isHierarchyEntity": boolean;
         /**
-          * Função responsável em carregar os itens do componente snk-pesquisa.
+          * Função responsável em carregar os itens do componente snk-pesquisa. Deve retornar uma Promise com os dados encontrados.
+          * @type {(text: string) => Promise<any>}
+          * @param text Texto utilizado como argumento de pesquisa.
+          * @returns Promise com os dados da pesquisa.
+          * @example searchLoader={(text) => fetchItems(text)}
          */
         "searchLoader": (text: string) => Promise<any>;
         /**
-          * Função disparada ao selecionar um item.
+          * Função disparada ao selecionar um item da pesquisa.
+          * @type {(option: IOption) => void}
+          * @param option Item selecionado.
+          * @returns void
+          * @example selectItem={(option) => handleSelect(option)}
          */
         "selectItem": (option: IOption2) => void;
         /**
-          * Função responsável por carregar a árvore hierárquica do componente
+          * Função responsável por carregar a árvore hierárquica do componente. Opcional. Caso não seja fornecida, o modo árvore não estará disponível.
+          * @type {(text: string) => Promise<any>}
+          * @param text Texto utilizado como argumento de pesquisa para a árvore.
+          * @returns Promise com os dados da árvore.
          */
         "treeLoader"?: (text: string) => Promise<any>;
     }
@@ -4769,31 +4791,53 @@ declare namespace LocalJSX {
     }
     interface SnkPesquisa {
         /**
-          * Define se permite seleção de items não analíticos
+          * Define se permite a seleção de itens não analíticos.
+          * @type {boolean}
+          * @default false
+          * @example allowsNonAnalytic={true}
          */
         "allowsNonAnalytic"?: boolean;
         /**
-          * Argumentos que serão usados ao chamar a função searchLoader.
+          * Argumento utilizado ao chamar a função searchLoader. Pode ser alterado externamente.
+          * @type {string}
+          * @mutable 
+          * @example argument="Texto para pesquisa"
          */
         "argument"?: string;
         /**
-          * Nome da entidade onde a pesquisa é aplicada.
+          * Nome da entidade sobre a qual a pesquisa será realizada.
+          * @type {string}
+          * @example entityName="Produto"
          */
         "entityName"?: string;
         /**
-          * Define se a popup de pesquisa possuirá ou não modo Hierarquico.
+          * Define se a popup de pesquisa terá ou não modo hierárquico.
+          * @type {boolean}
+          * @default false
+          * @example isHierarchyEntity={true}
          */
         "isHierarchyEntity"?: boolean;
         /**
-          * Função responsável em carregar os itens do componente snk-pesquisa.
+          * Função responsável em carregar os itens do componente snk-pesquisa. Deve retornar uma Promise com os dados encontrados.
+          * @type {(text: string) => Promise<any>}
+          * @param text Texto utilizado como argumento de pesquisa.
+          * @returns Promise com os dados da pesquisa.
+          * @example searchLoader={(text) => fetchItems(text)}
          */
         "searchLoader"?: (text: string) => Promise<any>;
         /**
-          * Função disparada ao selecionar um item.
+          * Função disparada ao selecionar um item da pesquisa.
+          * @type {(option: IOption) => void}
+          * @param option Item selecionado.
+          * @returns void
+          * @example selectItem={(option) => handleSelect(option)}
          */
         "selectItem"?: (option: IOption2) => void;
         /**
-          * Função responsável por carregar a árvore hierárquica do componente
+          * Função responsável por carregar a árvore hierárquica do componente. Opcional. Caso não seja fornecida, o modo árvore não estará disponível.
+          * @type {(text: string) => Promise<any>}
+          * @param text Texto utilizado como argumento de pesquisa para a árvore.
+          * @returns Promise com os dados da árvore.
          */
         "treeLoader"?: (text: string) => Promise<any>;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sankhyalabs/sankhyablocks",
-  "version": "9.2.0-dev.14",
+  "version": "9.2.0-dev.15",
   "description": "Stencil Component Starter",
   "main": "dist/index.cjs.js",
   "module": "dist/index.js",