@sankhyalabs/ezui 2.3.0 → 2.3.2

package/dist/collection/components/ez-button/ez-button.js

@@ -3,22 +3,22 @@ import { Component, h, Prop, Method, Element } from "@stencil/core";
 export class EzButton {
   constructor() {
     /**
-     * Deixa o botão disponível ou não para interação com o usuário.
+     * Se false o usuário não pode interagir com o botão.
      */
     this.enabled = true;
     /**
-       * Define o modo de uso do botão; opções: icon, link e regular
-       */
+     * Define o modo de uso do botão.
+     */
     this.mode = "regular";
   }
   /**
-   * Realiza o foco no botão
+   * Aplica o foco no botão.
    */
   async setFocus() {
     this._button.focus();
   }
   /**
-   * Remove o foco no botão
+   * Remove o foco do botão.
    */
   async setBlur() {
     this._button.blur();
@@ -102,7 +102,7 @@ export class EzButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Texto indicativo da a\u00E7\u00E3o do bot\u00E3o."
+        "text": "Texto a ser apresentado como t\u00EDtulo do bot\u00E3o."
       },
       "attribute": "label",
       "reflect": true
@@ -119,7 +119,7 @@ export class EzButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Deixa o bot\u00E3o dispon\u00EDvel ou n\u00E3o para intera\u00E7\u00E3o com o usu\u00E1rio."
+        "text": "Se false o usu\u00E1rio n\u00E3o pode interagir com o bot\u00E3o."
       },
       "attribute": "enabled",
       "reflect": true,
@@ -129,15 +129,15 @@ export class EzButton {
       "type": "string",
       "mutable": false,
       "complexType": {
-        "original": "string",
-        "resolved": "string",
+        "original": "\"regular\" | \"icon\" | \"link\" | \"label-icon\"",
+        "resolved": "\"icon\" | \"label-icon\" | \"link\" | \"regular\"",
         "references": {}
       },
       "required": false,
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Define o modo de uso do bot\u00E3o; op\u00E7\u00F5es: icon, link e regular"
+        "text": "Define o modo de uso do bot\u00E3o."
       },
       "attribute": "mode",
       "reflect": true,
@@ -155,7 +155,7 @@ export class EzButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Define o icone svg que ser\u00E1 utilizado no bot\u00E3o. Esta propriedade s\u00F3 \u00E9 utilizada caso o componente esteja no modo \"icon\""
+        "text": "Define o caminho usado nos modos `icon` e `label-icon` para imagens n\u00E3o contempladas na biblioteca de \u00EDcones."
       },
       "attribute": "image",
       "reflect": true
@@ -172,7 +172,7 @@ export class EzButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Nome do icone dispon\u00EDvel no pacote de fontes [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html)"
+        "text": "Define o \u00EDcone a ser usado da biblioteca de \u00EDcones: [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html)"
       },
       "attribute": "icon-name",
       "reflect": true
@@ -189,7 +189,7 @@ export class EzButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "\u00C9 poss\u00EDvel escolher entre [small,medium,large] (somente para os modos \"icon\" e \"link\")"
+        "text": "Define o tamanho do ez-button."
       },
       "attribute": "size",
       "reflect": true
@@ -208,7 +208,7 @@ export class EzButton {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "Realiza o foco no bot\u00E3o",
+        "text": "Aplica o foco no bot\u00E3o.",
         "tags": []
       }
     },
@@ -224,7 +224,7 @@ export class EzButton {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "Remove o foco no bot\u00E3o",
+        "text": "Remove o foco do bot\u00E3o.",
         "tags": []
       }
     }

package/dist/collection/components/ez-calendar/ez-calendar.js

