@sankhyalabs/sankhyablocks-docs 9.2.0-dev.2 → 9.2.0-dev.20

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 (23) hide show
  1. package/components/snk-application/readme.md +90 -26
  2. package/components/snk-configurator/readme.md +1 -1
  3. package/components/snk-crud/readme.md +12 -9
  4. package/components/snk-crud/subcomponents/readme.md +7 -4
  5. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +7 -4
  6. package/components/snk-data-exporter/exporter-email-sender/readme.md +1 -1
  7. package/components/snk-data-unit/readme.md +10 -2
  8. package/components/snk-entity-list/readme.md +1 -0
  9. package/components/snk-filter-bar/filter-item/editors/readme.md +28 -4
  10. package/components/snk-filter-bar/filter-item/readme.md +1 -1
  11. package/components/snk-filter-bar/filter-modal/readme.md +20 -13
  12. package/components/snk-filter-bar/readme.md +48 -24
  13. package/components/snk-filter-field-search/readme.md +1 -1
  14. package/components/snk-form/readme.md +20 -10
  15. package/components/snk-grid/readme.md +81 -47
  16. package/components/snk-personalized-filter/readme.md +11 -11
  17. package/components/snk-personalized-filter/subcomponents/snk-filter-param-config/readme.md +1 -1
  18. package/components/snk-pesquisa/readme.md +9 -9
  19. package/components/snk-simple-bar/readme.md +6 -6
  20. package/components/snk-simple-crud/readme.md +60 -58
  21. package/components/snk-taskbar/elements/taskbar-actions-button/readme.md +2 -2
  22. package/components/snk-taskbar/readme.md +22 -22
  23. package/package.json +1 -1
package/components/snk-grid/readme.md CHANGED
@@ -7,94 +7,105 @@
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 componente snk-taskbar. | `Action[]` | `undefined` |
13
- | `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
14
- | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
15
- | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
16
- | `columnFilterDataSource` | -- | | `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/recuperar a configuração. | `string` | `undefined` |
19
- | `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` |
20
- | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo 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 legado da barra de filtros. | `string` | `undefined` |
24
- | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
25
- | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
26
- | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
27
- | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
28
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
29
- | `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultâneos. | `boolean` | `true` |
30
- | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
31
- | `outlineMode` | `outline-mode` | Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up) | `boolean` | `false` |
32
- | `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'auto'` |
33
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
34
- | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
35
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
36
- | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
37
- | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
38
- | `strategyExporter` | `strategy-exporter` | Modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
39
- | `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de chechbox deve ser suprimida | `boolean` | `undefined` |
40
- | `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir o scroll horizontal. | `boolean` | `false` |
41
- | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
42
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
43
- | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
44
- | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
45
- | `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de coluna com uso do 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
+ | `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` |
46
49
 
47
50
 
48
51
  ## Events
49
52
 
50
53
  | Event | Description | Type |
51
54
  | ----------------- | ------------------------------------------------------------ | --------------------- |
52
- | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
55
+ | `actionClick` | Emitido ao clicar em um botão de ação ou item de menu. | `CustomEvent<string>` |
53
56
  | `componentReady` | Emitido quando o componente estiver completamente carregado. | `CustomEvent<void>` |
54
- | `gridDoubleClick` | Emitido sempre que houver duplo click na grade. | `CustomEvent<any>` |
57
+ | `gridDoubleClick` | Emitido ao realizar um duplo clique em uma linha da grade. | `CustomEvent<any>` |
55
58
 
56
59
 
57
60
  ## Methods
58
61
 
59
62
  ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
60
63
 
61
- Registra um editor customizado para campos da grade e formulário
64
+ Registra um editor customizado para um campo da grade ou formulário.
62
65
 
63
66
  #### Returns
64
67
 
65
68
  Type: `Promise<void>`
66
69
 
70
+ Uma promessa que é resolvida quando o editor é registrado.
67
71
 
