@sankhyalabs/sankhyablocks 9.2.0-dev.5 → 9.2.0-dev.6

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

@@ -470,8 +470,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Usado para determinar O alinhamento dos items na taskbar."
+          "tags": [{
+              "name": "description",
+              "text": "Define o alinhamento dos itens da barra de tarefas \u00E0 direita."
+            }],
+          "text": ""
         },
         "attribute": "align-rigth",
         "reflect": false,
@@ -488,8 +491,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Usado para determinar o identificador do slot que recebe elementos personalizados."
+          "tags": [{
+              "name": "description",
+              "text": "Define o identificador do slot que recebe elementos personalizados."
+            }],
+          "text": ""
         },
         "attribute": "custom-slot-id",
         "reflect": false,
@@ -506,8 +512,14 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Usado para determinar o identificador do container na DOM que \u00E9 responsavel por guardar os elementos personalizados\nque n\u00E3o podem ser passados por slot.\n\nExemplo: Elementos customizados na Taskbar da aba de detalhes."
+          "tags": [{
+              "name": "description",
+              "text": "Define o identificador do cont\u00EAiner na DOM que \u00E9 respons\u00E1vel por guardar os elementos personalizados\nque n\u00E3o podem ser passados por slot."
+            }, {
+              "name": "example",
+              "text": "Elementos customizados na Taskbar da aba de detalhes."
+            }],
+          "text": ""
         },
         "attribute": "custom-container-id",
         "reflect": false
@@ -523,8 +535,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Define como ser\u00E1 o comportamento da taskbar quando ocorrer overflow"
+          "tags": [{
+              "name": "description",
+              "text": "Define como ser\u00E1 o comportamento da barra de tarefas quando ocorrer um overflow de itens."
+            }],
+          "text": ""
         },
         "attribute": "overflow-strategy",
         "reflect": false,
@@ -541,8 +556,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Usado para guardar ou recuperar as configura\u00E7\u00F5es do formul\u00E1rio."
+          "tags": [{
+              "name": "description",
+              "text": "Nome da configura\u00E7\u00E3o usada para salvar ou recuperar as configura\u00E7\u00F5es do formul\u00E1rio. Tamb\u00E9m \u00E9 utilizado como fallback para a chave de armazenamento do exportador de dados."
+            }],
+          "text": ""
         },
         "attribute": "config-name",
         "reflect": false
@@ -558,8 +576,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Identificador de recursos como configura\u00E7\u00F5es e acesso."
+          "tags": [{
+              "name": "description",
+              "text": "Identificador de recursos, como configura\u00E7\u00F5es e permiss\u00F5es de acesso."
+            }],
+          "text": ""
         },
         "attribute": "resource-i-d",
         "reflect": false
@@ -575,8 +596,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Lista separada por virgula, contendo todos os elementos a serem criados."
+          "tags": [{
+              "name": "description",
+              "text": "Lista de bot\u00F5es, separados por v\u00EDrgula, que define todos os elementos a serem criados na barra de tarefas."
+            }],
+          "text": ""
         },
         "attribute": "buttons",
         "reflect": false
@@ -599,8 +623,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Mapa com defini\u00E7\u00E3o de bot\u00F5es personalizados. A chave do mapa deve ser\npassada na lista \"buttons\" no lugar onde o bot\u00E3o ir\u00E1 aparecer."
+          "tags": [{
+              "name": "description",
+              "text": "Mapa com defini\u00E7\u00F5es de bot\u00F5es personalizados. A chave do mapa deve ser informada na propriedade `buttons` no local onde o bot\u00E3o deve ser renderizado."
+            }],
+          "text": ""
         }
       },
       "actionsList": {
@@ -621,8 +648,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Lista de a\u00E7\u00F5es que devem ser usadas no bot\u00E3o \"Mais op\u00E7\u00F5es\" do componente snk-taskbar."
+          "tags": [{
+              "name": "description",
+              "text": "Lista de a\u00E7\u00F5es a serem exibidas no bot\u00E3o \"Mais op\u00E7\u00F5es\"."
+            }],
+          "text": ""
         }
       },
       "actionsSettingsList": {
@@ -643,8 +673,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Lista de a\u00E7\u00F5es que devem ser usadas no bot\u00E3o \"Mais op\u00E7\u00F5es\" do componente snk-taskbar."
+          "tags": [{
+              "name": "description",
+              "text": "Lista de a\u00E7\u00F5es que devem ser usadas no bot\u00E3o \"Mais op\u00E7\u00F5es\" do componente snk-taskbar."
+            }],
+          "text": ""
         }
       },
       "primaryButton": {
@@ -658,8 +691,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Determina qual bot\u00E3o deve ter apar\u00EAncia prim\u00E1ria."
+          "tags": [{
+              "name": "description",
+              "text": "Define qual bot\u00E3o deve ter a apar\u00EAncia de destaque (prim\u00E1rio)."
+            }],
+          "text": ""
         },
         "attribute": "primary-button",
         "reflect": false
