@sankhyalabs/sankhyablocks-docs 10.0.4 → 10.1.0-dev.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. package/components/snk-application/readme.md +12 -0
  2. package/components/snk-attach/readme.md +1 -0
  3. package/components/snk-configurator/readme.md +13 -9
  4. package/components/snk-crud/readme.md +33 -7
  5. package/components/snk-crud/subcomponents/readme.md +20 -6
  6. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +1 -0
  7. package/components/snk-custom-slot-guide/readme.md +24 -0
  8. package/components/snk-form-config/readme.md +1 -0
  9. package/components/snk-grid/readme.md +40 -39
  10. package/components/snk-numbering-config/readme.md +45 -0
  11. package/components/snk-pesquisa/readme.md +14 -0
  12. package/components/snk-simple-crud/readme.md +1 -0
  13. package/components/snk-taskbar/readme.md +1 -0
  14. package/package.json +1 -1
package/components/snk-application/readme.md CHANGED
@@ -184,6 +184,18 @@ Uma lista de opções ou uma única opção.
184
184
 
185
185
  ---
186
186
 
187
+ ### `executePreparedSearchWithFullResponse(argument: string, options: any) => Promise<any>`
188
+
189
+ Obtém as opções em componentes de pesquisa além dos metadados como showMore e entityPk.
190
+
191
+ #### Returns
192
+
193
+ Type: `Promise<any>`
194
+
195
+ Uma lista de opções ou uma única opção.
196
+
197
+ ---
198
+
187
199
  ### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: ISearchCtxOptions) => Promise<Array<IOption> | IOption>`
188
200
 
189
201
  Obtém as opções em componentes de pesquisa.
package/components/snk-attach/readme.md CHANGED
@@ -58,6 +58,7 @@ graph TD;
58
58
  snk-taskbar --> taskbar-actions-button
59
59
  snk-data-exporter --> snk-exporter-email-sender
60
60
  snk-configurator --> snk-layout-form-config
61
+ snk-configurator --> snk-numbering-config
61
62
  snk-layout-form-config --> snk-view-representation
62
63
  snk-grid-config --> snk-select-box
63
64
  snk-crud --> snk-attach
package/components/snk-configurator/readme.md CHANGED
@@ -7,15 +7,17 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------- | --------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ---------------- |
12
- | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
13
- | `customContainerId` | `custom-container-id` | ID do container que contém os elementos customizados do configurator. | `string` | `undefined` |
14
- | `layoutFormConfig` | `layout-form-config` | Define se o LayoutFormConfig será exibido no configurador. | `boolean` | `true` |
15
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
16
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
17
- | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação | `boolean` | `false` |
18
- | `viewMode` | `view-mode` | Define qual modo de visualização está ativo. | `VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID` | `VIEW_MODE.GRID` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------------ | -------------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ---------------- |
12
+ | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
13
+ | `customContainerId` | `custom-container-id` | ID do container que contém os elementos customizados do configurator. | `string` | `undefined` |
14
+ | `disableNumberingConfig` | `disable-numbering-config` | Define se a configuração de numeração será desabilitada. | `boolean` | `false` |
15
+ | `entityName` | `entity-name` | Nome da entidade que está sendo configurada. | `string` | `undefined` |
16
+ | `layoutFormConfig` | `layout-form-config` | Define se o LayoutFormConfig será exibido no configurador. | `boolean` | `true` |
17
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
18
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
19
+ | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação | `boolean` | `false` |
20
+ | `viewMode` | `view-mode` | Define qual modo de visualização está ativo. | `VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID` | `VIEW_MODE.GRID` |
19
21
 
20
22
 
21
23
  ## Events
@@ -62,11 +64,13 @@ Type: `Promise<void>`
62
64
  ### Depends on
63
65
 
64
66
  - [snk-layout-form-config](../snk-layout-form-config)
67
+ - [snk-numbering-config](../snk-numbering-config)
65
68
 