72
+ ---
68
73
 
69
74
  ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
70
75
 
71
- Registra um formatador de valores para uma coluna da grid.
76
+ Registra um formatador de valor customizado para uma coluna da grade.
72
77
 
73
78
  #### Returns
74
79
 
75
80
  Type: `Promise<void>`
76
81
 
82
+ Uma promessa que é resolvida quando o formatador é registrado.
77
83
 
84
+ ---
78
85
 
79
86
  ### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
80
87
 
81
- Registra um render customizado para colunas da grid.
88
+ Registra um renderizador customizado para uma coluna da grade.
82
89
 
83
90
  #### Returns
84
91
 
85
92
  Type: `Promise<void>`
86
93
 
94
+ Uma promessa que é resolvida quando o renderizador é registrado.
87
95
 
96
+ ---
88
97
 
89
98
  ### `getFilterBar() => Promise<HTMLSnkFilterBarElement>`
90
99
 
91
- Retorna o elemento da filter-bar da grade.
100
+ Retorna o elemento da barra de filtros da grade.
92
101
 
93
102
  #### Returns
94
103
 
95
104
  Type: `Promise<HTMLSnkFilterBarElement>`
96
105
 
106
+ O elemento da barra de filtros.
97
107
 
108
+ ---
98
109
 
99
110
  ### `hideConfig() => Promise<void>`
100
111
 
@@ -104,9 +115,11 @@ Fecha a janela de configurações da grade.
104
115
 
105
116
  Type: `Promise<void>`
106
117
 
118
+ Uma promessa que é resolvida quando a janela de configuração é fechada.
107
119
 
120
+ ---
108
121
 
109
- ### `reloadConfig() => Promise<void>`
122
+ ### `refreshColumnFilterDataSource() => Promise<void>`
110
123
 
111
124
 
112
125
 
@@ -114,37 +127,53 @@ Type: `Promise<void>`
114
127
 
115
128
  Type: `Promise<void>`
116
129
 
130
+ ---
131
+
132
+ ### `reloadConfig() => Promise<void>`
117
133
 
134
+ Recarrega a configuração da grade.
135
+
136
+ #### Returns
137
+
138
+ Type: `Promise<void>`
139
+
140
+ ---
118
141
 
119
142
  ### `reloadFilterBar() => Promise<void>`
120
143
 
121
- Faz o recarregamento da filter-bar da grade buscando o state no servidor.
144
+ Recarrega a barra de filtros da grade, buscando o estado do servidor.
122
145
 
123
146
  #### Returns
124
147
 
125
148
  Type: `Promise<void>`
126
149
 
150
+ Uma promessa que é resolvida quando a barra de filtros é recarregada.
127
151
 
152
+ ---
128
153
 
129
154
  ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
130
155
 
131
- Remove o formatador de valores de uma coluna da grid.
156
+ Remove um formatador de valor customizado de uma coluna da grade.
132
157
 
133
158
  #### Returns
134
159
 
135
160
  Type: `Promise<void>`
136
161
 
162
+ Uma promessa que é resolvida quando o formatador é removido.
137
163
 
164
+ ---
138
165
 
139
166
  ### `setConfig(config: IGridConfig) => Promise<void>`
140
167
 
141
- Atribui o valor da configuração da grade.
168
+ Define a configuração da grade.
142
169
 
143
170
  #### Returns
144
171
 
145
172
  Type: `Promise<void>`
146
173
 
174
+ Uma promessa que é resolvida quando a configuração é aplicada.
147
175
 
176
+ ---
148
177
 
149
178
  ### `setFocus() => Promise<void>`
150
179
 
@@ -154,7 +183,9 @@ Atribui o foco para a grade.
154
183
 
155
184
  Type: `Promise<void>`
156
185
 
186
+ Uma promessa que é resolvida quando o foco é atribuído.
157
187
 
188
+ ---
158
189
 