@@ -679,8 +715,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Array contendo todos os bot\u00F5es a serem desabilitados."
+          "tags": [{
+              "name": "description",
+              "text": "Array contendo os identificadores de todos os bot\u00F5es que devem ser desabilitados."
+            }],
+          "text": ""
         }
       },
       "dataUnit": {
@@ -699,8 +738,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Inst\u00E2ncia do DataUnit."
+          "tags": [{
+              "name": "description",
+              "text": "Inst\u00E2ncia do `DataUnit` com a qual a barra de tarefas ir\u00E1 interagir para realizar opera\u00E7\u00F5es de dados (ex: salvar, pr\u00F3ximo, anterior)."
+            }],
+          "text": ""
         }
       },
       "presentationMode": {
@@ -719,8 +761,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Altera o modo de apresenta\u00E7\u00E3o dos bot\u00F5es do snk-taskbar."
+          "tags": [{
+              "name": "description",
+              "text": "Altera o modo de apresenta\u00E7\u00E3o dos bot\u00F5es da barra de tarefas."
+            }],
+          "text": ""
         },
         "attribute": "presentation-mode",
         "reflect": true,
@@ -742,8 +787,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Respons\u00E1vel por flexibilizar e padronizar o uso de mensagens nos blocos de constru\u00E7\u00E3o."
+          "tags": [{
+              "name": "description",
+              "text": "Respons\u00E1vel por flexibilizar e padronizar o uso de mensagens nos blocos de constru\u00E7\u00E3o."
+            }],
+          "text": ""
         }
       }
     };