66
69
  ### Graph
67
70
  ```mermaid
68
71
  graph TD;
69
72
  snk-configurator --> snk-layout-form-config
73
+ snk-configurator --> snk-numbering-config
70
74
  snk-layout-form-config --> snk-view-representation
71
75
  snk-crud --> snk-configurator
72
76
  snk-guides-viewer --> snk-configurator
package/components/snk-crud/readme.md CHANGED
@@ -13,6 +13,8 @@
13
13
  | `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
14
14
  | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
15
15
  | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
16
+ | `customGuidesConfig` | -- | Fornece as informações das guias personalizadas. | `CustomGuideItem[]` | `[]` |
17
+ | `disableNumberingConfig` | `disable-numbering-config` | Define se a configuração de numeração será desabilitada. | `boolean` | `false` |
16
18
  | `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados). | `boolean` | `undefined` |
17
19
  | `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
18
20
  | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
@@ -33,6 +35,7 @@
33
35
  | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
34
36
  | `setCustomFormTitle` | -- | Define uma função para configurar um título cusotmizado no modo formulário. | `() => string` | `undefined` |
35
37
  | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
38
+ | `showEntitySearch` | `show-entity-search` | Define se o campo de busca de entidades será exibido na barra superior. | `boolean` | `true` |
36
39
  | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
37
40
  | `strategyExporter` | `strategy-exporter` | Modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
38
41
  | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
@@ -41,13 +44,15 @@
41
44
 
42
45
  ## Events
43
46
 
44
- | Event | Description | Type |
45
- | -------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
46
- | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
47
- | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
48
- | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
49
- | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
50
- | `viewModeChanged` | | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
47
+ | Event | Description | Type |
48
+ | ------------------------ | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
49
+ | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
50
+ | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
51
+ | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
52
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
53
+ | `numberingConfigChanged` | Emitido quando a configuração de numeração é alterada. | `CustomEvent<ResponseGetConfig>` |
54
+ | `snkShowGuide` | Emitido pelo guides-viewer sempre que houver mudança de guia. | `CustomEvent<string>` |
55
+ | `viewModeChanged` | | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
51
56
 
52
57
 
53
58
  ## Methods
@@ -102,6 +107,16 @@ Type: `Promise<HTMLSnkFilterBarElement>`
102
107
 
103
108
  ---
104
109
 
110
+ ### `getNumberingConfig() => Promise<ResponseGetConfig>`
111
+
112
+ Retorna a configuração de numeração atual.
113
+
114
+ #### Returns
115
+
116
+ Type: `Promise<ResponseGetConfig>`
117
+
118
+ ---
119
+
105
120
  ### `goToView(mode: string) => Promise<void>`
106
121
 
107
122
  Usado para alternar a visão entre GRID e FORM externamente.
@@ -150,6 +165,16 @@ Altera/adiciona uma propriedade nos metadados do campo.
150
165
 
151
166
  Type: `Promise<void>`
152
167
 
168
+ ---
169
+
170
+ ### `updateNumberingConfig(config: ResponseGetConfig) => Promise<void>`
171
+
172
+ Atualiza a configuração de numeração.
173
+
174
+ #### Returns
175
+
176
+ Type: `Promise<void>`
177
+
153
178
 
154
179
 
155
180
 
@@ -237,6 +262,7 @@ graph TD;
237
262
  snk-simple-crud --> taskbar-split-button
238
263
  snk-simple-crud --> taskbar-actions-button
239
264
  snk-configurator --> snk-layout-form-config
265
+ snk-configurator --> snk-numbering-config
240
266
  snk-layout-form-config --> snk-view-representation
241
267
  snk-form-config --> config-header