159
190
  ### `showConfig() => Promise<void>`
160
191
 
@@ -164,7 +195,7 @@ Exibe a janela de configurações da grade.
164
195
 
165
196
  Type: `Promise<void>`
166
197
 
167
-
198
+ Uma promessa que é resolvida quando a janela de configuração é exibida.
168
199
 
169
200
 
170
201
  ## Dependencies
@@ -196,6 +227,7 @@ graph TD;
196
227
  snk-grid --> taskbar-actions-button
197
228
  snk-filter-bar --> snk-filter-item
198
229
  snk-filter-bar --> snk-personalized-filter
230
+ snk-filter-bar --> snk-filter-modal
199
231
  snk-filter-item --> snk-filter-detail
200
232
  snk-personalized-filter --> snk-filter-field-search
201
233
  snk-personalized-filter --> snk-filter-assistent-mode
@@ -206,6 +238,8 @@ graph TD;
206
238
  snk-expression-group --> snk-expression-group
207
239
  snk-expression-item --> snk-filter-field-search
208
240
  snk-expression-item --> snk-filter-param-config
241
+ snk-filter-modal --> snk-filter-modal-item
242
+ snk-filter-modal --> snk-default-filter
209
243
  snk-taskbar --> snk-data-exporter
210
244
  snk-taskbar --> snk-actions-button
211
245
  snk-taskbar --> taskbar-split-button
package/components/snk-personalized-filter/readme.md CHANGED
@@ -9,28 +9,28 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ----------------- | ------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
13
- | `entityUri` | `entity-uri` | Responsável por receber a URI da entidade. | `string` | `undefined` |
14
- | `filterId` | `filter-id` | Id do filtro que será carregado. | `string` | `undefined` |
15
- | `isDefaultFilter` | `is-default-filter` | Define se o filtro em questão é um filtro padrão. | `boolean` | `false` |
12
+ | `configName` | `config-name` | Nome da configuração, utilizado para distinguir múltiplas instâncias do componente. | `string` | `undefined` |
13
+ | `entityUri` | `entity-uri` | URI da entidade utilizada para buscar os campos disponíveis para filtro. | `string` | `undefined` |
14
+ | `filterId` | `filter-id` | Identificador do filtro a ser carregado. | `string` | `undefined` |
15
+ | `isDefaultFilter` | `is-default-filter` | Indica se o filtro é o filtro padrão do sistema. | `boolean` | `false` |
16
16
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
- | `resourceID` | `resource-i-d` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
17
+ | `resourceID` | `resource-i-d` | Identificador do recurso utilizado para salvar e recuperar filtros. | `string` | `undefined` |
18
18
 
19
19
 
20
20
  ## Events
21
21
 
22
- | Event | Description | Type |
23
- | ------------- | ----------- | --------------------- |
24
- | `ezAfterSave` | | `CustomEvent<void>` |
25
- | `ezCancel` | | `CustomEvent<void>` |
26
- | `ezSave` | | `CustomEvent<string>` |
22
+ | Event | Description | Type |
23
+ | ------------- | ----------------------------------------------------------------- | --------------------- |
24
+ | `ezAfterSave` | Evento emitido após salvar as alterações do filtro personalizado. | `CustomEvent<void>` |
25
+ | `ezCancel` | Evento emitido ao cancelar a personalização do filtro. | `CustomEvent<void>` |
26
+ | `ezSave` | Evento emitido ao salvar as alterações do filtro personalizado. | `CustomEvent<string>` |
27
27
 
28
28
 
29
29
  ## Methods
30
30
 
31
31
  ### `createPersonalizedFilter() => Promise<void>`
32
32
 
33
-
33
+ Cria um novo filtro personalizado caso não exista nenhum.
34
34
 
35
35
  #### Returns
36
36
 
package/components/snk-personalized-filter/subcomponents/snk-filter-param-config/readme.md CHANGED
@@ -22,7 +22,7 @@ Fecha o modal de configuração de valor variável
22
22
 