@@ -769,8 +817,14 @@ export class SnkTaskbar {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
-          "text": "Emitido sempre que houver click de bot\u00E3o ou a\u00E7\u00E3o."
+          "tags": [{
+              "name": "description",
+              "text": "Emitido sempre que um bot\u00E3o ou uma a\u00E7\u00E3o da barra de tarefas \u00E9 clicado."
+            }, {
+              "name": "eventProperty",
+              "text": undefined
+            }],
+          "text": ""
         },
         "complexType": {
           "original": "string",
@@ -784,8 +838,14 @@ export class SnkTaskbar {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
-          "text": "Emitido sempre que um save \u00E9 iniciado pela taskbar."
+          "tags": [{
+              "name": "description",
+              "text": "Emitido quando uma a\u00E7\u00E3o de salvar \u00E9 iniciada pela barra de tarefas, indicando um estado de bloqueio para evitar a\u00E7\u00F5es concorrentes."
+            }, {
+              "name": "eventProperty",
+              "text": undefined
+            }],
+          "text": ""
         },
         "complexType": {
           "original": "void",
@@ -799,8 +859,14 @@ export class SnkTaskbar {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
-          "text": "Emitido sempre que o ocorre alguma action que libera o save."
+          "tags": [{
+              "name": "description",
+              "text": "Emitido quando a a\u00E7\u00E3o de salvar \u00E9 conclu\u00EDda ou cancelada, liberando o estado de bloqueio."
+            }, {
+              "name": "eventProperty",
+              "text": undefined
+            }],
+          "text": ""
         },
         "complexType": {
           "original": "void",

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

@@ -26,79 +26,81 @@ export declare class SnkTaskbar {
   _hasToUpdateOverFlow: boolean;
   _isWaitingForSave: boolean;
   /**
-   * Usado para determinar O alinhamento dos items na taskbar.
+   * @description Define o alinhamento dos itens da barra de tarefas à direita.
    */
   alignRigth: boolean;
   /**
-   * Usado para determinar o identificador do slot que recebe elementos personalizados.
+   * @description Define o identificador do slot que recebe elementos personalizados.
    */
   customSlotId: string;
   /**
-   * Usado para determinar o identificador do container na DOM que é responsavel por guardar os elementos personalizados
+   * @description Define o identificador do contêiner na DOM que é responsável por guardar os elementos personalizados
    * que não podem ser passados por slot.
-   *
-   * Exemplo: Elementos customizados na Taskbar da aba de detalhes.
+   * @example
+   * Elementos customizados na Taskbar da aba de detalhes.
    */
   customContainerId: string;
   /**
-   * Define como será o comportamento da taskbar quando ocorrer overflow
+   * @description Define como será o comportamento da barra de tarefas quando ocorrer um overflow de itens.
    */
   overflowStrategy: 'hiddenItems' | 'none';
   /**
-   * Usado para guardar ou recuperar as configurações do formulário.
+   * @description Nome da configuração usada para salvar ou recuperar as configurações do formulário. Também é utilizado como fallback para a chave de armazenamento do exportador de dados.
    */
   configName: string;
   /**
-   * Identificador de recursos como configurações e acesso.
+   * @description Identificador de recursos, como configurações e permissões de acesso.
    */
   resourceID: string;
   /**
-   * Lista separada por virgula, contendo todos os elementos a serem criados.
+   * @description Lista de botões, separados por vírgula, que define todos os elementos a serem criados na barra de tarefas.
    */
   buttons: string;
   /**
-   * Mapa com definição de botões personalizados. A chave do mapa deve ser
-   * passada na lista "buttons" no lugar onde o botão irá aparecer.
+   * @description Mapa com definições de botões personalizados. A chave do mapa deve ser informada na propriedade `buttons` no local onde o botão deve ser renderizado.
    */
   customButtons: Map<string, CustomButton>;
   /**
-   * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
+   * @description Lista de ações a serem exibidas no botão "Mais opções".
    */
   actionsList: Array<Action>;
   /**
-   * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
+   * @description Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
    */
   actionsSettingsList: Array<Action>;
   /**
-   * Determina qual botão deve ter aparência primária.
+   * @description Define qual botão deve ter a aparência de destaque (primário).
    */
   primaryButton: string;
   /**
-   * Array contendo todos os botões a serem desabilitados.
+   * @description Array contendo os identificadores de todos os botões que devem ser desabilitados.
    */
   disabledButtons: Array<string>;
   /**
-   * Instância do DataUnit.
+   * @description Instância do `DataUnit` com a qual a barra de tarefas irá interagir para realizar operações de dados (ex: salvar, próximo, anterior).
    */
   dataUnit: DataUnit;
   /**
-   * Altera o modo de apresentação dos botões do snk-taskbar.
+   * @description Altera o modo de apresentação dos botões da barra de tarefas.
   */
   presentationMode: PresentationMode;
   /**
-   * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
+   * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
    */
   messagesBuilder: SnkMessageBuilder;
   /**
-   * Emitido sempre que houver click de botão ou ação.
+   * @description Emitido sempre que um botão ou uma ação da barra de tarefas é clicado.
+   * @eventProperty
    */
   actionClick: EventEmitter<string>;
   /**
-   * Emitido sempre que um save é iniciado pela taskbar.
+   * @description Emitido quando uma ação de salvar é iniciada pela barra de tarefas, indicando um estado de bloqueio para evitar ações concorrentes.
+   * @eventProperty
    */
   taskbarSaveLocker: EventEmitter<void>;
   /**
-   * Emitido sempre que o ocorre alguma action que libera o save.
+   * @description Emitido quando a ação de salvar é concluída ou cancelada, liberando o estado de bloqueio.
+   * @eventProperty
    */
   taskbarSaveUnlocker: EventEmitter<void>;
   handleCustomSlotElementsLoaded(event: CustomEvent): void;

package/dist/types/components.d.ts

@@ -2329,63 +2329,64 @@ export namespace Components {
     }
     interface SnkTaskbar {
         /**
-          * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
+          * @description Lista de ações a serem exibidas no botão "Mais opções".
          */
         "actionsList": Array<Action>;
         /**
-          * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
+          * @description Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
          */
         "actionsSettingsList": Array<Action>;
         /**
-          * Usado para determinar O alinhamento dos items na taskbar.
+          * @description Define o alinhamento dos itens da barra de tarefas à direita.
          */
         "alignRigth": boolean;
         /**
-          * Lista separada por virgula, contendo todos os elementos a serem criados.
+          * @description Lista de botões, separados por vírgula, que define todos os elementos a serem criados na barra de tarefas.
          */
         "buttons": string;
         /**
-          * Usado para guardar ou recuperar as configurações do formulário.
+          * @description Nome da configuração usada para salvar ou recuperar as configurações do formulário. Também é utilizado como fallback para a chave de armazenamento do exportador de dados.
          */
         "configName": string;
         /**
-          * Mapa com definição de botões personalizados. A chave do mapa deve ser passada na lista "buttons" no lugar onde o botão irá aparecer.
+          * @description Mapa com definições de botões personalizados. A chave do mapa deve ser informada na propriedade `buttons` no local onde o botão deve ser renderizado.
          */
         "customButtons": Map<string, CustomButton>;
         /**
-          * Usado para determinar o identificador do container na DOM que é responsavel por guardar os elementos personalizados que não podem ser passados por slot.  Exemplo: Elementos customizados na Taskbar da aba de detalhes.
+          * @description Define o identificador do contêiner na DOM que é responsável por guardar os elementos personalizados que não podem ser passados por slot.
+          * @example Elementos customizados na Taskbar da aba de detalhes.
          */
         "customContainerId": string;
         /**
-          * Usado para determinar o identificador do slot que recebe elementos personalizados.
+          * @description Define o identificador do slot que recebe elementos personalizados.
          */
         "customSlotId": string;
         /**
-          * Instância do DataUnit.
+          * @description Instância do `DataUnit` com a qual a barra de tarefas irá interagir para realizar operações de dados (ex: salvar, próximo, anterior).
          */
         "dataUnit": DataUnit;
         /**
-          * Array contendo todos os botões a serem desabilitados.
+          * @description Array contendo os identificadores de todos os botões que devem ser desabilitados.
          */
         "disabledButtons": Array<string>;
         /**
-          * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
+          * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
          */
         "messagesBuilder": SnkMessageBuilder;
         /**
-          * Define como será o comportamento da taskbar quando ocorrer overflow
+          * @description Define como será o comportamento da barra de tarefas quando ocorrer um overflow de itens.
          */
         "overflowStrategy": 'hiddenItems' | 'none';
         /**
-          * Altera o modo de apresentação dos botões do snk-taskbar.
+          * @description Altera o modo de apresentação dos botões da barra de tarefas.
          */
         "presentationMode": PresentationMode1;
         /**
-          * Determina qual botão deve ter aparência primária.
+          * @description Define qual botão deve ter a aparência de destaque (primário).
          */
         "primaryButton": string;
         /**
-          * Identificador de recursos como configurações e acesso.
+          * @description Identificador de recursos, como configurações e permissões de acesso.
          */
         "resourceID": string;
     }
@@ -4852,75 +4853,79 @@ declare namespace LocalJSX {
     }
     interface SnkTaskbar {
         /**
-          * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
+          * @description Lista de ações a serem exibidas no botão "Mais opções".
          */
         "actionsList"?: Array<Action>;
         /**
-          * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
+          * @description Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
          */
         "actionsSettingsList"?: Array<Action>;
         /**
-          * Usado para determinar O alinhamento dos items na taskbar.
+          * @description Define o alinhamento dos itens da barra de tarefas à direita.
          */
         "alignRigth"?: boolean;
         /**
-          * Lista separada por virgula, contendo todos os elementos a serem criados.
+          * @description Lista de botões, separados por vírgula, que define todos os elementos a serem criados na barra de tarefas.
          */
         "buttons"?: string;
         /**
-          * Usado para guardar ou recuperar as configurações do formulário.
+          * @description Nome da configuração usada para salvar ou recuperar as configurações do formulário. Também é utilizado como fallback para a chave de armazenamento do exportador de dados.
          */
         "configName"?: string;
         /**
-          * Mapa com definição de botões personalizados. A chave do mapa deve ser passada na lista "buttons" no lugar onde o botão irá aparecer.
+          * @description Mapa com definições de botões personalizados. A chave do mapa deve ser informada na propriedade `buttons` no local onde o botão deve ser renderizado.
          */
         "customButtons"?: Map<string, CustomButton>;
         /**
-          * Usado para determinar o identificador do container na DOM que é responsavel por guardar os elementos personalizados que não podem ser passados por slot.  Exemplo: Elementos customizados na Taskbar da aba de detalhes.
+          * @description Define o identificador do contêiner na DOM que é responsável por guardar os elementos personalizados que não podem ser passados por slot.
+          * @example Elementos customizados na Taskbar da aba de detalhes.
          */
         "customContainerId"?: string;
         /**
-          * Usado para determinar o identificador do slot que recebe elementos personalizados.
+          * @description Define o identificador do slot que recebe elementos personalizados.
          */
         "customSlotId"?: string;
         /**
-          * Instância do DataUnit.
+          * @description Instância do `DataUnit` com a qual a barra de tarefas irá interagir para realizar operações de dados (ex: salvar, próximo, anterior).
          */
         "dataUnit"?: DataUnit;
         /**
-          * Array contendo todos os botões a serem desabilitados.
+          * @description Array contendo os identificadores de todos os botões que devem ser desabilitados.
          */
         "disabledButtons"?: Array<string>;
         /**
-          * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
+          * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
          */
         "messagesBuilder"?: SnkMessageBuilder;
         /**
-          * Emitido sempre que houver click de botão ou ação.
+          * @description Emitido sempre que um botão ou uma ação da barra de tarefas é clicado.
+          * @eventProperty
          */
         "onActionClick"?: (event: SnkTaskbarCustomEvent<string>) => void;
         /**
-          * Emitido sempre que um save é iniciado pela taskbar.
+          * @description Emitido quando uma ação de salvar é iniciada pela barra de tarefas, indicando um estado de bloqueio para evitar ações concorrentes.
+          * @eventProperty
          */
         "onTaskbarSaveLocker"?: (event: SnkTaskbarCustomEvent<void>) => void;
         /**
-          * Emitido sempre que o ocorre alguma action que libera o save.
+          * @description Emitido quando a ação de salvar é concluída ou cancelada, liberando o estado de bloqueio.
+          * @eventProperty
          */
         "onTaskbarSaveUnlocker"?: (event: SnkTaskbarCustomEvent<void>) => void;
         /**
-          * Define como será o comportamento da taskbar quando ocorrer overflow
+          * @description Define como será o comportamento da barra de tarefas quando ocorrer um overflow de itens.
          */
         "overflowStrategy"?: 'hiddenItems' | 'none';
         /**
-          * Altera o modo de apresentação dos botões do snk-taskbar.
+          * @description Altera o modo de apresentação dos botões da barra de tarefas.
          */
         "presentationMode"?: PresentationMode1;
         /**
-          * Determina qual botão deve ter aparência primária.
+          * @description Define qual botão deve ter a aparência de destaque (primário).
          */
         "primaryButton"?: string;
         /**
-          * Identificador de recursos como configurações e acesso.
+          * @description Identificador de recursos, como configurações e permissões de acesso.
          */
         "resourceID"?: string;
     }

package/package.json

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