242
268
  snk-form-config --> guides-configurator
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -12,6 +12,7 @@
12
12
  | `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
13
13
  | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
14
  | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
15
+ | `customGuidesConfig` | -- | Fornece as informações das guias personalizadas. | `CustomGuideItem[]` | `[]` |
15
16
  | `dataState` | -- | Representa o estado do dataUnit master. | `DataState` | `undefined` |
16
17
  | `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
17
18
  | `detailTaskbarCustomContainerId` | `detail-taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. | `string` | `undefined` |
@@ -31,12 +32,14 @@
31
32
 
32
33
  ## Events
33
34
 
34
- | Event | Description | Type |
35
- | --------------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
36
- | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
37
- | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
38
- | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
39
- | `snkMasterFormConfigChange` | Emitido quando a configuração do formulário master é definida. | `CustomEvent<IFormConfig>` |
35
+ | Event | Description | Type |
36
+ | ----------------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
37
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
38
+ | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
39
+ | `formConfigVisibilityChanged` | Emitido quando a visibilidade do configurador do formulário é alterada. | `CustomEvent<boolean>` |
40
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
41
+ | `snkMasterFormConfigChange` | Emitido quando a configuração do formulário master é definida. | `CustomEvent<IFormConfig>` |
42
+ | `snkShowGuide` | Emitido quando a uma gua é exibida no formulário. | `CustomEvent<string>` |
40
43
 
41
44
 
42
45
  ## Methods
@@ -61,6 +64,16 @@ Type: `Promise<void>`
61
64
 
62
65
  ---
63
66
 
67
+ ### `reloadGuides() => Promise<void>`
68
+
69
+ Recarrega os guias baseada nos metadados atuais.
70
+
71
+ #### Returns
72
+
73
+ Type: `Promise<void>`
74
+
75
+ ---
76
+
64
77
  ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
65
78
 
66
79
  Altera/adiciona uma propriedade nos metadados do campo.
@@ -174,6 +187,7 @@ graph TD;
174
187
  snk-simple-crud --> taskbar-split-button
175
188
  snk-simple-crud --> taskbar-actions-button
176
189
  snk-configurator --> snk-layout-form-config
190
+ snk-configurator --> snk-numbering-config
177
191
  snk-layout-form-config --> snk-view-representation
178
192
  snk-form-config --> config-header
179
193
  snk-form-config --> guides-configurator
package/components/snk-crud/subcomponents/snk-detail-view/readme.md CHANGED
@@ -160,6 +160,7 @@ graph TD;
160
160
  snk-simple-crud --> taskbar-split-button
161
161
  snk-simple-crud --> taskbar-actions-button
162
162
  snk-configurator --> snk-layout-form-config
163
+ snk-configurator --> snk-numbering-config
163
164
  snk-layout-form-config --> snk-view-representation
164
165
  snk-guides-viewer --> snk-detail-view
165
166
  style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
package/components/snk-custom-slot-guide/readme.md ADDED
@@ -0,0 +1,24 @@
1
+ # snk-custom-slot-guide
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------- | ----------- | ------------------------------------------------------------- | -------- | --------------------- |
12
+ | `slotName` | `slot-name` | Nome do slot onde os elementos customizados deverão aparecer. | `string` | `'CUSTOM_SLOT_GUIDE'` |
13
+
14
+
15
+ ## Events
16
+
17
+ | Event | Description | Type |
18
+ | -------------------------- | -------------------------------------------- | --------------------- |
19
+ | `snkCustomSlotGuideLoaded` | Emitido quando elemento é carregado na tela. | `CustomEvent<string>` |
20
+
21
+
22
+ ----------------------------------------------
23
+
24
+
package/components/snk-form-config/readme.md CHANGED
@@ -10,6 +10,7 @@
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | -------------------------- | ------------------------------ | -------------------------------------------------------------------------------------- | ---------------------- | ----------- |
12
12
  | `configManager` | -- | Campos de configuração de formulário. | `SnkFormConfigManager` | `undefined` |
13
+ | `customGuidesConfig` | -- | Informações das guias personalizadas. | `CustomGuideItem[]` | `[]` |
13
14
  | `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