23
23
  Type: `Promise<IExpressionItem>`
24
24
 
25
-
25
+ ---
26
26
 
27
27
  ### `open(expressionItem: IExpressionItem) => Promise<IExpressionItem>`
28
28
 
package/components/snk-pesquisa/readme.md CHANGED
@@ -7,15 +7,15 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------- | --------------------- | ------------------------------------------------------------------- | -------------------------------- | ----------- |
12
- | `allowsNonAnalytic` | `allows-non-analytic` | Define se permite seleção de items não analíticos | `boolean` | `false` |
13
- | `argument` | `argument` | Argumentos que serão usados ao chamar a função searchLoader. | `string` | `undefined` |
14
- | `entityName` | `entity-name` | Nome da entidade onde a pesquisa é aplicada. | `string` | `undefined` |
15
- | `isHierarchyEntity` | `is-hierarchy-entity` | Define se a popup de pesquisa possuirá ou não modo Hierarquico. | `boolean` | `false` |
16
- | `searchLoader` | -- | Função responsável em carregar os itens do componente snk-pesquisa. | `(text: string) => Promise<any>` | `undefined` |
17
- | `selectItem` | -- | Função disparada ao selecionar um item. | `(option: IOption) => void` | `undefined` |
18
- | `treeLoader` | -- | Função responsável por carregar a árvore hierárquica do componente | `(text: string) => Promise<any>` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ----------- |
12
+ | `allowsNonAnalytic` | `allows-non-analytic` | Define se permite a seleção de itens não analíticos. | `boolean` | `false` |
13
+ | `argument` | `argument` | Argumento utilizado ao chamar a função searchLoader. Pode ser alterado externamente. | `string` | `undefined` |
14
+ | `entityName` | `entity-name` | Nome da entidade sobre a qual a pesquisa será realizada. | `string` | `undefined` |
15
+ | `isHierarchyEntity` | `is-hierarchy-entity` | Define se a popup de pesquisa terá ou não modo hierárquico. | `boolean` | `false` |
16
+ | `searchLoader` | -- | Função responsável em carregar os itens do componente snk-pesquisa. Deve retornar uma Promise com os dados encontrados. | `(text: string) => Promise<any>` | `undefined` |
17
+ | `selectItem` | -- | Função disparada ao selecionar um item da pesquisa. | `(option: IOption) => void` | `undefined` |
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
21
  ## Dependencies
package/components/snk-simple-bar/readme.md CHANGED
@@ -9,17 +9,17 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ----------------- | --------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `breadcrumbItens` | -- | Define os itens que serão apresentados pelo breadcrumb | `IBreadcrumbItem[]` | `undefined` |
13
- | `label` | `label` | Define o título do header | `string` | `undefined` |
12
+ | `breadcrumbItens` | -- | Define os itens que serão apresentados no breadcrumb. | `IBreadcrumbItem[]` | `undefined` |
13
+ | `label` | `label` | Define o título do header. | `string` | `undefined` |
14
14
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
15
15
 
16
16
 
17
17
  ## Events
18
18
 
19
- | Event | Description | Type |
20
- | --------------------- | ------------------------------------------------- | ------------------------------ |
21
- | `clickBreadcrumbItem` | Emitido quando algum item do breadcrumb é clicado | `CustomEvent<IBreadcrumbItem>` |
22
- | `exit` | Emitido quando o botão voltar é acionado | `CustomEvent<void>` |
19
+ | Event | Description | Type |
20
+ | --------------------- | -------------------------------------------------- | ------------------------------ |
21
+ | `clickBreadcrumbItem` | Emitido quando algum item do breadcrumb é clicado. | `CustomEvent<IBreadcrumbItem>` |
22
+ | `exit` | Emitido quando o botão "voltar" é acionado. | `CustomEvent<void>` |
23
23
 
24
24
 
25
25
  ## Dependencies