@sankhyalabs/sankhyablocks 2.3.0 → 2.4.1

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

@@ -13,7 +13,7 @@ export class SnkCrud {
   constructor() {
     this._viewMode = GRID_MODE.name;
     /**
-     * Determina se pode haver mais de uma linha selecionada na grade
+     * Determina se pode haver mais de uma linha selecionada na grade.
      */
     this.multipleSelection = true;
   }
@@ -60,7 +60,7 @@ export class SnkCrud {
     }
   }
   getDataElementId(suffix) {
-    const elemIdSnkCrud = this._element.getAttribute("data-element-id");
+    const elemIdSnkCrud = this._element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME);
     return `${elemIdSnkCrud}_${suffix}`;
   }
   componentWillLoad() {
@@ -147,7 +147,7 @@ export class SnkCrud {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "A\u00E7\u00F5es a serem colocadas no bot\u00E3o \"Mais op\u00E7\u00F5es\"."
+          "text": "A\u00E7\u00F5es a serem colocadas no bot\u00E3o \"Mais op\u00E7\u00F5es\" do componente snk-taskbar."
         }
       },
       "taskbarManager": {
@@ -187,7 +187,7 @@ export class SnkCrud {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Validador respons\u00E1vel por checar a integridade das informa\u00E7\u00F5es do registro"
+          "text": "Validador respons\u00E1vel por checar a integridade das informa\u00E7\u00F5es do registro."
         }
       },
       "statusResolver": {
@@ -222,7 +222,7 @@ export class SnkCrud {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Determina se pode haver mais de uma linha selecionada na grade"
+          "text": "Determina se pode haver mais de uma linha selecionada na grade."
         },
         "attribute": "multiple-selection",
         "reflect": false,
@@ -246,7 +246,7 @@ export class SnkCrud {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": "Emitido pela taskbar sempre que houver click de bot\u00E3o ou a\u00E7\u00E3o"
+          "text": "Emitido pela taskbar sempre que houver click de bot\u00E3o ou a\u00E7\u00E3o."
         },
         "complexType": {
           "original": "string",

package/dist/collection/components/snk-data-unit/snk-data-unit.js

@@ -6,7 +6,7 @@ export class SnkDataUnit {
   constructor() {
     this._onDataUnitResolve = [];
     /**
-     * Determina quantas linhas são retornadas por página
+     * Determina quantas linhas são retornadas por página.
      */
     this.pageSize = 150;
     this._dataUnitObserver = (action) => {
@@ -79,9 +79,7 @@ export class SnkDataUnit {
     this.dataUnitReady.emit(this.dataUnit);
   }
   /**
-   * Pode-se obter o dataUnit através desse método. Outra forma, é ouvir o evento de
-   *
-   * @returns dataUnit
+   * Obtém o dataUnit.
    */
   async getDataUnit() {
     return new Promise((resolve) => {
@@ -282,7 +280,7 @@ export class SnkDataUnit {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "O estato atual dos dados, isto \u00E9 se h\u00E1 altera\u00E7\u00E3o, insers\u00E3o, as linhas selecionadas, etc."
+          "text": "Controla o estado atual dos dados."
         }
       },
       "dataUnitName": {
@@ -297,7 +295,7 @@ export class SnkDataUnit {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Este atributo \u00E9 usado para criar o dataUnit uma \u00FAnica vez. Se omitido ser\u00E1 usado o pr\u00F3prio nome\nda entidade."
+          "text": "Usado para criar o dataUnit uma \u00FAnica vez. \nSe omitido, ser\u00E1 usado o pr\u00F3prio nome da entidade."
         },
         "attribute": "data-unit-name",
         "reflect": false
@@ -314,7 +312,7 @@ export class SnkDataUnit {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Determina qual a entidade representa os dados em quest\u00E3o."
+          "text": "Determina qual a entidade que representa os dados em quest\u00E3o."
         },
         "attribute": "entity-name",
         "reflect": false
@@ -331,7 +329,7 @@ export class SnkDataUnit {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Determina quantas linhas s\u00E3o retornadas por p\u00E1gina"
+          "text": "Determina quantas linhas s\u00E3o retornadas por p\u00E1gina."
         },
         "attribute": "page-size",
         "reflect": false,
@@ -354,7 +352,7 @@ export class SnkDataUnit {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Uma vez instanciado, pode-se obter o dataUnit por esta propriedade"
+          "text": "Uma vez instanciado, pode-se obter o dataUnit por esta propriedade."
         }
       },
       "beforeSave": {
@@ -397,7 +395,7 @@ export class SnkDataUnit {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Executado ap\u00F3s a a\u00E7\u00E3o de salvar"
+          "text": "Executado ap\u00F3s a a\u00E7\u00E3o de salvar."
         }
       }
     };
@@ -411,7 +409,7 @@ export class SnkDataUnit {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": "Disparado quando o h\u00E1 qualquer mudan\u00E7a de estado no DataUnit"
+          "text": "Emitido quando h\u00E1 qualquer mudan\u00E7a de estado no DataUnit."
         },
         "complexType": {
           "original": "DataState",
@@ -430,7 +428,7 @@ export class SnkDataUnit {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": "Disparado quando o DataUnit est\u00E1 pronto"
+          "text": "Emitido quando o DataUnit est\u00E1 pronto."
         },
         "complexType": {
           "original": "DataUnit",
@@ -450,7 +448,7 @@ export class SnkDataUnit {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": "Disparado quando um registro \u00E9 adicionado ou copiado"
+          "text": "Emitido quando um registro \u00E9 adicionado ou copiado."
         },
         "complexType": {
           "original": "void",
@@ -465,7 +463,7 @@ export class SnkDataUnit {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": "Disparado quando se cancela uma insers\u00E3o/c\u00F3pia"
+          "text": "Emitido quando se cancela uma inser\u00E7\u00E3o ou c\u00F3pia."
         },
         "complexType": {
           "original": "void",
@@ -492,11 +490,8 @@ export class SnkDataUnit {
           "return": "Promise<DataUnit>"
         },
         "docs": {
-          "text": "Pode-se obter o dataUnit atrav\u00E9s desse m\u00E9todo. Outra forma, \u00E9 ouvir o evento de",
-          "tags": [{
-              "name": "returns",
-              "text": "dataUnit"
-            }]
+          "text": "Obt\u00E9m o dataUnit.",
+          "tags": []
         }
       }
     };

package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-binary-select.js

@@ -5,6 +5,9 @@ export class SnkFilterBinarySelect {
   isSelected(option) {
     return this.value == undefined || this.value === option;
   }
+  /**
+   * Emitido quando acontece a alteração de valor do componente snk-filter-binary-select
+   */
   ezChangeListener(evt) {
     if (!evt.detail) {
       this.assertCheckedOption(evt.target);
@@ -33,6 +36,9 @@ export class SnkFilterBinarySelect {
       this.value = undefined;
     }
   }
+  /**
+   * Exibe o componente snk-filter-binary-select
+   */
   async show() {
     this._checkOne.setFocus();
   }
@@ -58,7 +64,7 @@ export class SnkFilterBinarySelect {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "Define o valor do componente snk-filter-binary-select"
         },
         "attribute": "value",
         "reflect": true
@@ -80,7 +86,7 @@ export class SnkFilterBinarySelect {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "Define as configura\u00E7\u00F5es do componente snk-filter-binary-select"
         }
       }
     };
@@ -99,7 +105,7 @@ export class SnkFilterBinarySelect {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "",
+          "text": "Exibe o componente snk-filter-binary-select",
           "tags": []
         }
       }

package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-multi-select.js

@@ -2,9 +2,15 @@ import { ElementIDUtils } from '@sankhyalabs/core';
 import { h } from '@stencil/core';
 import FilterItemType from '../filter-item-type.enum';
 export class SnkFilterMultiSelect {
+  /**
+   * Emitido quando acontece a alteração de valor do componente snk-filter-multi-select
+   */
   ezChangeListener(evt) {
     this.value = evt.detail.value;
   }
+  /**
+   * Exibe o componente snk-filter-multi-select
+   */
   async show() {
     this._comboElement.setFocus();
   }
@@ -34,7 +40,7 @@ export class SnkFilterMultiSelect {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "Define o valor do componente snk-filter-multi-select"
         },
         "attribute": "value",
         "reflect": true
@@ -56,7 +62,7 @@ export class SnkFilterMultiSelect {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "Define as configura\u00E7\u00F5es do componente snk-filter-multi-select"
         }
       }
     };
@@ -75,7 +81,7 @@ export class SnkFilterMultiSelect {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "",
+          "text": "Exibe o componente snk-filter-multi-select",
           "tags": []
         }
       }

package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-number.js

@@ -2,9 +2,15 @@ import { ElementIDUtils } from '@sankhyalabs/core';
 import { h } from '@stencil/core';
 import FilterItemType from '../filter-item-type.enum';
 export class SnkFilterPeriod {
+  /**
+   * Emitido quando acontece a alteração de valor do componente snk-filter-number
+   */
   ezChangeListener(evt) {
     this.value = evt.detail;
   }
+  /**
+   * Exibe o componente snk-filter-number
+   */
   async show() {
     this._numberElement.setFocus();
   }
@@ -40,7 +46,7 @@ export class SnkFilterPeriod {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "Define as configura\u00E7\u00F5es do componente snk-filter-number"
         }
       },
       "value": {
@@ -55,7 +61,7 @@ export class SnkFilterPeriod {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "Define o valor do componente snk-filter-number"
         },
         "attribute": "value",
         "reflect": false
@@ -76,7 +82,7 @@ export class SnkFilterPeriod {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "",
+          "text": "Exibe o componente snk-filter-number",
           "tags": []
         }
       }

package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-period.js

@@ -2,6 +2,9 @@ import { ElementIDUtils } from '@sankhyalabs/core';
 import { h } from '@stencil/core';
 import FilterItemType from '../filter-item-type.enum';
 export class SnkFilterPeriod {
+  /**
+   * Emitido quando acontece a alteração de valor do componente snk-filter-period
+   */
   ezChangeListener() {
     const start = this._startDate.value;
     const end = this._endDate.value;
@@ -24,6 +27,9 @@ export class SnkFilterPeriod {
     }
     return null;
   }
+  /**
+   * Exibe o componente snk-filter-period
+   */
   async show() {
     this._startDate.setFocus();
   }
@@ -53,7 +59,7 @@ export class SnkFilterPeriod {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "Define as configura\u00E7\u00F5es do componente snk-filter-period"
         }
       },
       "value": {
@@ -68,7 +74,7 @@ export class SnkFilterPeriod {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "Define o valor do componente snk-filter-period"
         },
         "attribute": "value",
         "reflect": false
@@ -89,7 +95,7 @@ export class SnkFilterPeriod {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "",
+          "text": "Exibe o componente snk-filter-period",
           "tags": []
         }
       }

package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-personalized.js

@@ -69,6 +69,9 @@ export class SnkFilterPersonalized {
       }
     });
   }
+  /**
+   * Exibe o componente snk-filter-personalized
+   */
   async show() {
     const elem = document.querySelector("#param_0");
     if (elem) {
@@ -101,7 +104,7 @@ export class SnkFilterPersonalized {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "Define as configura\u00E7\u00F5es do componente snk-filter-personalized"
         }
       },
       "value": {
@@ -127,7 +130,7 @@ export class SnkFilterPersonalized {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "Define o valor do componente snk-filter-personalized"
         }
       },
       "fix": {
@@ -176,7 +179,7 @@ export class SnkFilterPersonalized {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "",
+          "text": "Exibe o componente snk-filter-personalized",
           "tags": []
         }
       }

package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-search.js

@@ -2,6 +2,9 @@ import { ApplicationContext, ElementIDUtils } from '@sankhyalabs/core';
 import { h } from '@stencil/core';
 import FilterItemType from '../filter-item-type.enum';
 export class SnkFilterSearch {
+  /**
+   * Emitido quando acontece a alteração de valor do componente snk-filter-search
+   */
   ezChangeListener(_evt) {
     this.value = this._searchInput.value;
   }
@@ -21,6 +24,9 @@ export class SnkFilterSearch {
       });
     });
   }
