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

package/dist/collection/components/snk-personalized-filter/snk-personalized-filter.js

@@ -1,3 +1,21 @@
+/**
+ * Componente responsável pela criação, edição e gerenciamento de filtros personalizados.
+ *
+ * Permite alternar entre os modos assistente e avançado, salvar, cancelar e manipular filtros.
+ *
+ * @component
+ * @example
+ * <snk-personalized-filter
+ *    entityUri="sua/entidade"
+ *    filterId="idFiltro"
+ *    configName="nomeConfig"
+ *    resourceID="resourceId"
+ *    isDefaultFilter={false}
+ *    messagesBuilder={messagesBuilderInstance}
+ *    onEzSave={handler}
+ *    onEzCancel={handler}
+ * />
+ */
 import { h, Host, Fragment } from '@stencil/core';
 import { ApplicationContext, StringUtils } from '@sankhyalabs/core';
 import { PersonalizedFilterUtils } from './subcomponents/snk-filter-param-config/utils/PersonalizedFilterUtils';
@@ -34,8 +52,10 @@ export class SnkPersonalizedFilter {
     this.resourceID = undefined;
     this.isDefaultFilter = false;
   }
-  /*
-   * Cria um novo filtro se não houver nenhum filtro existente
+  /**
+   * Cria um novo filtro personalizado caso não exista nenhum.
+   * @method
+   * @returns {Promise<void>}
    */
   async createPersonalizedFilter() {
     const newPersonalizedFilter = {
@@ -71,6 +91,12 @@ export class SnkPersonalizedFilter {
     this._originalFilterAssistent = ObjectUtils.copy(newPersonalizedFilter);
     this._filterAssistent = ObjectUtils.copy(newPersonalizedFilter);
   }
+  /**
+   * Carrega o filtro personalizado com base no identificador informado.
+   * @watch filterId
+   * @param newValue Novo valor do filtroId.
+   * @param oldValue Valor anterior do filtroId.
+   */
   loadFilter(newValue, oldValue) {
     if (newValue == null || oldValue == newValue || this.resourceID == undefined) {
       return;
@@ -357,7 +383,10 @@ export class SnkPersonalizedFilter {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
+          "tags": [{
+              "name": "property",
+              "text": undefined
+            }],
           "text": "Respons\u00E1vel por flexibilizar e padronizar o uso de mensagens nos blocos de constru\u00E7\u00E3o."
         }
       },
@@ -372,8 +401,11 @@ export class SnkPersonalizedFilter {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Respons\u00E1vel por receber a URI da entidade."
+          "tags": [{
+              "name": "property",
+              "text": undefined
+            }],
+          "text": "URI da entidade utilizada para buscar os campos dispon\u00EDveis para filtro."
         },
         "attribute": "entity-uri",
         "reflect": false
@@ -389,8 +421,11 @@ export class SnkPersonalizedFilter {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Id do filtro que ser\u00E1 carregado."
+          "tags": [{
+              "name": "property",
+              "text": undefined
+            }],
+          "text": "Identificador do filtro a ser carregado."
         },
         "attribute": "filter-id",
         "reflect": false
@@ -406,8 +441,11 @@ export class SnkPersonalizedFilter {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Nome da configura\u00E7\u00E3o. Serve para distinguir v\u00E1rias inst\u00E2ncias do componente."
+          "tags": [{
+              "name": "property",
+              "text": undefined
+            }],
+          "text": "Nome da configura\u00E7\u00E3o, utilizado para distinguir m\u00FAltiplas inst\u00E2ncias do componente."
         },
         "attribute": "config-name",
         "reflect": false
@@ -423,8 +461,11 @@ export class SnkPersonalizedFilter {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Nome da configura\u00E7\u00E3o. Serve para distinguir v\u00E1rias inst\u00E2ncias do componente."
+          "tags": [{
+              "name": "property",
+              "text": undefined
+            }],
+          "text": "Identificador do recurso utilizado para salvar e recuperar filtros."
         },
         "attribute": "resource-i-d",
         "reflect": false
@@ -440,8 +481,14 @@ export class SnkPersonalizedFilter {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Define se o filtro em quest\u00E3o \u00E9 um filtro padr\u00E3o."
+          "tags": [{
+              "name": "property",
+              "text": undefined
+            }, {
+              "name": "default",
+              "text": "false"
+            }],
+          "text": "Indica se o filtro \u00E9 o filtro padr\u00E3o do sistema."
         },
         "attribute": "is-default-filter",
         "reflect": false,
@@ -463,8 +510,11 @@ export class SnkPersonalizedFilter {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
-          "text": ""
+          "tags": [{
+              "name": "event",
+              "text": undefined
+            }],
+          "text": "Evento emitido ao cancelar a personaliza\u00E7\u00E3o do filtro."
         },
         "complexType": {
           "original": "void",
@@ -478,8 +528,11 @@ export class SnkPersonalizedFilter {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
-          "text": ""
+          "tags": [{
+              "name": "event",
+              "text": undefined
+            }],
+          "text": "Evento emitido ao salvar as altera\u00E7\u00F5es do filtro personalizado."
         },
         "complexType": {
           "original": "string",
@@ -493,8 +546,11 @@ export class SnkPersonalizedFilter {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
-          "text": ""
+          "tags": [{
+              "name": "event",
+              "text": undefined
+            }],
+          "text": "Evento emitido ap\u00F3s salvar as altera\u00E7\u00F5es do filtro personalizado."
         },
         "complexType": {
           "original": "void",
@@ -521,8 +577,14 @@ export class SnkPersonalizedFilter {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "",
-          "tags": []
+          "text": "Cria um novo filtro personalizado caso n\u00E3o exista nenhum.",
+          "tags": [{
+              "name": "method",
+              "text": undefined
+            }, {
+              "name": "returns",
+              "text": undefined
+            }]
         }
       }
     };