14
15
  | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
15
16
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
package/components/snk-grid/readme.md CHANGED
@@ -7,45 +7,46 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | --------------------------------------- |
12
- | `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do `snk-taskbar`. | `Action[]` | `undefined` |
13
- | `autoFocus` | `auto-focus` | Define se a grade receberá o foco automaticamente ao ser carregada. | `boolean` | `true` |
14
- | `autoLoad` | `auto-load` | Define se os dados serão carregados automaticamente na inicialização do componente. | `boolean` | `undefined` |
15
- | `canEdit` | `can-edit` | Define se a edição de dados na grade está habilitada. | `boolean` | `true` |
16
- | `columnFilterDataSource` | -- | Define o data source para o filtro de colunas. | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
17
- | `compact` | `compact` | Define se a grade deve ser exibida em modo compacto. | `boolean` | `undefined` |
18
- | `configName` | `config-name` | Nome usado para salvar e recuperar a configuração da grade. | `string` | `undefined` |
19
- | `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na barra de filtros (chip de filtros) e no modal lateral de filtros (contêiner de filtros personalizados). | `boolean` | `undefined` |
20
- | `enableGridInsert` | `enable-grid-insert` | Habilita a inserção de registros diretamente na grade. | `boolean` | `false` |
21
- | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação. | `boolean` | `false` |
22
- | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar. | `boolean` | `false` |
23
- | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legada da barra de filtros. | `string` | `undefined` |
24
- | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros. | `string` | `undefined` |
25
- | `filterCustomConfig` | -- | | `SnkFilterItemConfig[]` | `undefined` |
26
- | `filterCustomConfigInterceptor` | -- | | `(config: SnkFilterItemConfig[]) => SnkFilterItemConfig[]` | `undefined` |
27
- | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
28
- | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legada da grade. | `string` | `undefined` |
29
- | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe de outra tela. | `boolean` | `undefined` |
30
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
31
- | `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultaneamente. | `boolean` | `true` |
32
- | `multipleSelection` | `multiple-selection` | Determina se a seleção de múltiplas linhas é permitida. | `boolean` | `undefined` |
33
- | `outlineMode` | `outline-mode` | Altera a aparência das bordas e sombras do componente. Se `false`, aplica o padrão de sombras (ideal para o elemento principal do layout). Se `true`, aplica um contorno (ideal para quando o componente está dentro de outro, como um painel ou pop-up). | `boolean` | `false` |
34
- | `paginationCounterMode` | `pagination-counter-mode` | Define o modo de exibição do contador de paginação. | `"auto" \| "hidden" \| "show"` | `'auto'` |
35
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do `snk-taskbar`. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
36
- | `recordsValidator` | -- | Validador responsável por verificar a integridade dos dados de um registro. | `IRecordValidator` | `undefined` |
37
- | `resourceID` | `resource-i-d` | Identificador de recursos, como configurações e permissões de acesso. | `string` | `undefined` |
38
- | `selectionToastConfig` | -- | Configuração do toast de seleção da grade. | `ISelectionToastConfig` | `undefined` |
39
- | `statusResolver` | -- | Define a configuração de cores para a coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` |
40
- | `strategyExporter` | `strategy-exporter` | Define o modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
41
- | `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de checkbox deve ser suprimida. | `boolean` | `undefined` |
42
- | `suppressFilterColumn` | `suppress-filter-column` | Informa se a grade deve suprimir o filtro de coluna. | `boolean` | `false` |
43
- | `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir a barra de rolagem horizontal. | `boolean` | `false` |
44
- | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do contêiner de elementos customizados da `Taskbar`. | `string` | `undefined` |
45
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. Permite determinar botões específicos ou gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
46
- | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Define o nome do slot para elementos customizados na `Taskbar` principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
47
- | `useEnterLikeTab` | `use-enter-like-tab` | Quando `true`, a tecla ENTER navega entre as células como a tecla TAB. | `boolean` | `false` |
48
- | `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`. | `boolean` | `true` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------------------- | ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | --------------------------------------- |
12
+ | `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do `snk-taskbar`. | `Action[]` | `undefined` |
13
+ | `autoFocus` | `auto-focus` | Define se a grade receberá o foco automaticamente ao ser carregada. | `boolean` | `true` |
14
+ | `autoLoad` | `auto-load` | Define se os dados serão carregados automaticamente na inicialização do componente. | `boolean` | `undefined` |
15
+ | `canEdit` | `can-edit` | Define se a edição de dados na grade está habilitada. | `boolean` | `true` |
16
+ | `columnFilterDataSource` | -- | Define o data source para o filtro de colunas. | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
17
+ | `compact` | `compact` | Define se a grade deve ser exibida em modo compacto. | `boolean` | `undefined` |
18
+ | `configName` | `config-name` | Nome usado para salvar e recuperar a configuração da grade. | `string` | `undefined` |
19
+ | `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na barra de filtros (chip de filtros) e no modal lateral de filtros (contêiner de filtros personalizados). | `boolean` | `undefined` |
20
+ | `enableGridInsert` | `enable-grid-insert` | Habilita a inserção de registros diretamente na grade. | `boolean` | `false` |
21
+ | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação. | `boolean` | `false` |
22
+ | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar. | `boolean` | `false` |
23
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legada da barra de filtros. | `string` | `undefined` |
24
+ | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros. | `string` | `undefined` |
25
+ | `filterCustomConfig` | -- | | `SnkFilterItemConfig[]` | `undefined` |
26
+ | `filterCustomConfigInterceptor` | -- | | `(config: SnkFilterItemConfig[]) => SnkFilterItemConfig[]` | `undefined` |
27
+ | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
28
+ | `gridHeaderDynamicSearchSlotId` | `grid-header-dynamic-search-slot-id` | Define o nome do slot para a aba de pesquisa no cabeçalho da grade. | `string` | `'GRID_HEADER_DYNAMIC_SEARCH'` |
29
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legada da grade. | `string` | `undefined` |
30
+ | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe de outra tela. | `boolean` | `undefined` |
31
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
32
+ | `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultaneamente. | `boolean` | `true` |
33
+ | `multipleSelection` | `multiple-selection` | Determina se a seleção de múltiplas linhas é permitida. | `boolean` | `undefined` |
34
+ | `outlineMode` | `outline-mode` | Altera a aparência das bordas e sombras do componente. Se `false`, aplica o padrão de sombras (ideal para o elemento principal do layout). Se `true`, aplica um contorno (ideal para quando o componente está dentro de outro, como um painel ou pop-up). | `boolean` | `false` |
35
+ | `paginationCounterMode` | `pagination-counter-mode` | Define o modo de exibição do contador de paginação. | `"auto" \| "hidden" \| "show"` | `'auto'` |
36
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do `snk-taskbar`. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
37
+ | `recordsValidator` | -- | Validador responsável por verificar a integridade dos dados de um registro. | `IRecordValidator` | `undefined` |
38
+ | `resourceID` | `resource-i-d` | Identificador de recursos, como configurações e permissões de acesso. | `string` | `undefined` |
39
+ | `selectionToastConfig` | -- | Configuração do toast de seleção da grade. | `ISelectionToastConfig` | `undefined` |
40
+ | `statusResolver` | -- | Define a configuração de cores para a coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` |
41
+ | `strategyExporter` | `strategy-exporter` | Define o modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
42
+ | `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de checkbox deve ser suprimida. | `boolean` | `undefined` |
43
+ | `suppressFilterColumn` | `suppress-filter-column` | Informa se a grade deve suprimir o filtro de coluna. | `boolean` | `false` |
44
+ | `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir a barra de rolagem horizontal. | `boolean` | `false` |
45
+ | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do contêiner de elementos customizados da `Taskbar`. | `string` | `undefined` |
46
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. Permite determinar botões específicos ou gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
47
+ | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Define o nome do slot para elementos customizados na `Taskbar` principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
48
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando `true`, a tecla ENTER navega entre as células como a tecla TAB. | `boolean` | `false` |
49
+ | `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`. | `boolean` | `true` |
49
50
 