@@ -9,28 +9,25 @@ export class EzCalendar {
     this._hoursLabel = ["00", "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23"];
     this._minutosLabel = ["00", "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50", "51", "52", "53", "54", "55", "56", "57", "58", "59"];
     /**
-     * A data selecionada no calendário
+     * Define o valor do calendário.
      */
     this.value = new Date();
     /**
-     * No modo floating o calendário só se tornará visível
-     * quando o método show() for acionado.
+     * Define se a exibição do ez-calendar será feita pelos métodos `show()` e `hide()`.
      */
     this.floating = false;
     /**
-     * Exibe ou não as horas e minutos no calendario
+     * Se true a data considera horas e minutos.
      */
     this.time = false;
     /**
-    * Exibe ou não os segundos no calendario
-    */
+     * Se true a data considera segundos. Deve ser usado em conjunto com a propriedade `time`.
+     */
     this.showSeconds = false;
   }
   /**
-   * Usado no modo floating. Faz com que o componente seja exibido.
-   * É possível determinar ajustes de posicionamento através dos parâmetros
-   * top, left, bottom e right. Esses parâmetros devem ser informados como
-   * strings no formato css.
+   * Exibe o ez-calendar em uma posição determinada.
+   * É possível determinar o posicionamento através dos parâmetros, no formato css.
    */
   async show(top, left, bottom, right) {
     if (this.floating) {
@@ -42,8 +39,8 @@ export class EzCalendar {
     }
   }
   /**
-  * Método necessário para ajustar o posicionamento do calendar acima ou abaixo do ez-date-input conforme a disponibilidade de espaço.
-  */
+   * Ajusta o posicionamento do ez-calendar conforme a disponibilidade de espaço.
+   */
   async fitVertical(topOffset, bottomOffset) {
     const neededHeight = this._container.getBoundingClientRect().bottom + this._calendarHeight;
     const availableBottom = (window.innerHeight || document.documentElement.clientHeight) > neededHeight;
@@ -55,7 +52,7 @@ export class EzCalendar {
     }
   }
   /**
-   * Usado no modo floating. Faz com que o componente seja ocultado.
+   * Oculta o ez-calendar.
    */
   async hide() {
     if (this._floatingID !== undefined) {
@@ -261,7 +258,7 @@ export class EzCalendar {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "A data selecionada no calend\u00E1rio"
+        "text": "Define o valor do calend\u00E1rio."
       },
       "defaultValue": "new Date()"
     },
@@ -277,7 +274,7 @@ export class EzCalendar {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "No modo floating o calend\u00E1rio s\u00F3 se tornar\u00E1 vis\u00EDvel\nquando o m\u00E9todo show() for acionado."
+        "text": "Define se a exibi\u00E7\u00E3o do ez-calendar ser\u00E1 feita pelos m\u00E9todos `show()` e `hide()`."
       },
       "attribute": "floating",
       "reflect": true,
@@ -295,7 +292,7 @@ export class EzCalendar {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Exibe ou n\u00E3o as horas e minutos no calendario"
+        "text": "Se true a data considera horas e minutos."
       },
       "attribute": "time",
       "reflect": true,
@@ -313,7 +310,7 @@ export class EzCalendar {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Exibe ou n\u00E3o os segundos no calendario"
+        "text": "Se true a data considera segundos. Deve ser usado em conjunto com a propriedade `time`."
       },
       "attribute": "show-seconds",
       "reflect": true,
@@ -328,7 +325,7 @@ export class EzCalendar {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Quando o usu\u00E1rio escolhe uma data, esse evento \u00E9 emitido."
+        "text": "Emitido quando acontece a altera\u00E7\u00E3o de valor do calend\u00E1rio."
       },
       "complexType": {
         "original": "Date",
@@ -365,7 +362,7 @@ export class EzCalendar {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "Usado no modo floating. Faz com que o componente seja exibido.\n\u00C9 poss\u00EDvel determinar ajustes de posicionamento atrav\u00E9s dos par\u00E2metros\ntop, left, bottom e right. Esses par\u00E2metros devem ser informados como\nstrings no formato css.",
+        "text": "Exibe o ez-calendar em uma posi\u00E7\u00E3o determinada.\n\u00C9 poss\u00EDvel determinar o posicionamento atrav\u00E9s dos par\u00E2metros, no formato css.",
         "tags": []
       }
     },
@@ -387,7 +384,7 @@ export class EzCalendar {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "M\u00E9todo necess\u00E1rio para ajustar o posicionamento do calendar acima ou abaixo do ez-date-input conforme a disponibilidade de espa\u00E7o.",
+        "text": "Ajusta o posicionamento do ez-calendar conforme a disponibilidade de espa\u00E7o.",
         "tags": []
       }
     },
@@ -403,7 +400,7 @@ export class EzCalendar {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "Usado no modo floating. Faz com que o componente seja ocultado.",
+        "text": "Oculta o ez-calendar.",
         "tags": []
       }
     }

package/dist/collection/components/ez-card-item/ez-card-item.js

@@ -67,7 +67,7 @@ export class EzCardItem {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Determina o conte\u00FAdo do card. Deve conter um objeto no formato:\n`{title: string, key: string, details: any}`."
       }
     }
   }; }
@@ -79,7 +79,7 @@ export class EzCardItem {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": ""
+        "text": "Emitido sempre que o ez-card \u00E9 clicado."
       },
       "complexType": {
         "original": "CardItem",

package/dist/collection/components/ez-check/ez-check.js

@@ -4,14 +4,11 @@ import { CheckMode } from './CheckMode';
 export class EzCheck {
   constructor() {
     /**
-     * Deixa o campo disponível ou não para interação com o usuário.
+     * Se false o usuário não pode interagir com o campo.
      */
     this.enabled = true;
     /**
-     * Existem dois modos de visualização: regular e switch.
-     * Se esta propriedade for omitida, o componete assume o formato "regular".
-     * No modo "regular" a visualização é a tradicional de uma caixinha marcada/desmarcada.
-     * No modo "switch" o campo tem uma interface em formato de um pino liga/desliga.
+     * Define o modo de visualização do ez-check.
      */
     this.mode = CheckMode.REGULAR;
   }
@@ -19,13 +16,13 @@ export class EzCheck {
   // Public methods
   //---------------------------------------------
   /**
-   * Devolve o modo escolhido para o componente
+   * Obtém o modo escolhido.
    */
   async getMode() {
-    return this.mode;
+    return CheckMode[this.mode];
   }
   /**
-   * Faz o foco no componente de input
+   * Aplica o foco no campo.
    */
   async setFocus() {
     this._inputElem.focus();
@@ -82,7 +79,7 @@ export class EzCheck {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "T\u00EDtulo do campo"
+        "text": "Texto a ser apresentado como t\u00EDtulo do campo."
       },
       "attribute": "label",
       "reflect": true
@@ -99,7 +96,7 @@ export class EzCheck {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Como se trata de um componente bin\u00E1rio, o valor alterna entre true e false (marcado / desmarcado)"
+        "text": "Define o valor do campo."
       },
       "attribute": "value",
       "reflect": true
@@ -116,7 +113,7 @@ export class EzCheck {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Deixa o campo dispon\u00EDvel ou n\u00E3o para intera\u00E7\u00E3o com o usu\u00E1rio."
+        "text": "Se false o usu\u00E1rio n\u00E3o pode interagir com o campo."
       },
       "attribute": "enabled",
       "reflect": true,
@@ -134,24 +131,29 @@ export class EzCheck {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Deixa o campo em um estado indeterminado, nem marcado nem desmarcado (n\u00E3o dispon\u00EDvel em modo \"switch\")."
+        "text": "Se true ativa o estado indeterminado, nem marcado nem desmarcado (n\u00E3o dispon\u00EDvel em modo `switch`)."
       },
       "attribute": "indeterminate",
-      "reflect": false
+      "reflect": true
     },
     "mode": {
       "type": "string",
       "mutable": false,
       "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
+        "original": "CheckMode",
+        "resolved": "CheckMode.REGULAR | CheckMode.SWITCH",
+        "references": {
+          "CheckMode": {
+            "location": "import",
+            "path": "./CheckMode"
+          }
+        }
       },
       "required": false,
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Existem dois modos de visualiza\u00E7\u00E3o: regular e switch.\nSe esta propriedade for omitida, o componete assume o formato \"regular\".\nNo modo \"regular\" a visualiza\u00E7\u00E3o \u00E9 a tradicional de uma caixinha marcada/desmarcada.\nNo modo \"switch\" o campo tem uma interface em formato de um pino liga/desliga."
+        "text": "Define o modo de visualiza\u00E7\u00E3o do ez-check."
       },
       "attribute": "mode",
       "reflect": true,
@@ -166,7 +168,7 @@ export class EzCheck {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Evento disparado ao mudar o estado do check(onEzChange)."
+        "text": "Emitido quando acontece a altera\u00E7\u00E3o de valor do campo."
       },
       "complexType": {
         "original": "any",
@@ -177,17 +179,21 @@ export class EzCheck {
   static get methods() { return {
     "getMode": {
       "complexType": {
-        "signature": "() => Promise<string>",
+        "signature": "() => Promise<CheckMode>",
         "parameters": [],
         "references": {
           "Promise": {
             "location": "global"
+          },
+          "CheckMode": {
+            "location": "import",
+            "path": "./CheckMode"
           }
         },
-        "return": "Promise<string>"
+        "return": "Promise<CheckMode>"
       },
       "docs": {
-        "text": "Devolve o modo escolhido para o componente",
+        "text": "Obt\u00E9m o modo escolhido.",
         "tags": []
       }
     },
@@ -203,7 +209,7 @@ export class EzCheck {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "Faz o foco no componente de input",
+        "text": "Aplica o foco no campo.",
         "tags": []
       }
     }

package/dist/collection/components/ez-chip/ez-chip.js

@@ -3,11 +3,11 @@ import { ElementIDUtils } from '@sankhyalabs/core';
 export class EzChip {
   constructor() {
     /**
-     * Deixa o componente disponível ou não para seleção.
+     * Se false o usuário não pode interagir com o ez-chip.
      */
     this.enabled = true;
     /**
-     * Indica se o componente está ou não ativado.
+     * Define o valor do ez-chip.
      */
     this.value = false;
   }
@@ -15,13 +15,13 @@ export class EzChip {
   // Public methods
   //---------------------------------------------
   /**
-   * Faz o foco no componente de input
+   * Aplica o foco no ez-chip.
    */
   async setFocus() {
     this._labelElem.focus();
   }
   /**
-   * Remove o foco no componente de input
+   * Remove o foco do ez-chip.
    */
   async setBlur() {
     this._labelElem.blur();
@@ -118,7 +118,7 @@ export class EzChip {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "T\u00EDtulo exibido no componente."
+        "text": "Texto a ser apresentado como t\u00EDtulo do ez-chip."
       },
       "attribute": "label",
       "reflect": true
@@ -135,7 +135,7 @@ export class EzChip {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Deixa o componente dispon\u00EDvel ou n\u00E3o para sele\u00E7\u00E3o."
+        "text": "Se false o usu\u00E1rio n\u00E3o pode interagir com o ez-chip."
       },
       "attribute": "enabled",
       "reflect": true,
@@ -145,7 +145,7 @@ export class EzChip {
       "type": "string",
       "mutable": false,
       "complexType": {
-        "original": "\"left\" | \"right\"",
+        "original": "\"left\" | \"right\" | undefined",
         "resolved": "\"left\" | \"right\"",
         "references": {}
       },
@@ -153,7 +153,7 @@ export class EzChip {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Indica se o componente ter\u00E1 a op\u00E7\u00E3o de ser removido e qual sua posi\u00E7\u00E3o: left ou right."
+        "text": "Determina o posicionamento do bot\u00E3o de remover (n\u00E3o dispon\u00EDvel no modo `action`). \nSe n\u00E3o informado, n\u00E3o exibe o bot\u00E3o."
       },
       "attribute": "remove-position",
       "reflect": true
@@ -170,7 +170,7 @@ export class EzChip {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Define o modo de uso do cjip: label ou action"
+        "text": "Define o modo de uso do ez-chip."
       },
       "attribute": "mode",
       "reflect": true
@@ -187,7 +187,7 @@ export class EzChip {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Indica se o componente est\u00E1 ou n\u00E3o ativado."
+        "text": "Define o valor do ez-chip."
       },
       "attribute": "value",
       "reflect": true,
@@ -202,7 +202,7 @@ export class EzChip {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Evento disparado quando o estado do componente mudar (onValueChange)."
+        "text": "Emitido quando acontece a altera\u00E7\u00E3o de valor do ez-chip."
       },
       "complexType": {
         "original": "boolean",
@@ -217,7 +217,7 @@ export class EzChip {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Evento disparado ao clicar no bot\u00E3o de remo\u00E7\u00E3o (onRemoveChip)."
+        "text": "Emitido quando o bot\u00E3o de remo\u00E7\u00E3o \u00E9 acionado."
       },
       "complexType": {
         "original": "void",
@@ -232,7 +232,7 @@ export class EzChip {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Evento disparado ao clicar no chip usando o modo \"action\" (onActionClick)."
+        "text": "Emitido no modo \"action\" quando o usu\u00E1rio clica no ez-chip."
       },
       "complexType": {
         "original": "void",
@@ -253,7 +253,7 @@ export class EzChip {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "Faz o foco no componente de input",
+        "text": "Aplica o foco no ez-chip.",
         "tags": []
       }
     },
@@ -269,7 +269,7 @@ export class EzChip {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "Remove o foco no componente de input",
+        "text": "Remove o foco do ez-chip.",
         "tags": []
       }
     }