+  /**
+   * Exibe o componente snk-filter-search
+   */
   async show() {
     this._searchInput.setFocus();
   }
@@ -50,7 +56,7 @@ export class SnkFilterSearch {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "Define as configura\u00E7\u00F5es do componente snk-filter-search"
         }
       },
       "value": {
@@ -70,7 +76,7 @@ export class SnkFilterSearch {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "Define o valor do componente snk-filter-search"
         }
       }
     };
@@ -89,7 +95,7 @@ export class SnkFilterSearch {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "",
+          "text": "Exibe o componente snk-filter-search",
           "tags": []
         }
       }

package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-text.js

@@ -1,6 +1,9 @@
 import { ElementIDUtils } from '@sankhyalabs/core';
 import { h } from '@stencil/core';
 export class SnkFilterText {
+  /**
+   * Emitido quando acontece a alteração de valor do componente snk-filter-text.
+   */
   ezChangeListener(evt) {
     this.value = evt.detail;
   }
@@ -35,7 +38,7 @@ export class SnkFilterText {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "Define as configura\u00E7\u00F5es do componente snk-filter-text."
         }
       },
       "value": {
@@ -50,7 +53,7 @@ export class SnkFilterText {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "Define o valor do componente snk-filter-text."
         },
         "attribute": "value",
         "reflect": false

package/dist/collection/components/snk-filter-bar/filter-item/snk-filter-detail.js

@@ -3,13 +3,16 @@ import { ApplicationUtils } from "@sankhyalabs/ezui/dist/collection/utils";
 import FilterItemType from './filter-item-type.enum';
 import { ElementIDUtils, DataType } from '@sankhyalabs/core';
 export class SnkFilterDetail {
+  /**
+   * Exibe o componente snk-filter-detail.
+   */
   async show() {
     this._editor["show"]();
   }
   componentDidLoad() {
     if (this._element) {
       ElementIDUtils.addIDInfo(this._element);
-      const dataElementIdDoFilterItem = this._element.getAttribute("data-element-id");
+      const dataElementIdDoFilterItem = this._element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME);
       this._idContentEditor = `${dataElementIdDoFilterItem}_${this.config.id}`;
     }
   }
@@ -130,7 +133,7 @@ export class SnkFilterDetail {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "Define as configura\u00E7\u00F5es do componente snk-filter-detail."
         }
       },
       "getMessage": {
@@ -145,7 +148,7 @@ export class SnkFilterDetail {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder."
         }
       }
     };
@@ -159,7 +162,7 @@ export class SnkFilterDetail {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "Emitido quando h\u00E1 uma altera\u00E7\u00E3o nos filtros."
         },
         "complexType": {
           "original": "SnkFilterItemConfig",
@@ -187,7 +190,7 @@ export class SnkFilterDetail {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "",
+          "text": "Exibe o componente snk-filter-detail.",
           "tags": []
         }
       }

package/dist/collection/components/snk-filter-bar/filter-item/snk-filter-item.js

@@ -14,6 +14,9 @@ export class SnkFilterItem {
   observeDetailIsVisible(value) {
     this.visibleChanged.emit(value);
   }
+  /**
+   * Exibe os detalhes de um item da lista.
+   */
   async showUp(open = false) {
     return new Promise(resolve => {
       this._filterItemElement.scrollIntoView({ behavior: "auto", block: "nearest", inline: "nearest" });
@@ -38,6 +41,9 @@ export class SnkFilterItem {
     const rect = this._filterItemElement.getBoundingClientRect();
     return `calc(${rect.left}px + ${padding})`;
   }
+  /**
+   * Oculta os detalhes de um item da lista.
+   */
   async hideDetail() {
     if (this.detailIsVisible) {
       if (this._floatingID != undefined) {
@@ -136,7 +142,7 @@ export class SnkFilterItem {
   componentDidLoad() {
     if (this._filterItemElement) {
       ElementIDUtils.addIDInfo(this._filterItemElement);
-      const dataElementIdDoFilterItem = this._filterItemElement.getAttribute("data-element-id");
+      const dataElementIdDoFilterItem = this._filterItemElement.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME);
       this._idSnkFilterDetail = `${dataElementIdDoFilterItem}_${this.config.id}`;
       this._idEzChip = `${dataElementIdDoFilterItem}_${this.config.id}`;
     }
@@ -148,6 +154,9 @@ export class SnkFilterItem {
       }
     }
   }
+  /**
+   * Emitido quando o estado do filtro é alterado.
+   */
   filterChangeListener() {
     this.hideDetail();
   }
@@ -189,7 +198,7 @@ export class SnkFilterItem {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "Define as configura\u00E7\u00F5es do componente snk-filter-item."
         }
       },
       "getMessage": {
@@ -204,7 +213,7 @@ export class SnkFilterItem {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder."
         }
       }
     };
@@ -223,7 +232,7 @@ export class SnkFilterItem {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": "Disparado quando o detalhe de um item da lista \u00E9 aberto ou fechado."
+          "text": "Emitido quando o detalhe de um item da lista \u00E9 aberto ou fechado."
         },
         "complexType": {
           "original": "boolean",
@@ -238,7 +247,7 @@ export class SnkFilterItem {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "Emitido quando h\u00E1 uma altera\u00E7\u00E3o nos filtros."
         },
         "complexType": {
           "original": "SnkFilterItemConfig",
@@ -268,7 +277,7 @@ export class SnkFilterItem {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "",
+          "text": "Exibe os detalhes de um item da lista.",
           "tags": []
         }
       },
@@ -284,7 +293,7 @@ export class SnkFilterItem {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "",
+          "text": "Oculta os detalhes de um item da lista.",
           "tags": []
         }
       }