50
51
 
51
52
  ## Events
package/components/snk-numbering-config/readme.md ADDED
@@ -0,0 +1,45 @@
1
+ # snk-numbering-config
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | -------------- | ------------------------------------------------------ | ------------------- | ----------- |
12
+ | `entityName` | `entity-name` | Nome da entidade que está sendo configurada. | `string` | `undefined` |
13
+ | `messagesBuilder` | -- | Usado para exibir os mensagens de configuração. | `SnkMessageBuilder` | `undefined` |
14
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
15
+
16
+
17
+ ## Methods
18
+
19
+ ### `save() => Promise<boolean>`
20
+
21
+ Salva ou recupera as configurações de numeração.
22
+
23
+ #### Returns
24
+
25
+ Type: `Promise<boolean>`
26
+
27
+
28
+
29
+
30
+ ## Dependencies
31
+
32
+ ### Used by
33
+
34
+ - [snk-configurator](../snk-configurator)
35
+
36
+ ### Graph
37
+ ```mermaid
38
+ graph TD;
39
+ snk-configurator --> snk-numbering-config
40
+ style snk-numbering-config fill:#f9f,stroke:#333,stroke-width:4px
41
+ ```
42
+
43
+ ----------------------------------------------
44
+
45
+
package/components/snk-pesquisa/readme.md CHANGED
@@ -18,6 +18,20 @@
18
18
  | `treeLoader` | -- | Função responsável por carregar a árvore hierárquica do componente. Opcional. Caso não seja fornecida, o modo árvore não estará disponível. | `(text: string) => Promise<any>` | `undefined` |
