@sankhyalabs/sankhyablocks 9.1.3-rc.2 → 9.1.3-rc.3

package/dist/cjs/snk-grid.cjs.entry.js

@@ -171,11 +171,18 @@ const SnkGrid = class {
       btns.unshift(taskbarElements.TaskbarElement.UPDATE_MULTIPLE);
     return btns;
   }
+  /**
+   * Recarrega a configuração da grade.
+   * @description Este método força o recarregamento da configuração da grade a partir do `ConfigStorage`. A operação é assíncrona, mas o método não aguarda sua conclusão.
+   */
   reloadConfig() {
     this.loadConfig();
   }
   /**
    * Exibe a janela de configurações da grade.
+   * @async
+   * @description Este método abre o pop-up de configuração de colunas da grade, permitindo ao usuário ajustar a visibilidade, ordem e largura das colunas.
+   * @returns {Promise<void>} Uma promessa que é resolvida quando a janela de configuração é exibida.
    */
   async showConfig() {
     if (this._grid == undefined) {
@@ -185,6 +192,9 @@ const SnkGrid = class {
   }
   /**
    * Fecha a janela de configurações da grade.
+   * @async
+   * @description Este método fecha o pop-up de configuração de colunas da grade.
+   * @returns {Promise<void>} Uma promessa que é resolvida quando a janela de configuração é fechada.
    */
   async hideConfig() {
     if (this._grid == undefined) {
@@ -193,26 +203,42 @@ const SnkGrid = class {
     this.closeGridConfig();
   }
   /**
-   * Atribui o valor da configuração da grade.
+   * Define a configuração da grade.
+   * @async
+   * @description Aplica uma nova configuração de colunas e ordenação à grade.
+   * @param {IGridConfig} config O objeto de configuração a ser aplicado na grade.
+   * @returns {Promise<void>} Uma promessa que é resolvida quando a configuração é aplicada.
    */
   async setConfig(config) {
     this.setGridConfig(config);
   }
   /**
-   * Faz o recarregamento da filter-bar da grade buscando o state no servidor.
+   * Recarrega a barra de filtros da grade, buscando o estado do servidor.
+   * @async
+   * @description Força o recarregamento da barra de filtros, atualizando suas configurações e filtros a partir do servidor.
+   * @returns {Promise<void>} Uma promessa que é resolvida quando a barra de filtros é recarregada.
    */
   async reloadFilterBar() {
     var _a;
     (_a = this._snkFilterBar) === null || _a === void 0 ? void 0 : _a.reload();
   }
   /**
-   * Retorna o elemento da filter-bar da grade.
+   * Retorna o elemento da barra de filtros da grade.
+   * @async
+   * @description Este método permite acessar o elemento da barra de filtros, que pode ser útil para manipulações adicionais ou para obter o estado atual dos filtros aplicados.
+   * @returns {Promise<HTMLSnkFilterBarElement>} O elemento da barra de filtros.
    */
   async getFilterBar() {
     return this._snkFilterBar;
   }
   /**
-   * Registra um editor customizado para campos da grade e formulário
+   * Registra um editor customizado para um campo da grade ou formulário.
+   * @async
+   * @description Adiciona um componente de edição personalizado para um campo específico. Este editor será usado tanto na edição em linha na grade quanto em formulários de detalhe.
+   * @param {string} fieldName O nome do campo que receberá o editor customizado.
+   * @param {ICustomEditor} customEditor A instância do editor customizado.
+   * @param {string} [detailContext] O contexto de detalhe onde o editor será aplicado (opcional).
+   * @returns {Promise<void>} Uma promessa que é resolvida quando o editor é registrado.
    */
   async addCustomEditor(fieldName, customEditor, detailContext) {
     if (this._grid) {
@@ -224,7 +250,13 @@ const SnkGrid = class {
     this._customEditors = newCustomEditors;
   }
   /**
-   * Registra um render customizado para colunas da grid.
+   * Registra um renderizador customizado para uma coluna da grade.
+   * @async
+   * @description Adiciona um componente de renderização personalizado para uma coluna específica, permitindo a exibição de conteúdo customizado nas células.
+   * @param {string} fieldName O nome do campo (coluna) que receberá o renderizador customizado.
+   * @param {ICustomRender} customRender A instância do renderizador customizado.
+   * @param {string} [detailContext] O contexto de detalhe onde o renderizador será aplicado (opcional).
+   * @returns {Promise<void>} Uma promessa que é resolvida quando o renderizador é registrado.
    */
   async addGridCustomRender(fieldName, customRender, detailContext) {
     if (this._grid) {
@@ -236,19 +268,31 @@ const SnkGrid = class {
     this._customRenders = newCustomRenders;
   }
   /**
-   * Registra um formatador de valores para uma coluna da grid.
+   * Registra um formatador de valor customizado para uma coluna da grade.
+   * @async
+   * @description Adiciona uma função de formatação personalizada para os valores de uma coluna específica, afetando como os dados são exibidos.
+   * @param {string} columnName O nome da coluna que receberá o formatador.
+   * @param {ICustomFormatter} customFormatter A instância do formatador de valor.
+   * @returns {Promise<void>} Uma promessa que é resolvida quando o formatador é registrado.
    */
   async addCustomValueFormatter(columnName, customFormatter) {
     this._grid.addCustomValueFormatter(columnName, customFormatter);
   }
   /**
-   * Remove o formatador de valores de uma coluna da grid.
+   * Remove um formatador de valor customizado de uma coluna da grade.
+   * @async
+   * @description Remove uma função de formatação personalizada previamente registrada para uma coluna.
+   * @param {string} columnName O nome da coluna da qual o formatador será removido.
+   * @returns {Promise<void>} Uma promessa que é resolvida quando o formatador é removido.
    */
   async removeCustomValueFormatter(columnName) {
     this._grid.removeCustomValueFormatter(columnName);
   }
   /**
    * Atribui o foco para a grade.
+   * @async
+   * @description Move o foco do navegador para o componente da grade, permitindo a navegação por teclado.
+   * @returns {Promise<void>} Uma promessa que é resolvida quando o foco é atribuído.
    */
   async setFocus() {
     this._grid.setFocus();