19
19
 
20
20
 
21
+ ## Methods
22
+
23
+ ### `executeSearch(text: string) => Promise<void>`
24
+
25
+ * Executa uma pesquisa programaticamente.
26
+ Útil para cenários onde a pesquisa precisa ser disparada sem interação do usuário.
27
+
28
+ #### Returns
29
+
30
+ Type: `Promise<void>`
31
+
32
+
33
+
34
+
21
35
  ## Dependencies
22
36
 
23
37
  ### Used by
package/components/snk-simple-crud/readme.md CHANGED
@@ -214,6 +214,7 @@ graph TD;
214
214
  snk-taskbar --> taskbar-actions-button
215
215
  snk-data-exporter --> snk-exporter-email-sender
216
216
  snk-configurator --> snk-layout-form-config
217
+ snk-configurator --> snk-numbering-config
217
218
  snk-layout-form-config --> snk-view-representation
218
219
  snk-grid-config --> snk-select-box
219
220
  snk-attach --> snk-simple-crud
package/components/snk-taskbar/readme.md CHANGED
@@ -11,6 +11,7 @@
11
11
  | --------------------- | --------------------- | ----------- | ------------------------------------------------------------------------------------------- | --------------------------- |
12
12
  | `actionsList` | -- | | `Action[]` | `undefined` |
13
13
  | `actionsSettingsList` | -- | | `Action[]` | `undefined` |
14
+ | `additionalSlotId` | `additional-slot-id` | | `string` | `"TASKBAR_ADDITIONAL_SLOT"` |
14
15
  | `alignRigth` | `align-rigth` | | `boolean` | `false` |
15
16
  | `buttons` | `buttons` | | `string` | `undefined` |
16
17
  | `configName` | `config-name` | | `string` | `undefined` |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "10.0.4",
3
+ "version": "10.1.0-dev.10",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [