@sankhyalabs/sankhyablocks-docs 9.2.0-ms.13 → 9.2.0-ms.3

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 (9) hide show
  1. package/components/snk-filter-bar/readme.md +23 -39
  2. package/components/snk-form/readme.md +7 -17
  3. package/components/snk-grid/readme.md +0 -11
  4. package/components/snk-personalized-filter/readme.md +11 -11
  5. package/components/snk-pesquisa/readme.md +9 -9
  6. package/components/snk-simple-bar/readme.md +6 -6
  7. package/components/snk-simple-crud/readme.md +48 -50
  8. package/components/snk-taskbar/readme.md +22 -22
  9. package/package.json +1 -1
package/components/snk-filter-bar/readme.md CHANGED
@@ -7,21 +7,21 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------------------ | ---------------------------------- | ----------- | ------------------------------------------------------------------------------------------ | ----------- |
12
- | `afterApplyConfig` | -- | | `() => void` | `undefined` |
13
- | `autoLoad` | `auto-load` | | `boolean` | `undefined` |
14
- | `configName` | `config-name` | | `string` | `undefined` |
15
- | `customFilterBarConfig` | -- | | `(configName: string, resourceId: string, options: any) => Promise<SnkFilterItemConfig[]>` | `undefined` |
16
- | `dataUnit` | -- | | `DataUnit` | `undefined` |
17
- | `disablePersonalizedFilter` | `disable-personalized-filter` | | `boolean` | `undefined` |
18
- | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | | `boolean` | `false` |
19
- | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | | `string` | `undefined` |
20
- | `filterConfig` | -- | | `SnkFilterItemConfig[]` | `undefined` |
21
- | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
22
- | `mode` | `mode` | | `"button" \| "hidden" \| "regular"` | `"regular"` |
23
- | `resourceID` | `resource-i-d` | | `string` | `undefined` |
24
- | `title` | `title` | | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------------------ | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
12
+ | `afterApplyConfig` | -- | Função chamada depois de aplicar os filtros. | `() => void` | `undefined` |
13
+ | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
14
+ | `configName` | `config-name` | Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma. | `string` | `undefined` |
15
+ | `customFilterBarConfig` | -- | Loader customizado para carregar as configurações | `(configName: string, resourceId: string, options: any) => Promise<SnkFilterItemConfig[]>` | `undefined` |
16
+ | `dataUnit` | -- | Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros. | `DataUnit` | `undefined` |
17
+ | `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` |
18
+ | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento | `boolean` | `false` |
19
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
20
+ | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
21
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
+ | `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
23
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
24
+ | `title` | `title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
25
25
 
26
26
 
27
27
  ## Events
@@ -35,65 +35,49 @@
35
35
 
36
36
  ### `addFilterItem(filterItem: SnkFilterItemConfig) => Promise<void>`
37
37
 
38
-
38
+ Adiciona um item de filtro.
39
39
 
40
40
  #### Returns
41
41
 
42
42
  Type: `Promise<void>`
43
43
 
44
- Retorna uma Promise que resolve quando o item for adicionado.
45
-
46
44
  ---
47
45
 
48
46
  ### `getFilterItem(id: string) => Promise<SnkFilterItemConfig | undefined>`
49
47
 
50
-
48
+ Retorna um item de filtro pelo ID.
51
49
 
52
50
  #### Returns
53
51
 
54
52
  Type: `Promise<SnkFilterItemConfig>`
55
53
 
56
- O item de filtro correspondente ou undefined se não for encontrado.
57
-
58
- ---
59
-
60
- ### `getFilters() => Promise<Filter[]>`
61
-
62
-
63
-
64
- #### Returns
65
-
66
- Type: `Promise<Filter[]>`
67
-
68
54
  ---
69
55
 
70
56
  ### `reload() => Promise<void>`
71
57
 
72
-
58
+ Faz o recarregamento da filterbar buscando o state no servidor.
73
59
 
74
60
  #### Returns
75
61
 
76
62
  Type: `Promise<void>`
77
63
 
78
- Retorna uma Promise que resolve quando o recarregamento for concluído.
79
-
80
64
  ---
81
65
 
82
66
  ### `removeFilterItem(filterID: string) => Promise<SnkFilterItemConfig | undefined>`
83
67
 
84
-
68
+ Remove um item de filtro.
85
69
 
86
70
  #### Returns
87
71
 
88
72
  Type: `Promise<SnkFilterItemConfig>`
89
73
 
90
- Retorna o item de filtro removido, ou undefined caso não seja encontrado.
74
+ - Retorna o item de filtro removido, ou undefined caso não encontrado.
91
75
 
92
76
  ---
93
77
 
94
78
  ### `showFilterModal() => Promise<void>`
95
79
 
96
-
80
+ Abre o modal de filtros
97
81
 
98
82
  #### Returns
99
83
 
@@ -103,13 +87,13 @@ Type: `Promise<void>`
103
87
 
104
88
  ### `updateFilterItem(newFilterItem: SnkFilterItemConfig) => Promise<void>`
105
89
 
106
-
90
+ Atualiza um item do filtro.
107
91
 
108
92
  #### Returns
109
93
 
110
94
  Type: `Promise<void>`
111
95
 
112
- Retorna uma Promise que resolve quando a atualização for concluída.
96
+
113
97
 
114
98
 
115
99
  ## Dependencies
package/components/snk-form/readme.md CHANGED
@@ -10,7 +10,7 @@
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ---------------------- | ------------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
12
  | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
13
- | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legada do formulário. | `string` | `undefined` |
13
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
14
14
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
15
15
  | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
16
16
  | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
@@ -18,18 +18,18 @@
18
18
 
19
19
  ## Events
20
20
 
21
- | Event | Description | Type |
22
- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
23
- | `actionClick` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente. | `CustomEvent<string>` |
24
- | `exit` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente. | `CustomEvent<void>` |
25
- | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. OBS: Emitido no subcomponente snk-form-view | `CustomEvent<HTMLElement[]>` |
21
+ | Event | Description | Type |
22
+ | ---------------- | ------------------------------------------------------------------------------- | ---------------------------- |
23
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
24
+ | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
25
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
26
26
 
27
27
 
28
28
  ## Methods
29
29
 
30
30
  ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
31
31
 
32
- Registra um editor customizado para campos do formulário.
32
+ Registra um editor customizado para campos da grade e formulário.
33
33
 
34
34
  #### Returns
35
35
 
@@ -65,16 +65,6 @@ Exibe a janela de configurações do formulário.
65
65
 
66
66
  Type: `Promise<void>`
67
67
 
68
- ---
69
-
70
- ### `validate() => Promise<void>`
71
-
72
- Valida o formulário.
73
-
74
- #### Returns
75
-
76
- Type: `Promise<void>`
77
-
78
68
 
79
69
 
80
70
 
package/components/snk-grid/readme.md CHANGED
@@ -37,7 +37,6 @@
37
37
  | `statusResolver` | -- | Define a configuração de cores para a coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` |
38
38
  | `strategyExporter` | `strategy-exporter` | Define o modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
39
39
  | `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de checkbox deve ser suprimida. | `boolean` | `undefined` |
40
- | `suppressFilterColumn` | `suppress-filter-column` | Informa se a grade deve suprimir o filtro de coluna. | `boolean` | `false` |
41
40
  | `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir a barra de rolagem horizontal. | `boolean` | `false` |
42
41
  | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do contêiner de elementos customizados da `Taskbar`. | `string` | `undefined` |
43
42
  | `taskbarManager` | -- | Gerenciador das barras de tarefas. Permite determinar botões específicos ou gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
@@ -117,16 +116,6 @@ Uma promessa que é resolvida quando a janela de configuração é fechada.
117
116
 
118
117
  ---
119
118
 
120
- ### `refreshColumnFilterDataSource() => Promise<void>`
121
-
122
-
123
-
124
- #### Returns
125
-
126
- Type: `Promise<void>`
127
-
128
- ---
129
-
130
119
  ### `reloadConfig() => Promise<void>`
131
120
 
132
121
  Recarrega a configuração da grade.
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, 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` |
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` |
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` | Identificador do recurso utilizado para salvar e recuperar filtros. | `string` | `undefined` |
17
+ | `resourceID` | `resource-i-d` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
18
18
 
19
19
 
20
20
  ## Events
21
21
 
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>` |
22
+ | Event | Description | Type |
23
+ | ------------- | ----------- | --------------------- |
24
+ | `ezAfterSave` | | `CustomEvent<void>` |
25
+ | `ezCancel` | | `CustomEvent<void>` |
26
+ | `ezSave` | | `CustomEvent<string>` |
27
27
 
28
28
 
29
29
  ## Methods
30
30
 
31
31
  ### `createPersonalizedFilter() => Promise<void>`
32
32
 
33
- Cria um novo filtro personalizado caso não exista nenhum.
33
+
34
34
 
35
35
  #### Returns
36
36
 
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 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` |
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` |
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 no breadcrumb. | `IBreadcrumbItem[]` | `undefined` |
13
- | `label` | `label` | Define o título do header. | `string` | `undefined` |
12
+ | `breadcrumbItens` | -- | Define os itens que serão apresentados pelo 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
package/components/snk-simple-crud/readme.md CHANGED
@@ -7,57 +7,57 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------------------- | ----------------------------------- | ----------- | ------------------------------------------------------- | ------------------------- |
12
- | `actionsList` | -- | | `Action[]` | `undefined` |
13
- | `autoFocus` | `auto-focus` | | `boolean` | `true` |
14
- | `autoLoad` | `auto-load` | | `boolean` | `undefined` |
15
- | `configName` | `config-name` | | `string` | `undefined` |
16
- | `dataState` | -- | | `DataState` | `undefined` |
17
- | `dataUnit` | -- | | `DataUnit` | `undefined` |
18
- | `domainMessagesBuilder` | `domain-messages-builder` | | `string` | `undefined` |
19
- | `enableContinuousInsert` | `enable-continuous-insert` | | `boolean` | `false` |
20
- | `enableGridInsert` | `enable-grid-insert` | | `boolean` | `false` |
21
- | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | | `boolean` | `false` |
22
- | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | | `boolean` | `false` |
23
- | `entityName` | `entity-name` | | `string` | `undefined` |
24
- | `formConfig` | -- | | `IFormConfig` | `undefined` |
25
- | `formLegacyConfigName` | `form-legacy-config-name` | | `string` | `undefined` |
26
- | `gridConfig` | -- | | `IGridConfig` | `undefined` |
27
- | `gridLegacyConfigName` | `grid-legacy-config-name` | | `string` | `undefined` |
28
- | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | | `boolean` | `false` |
29
- | `layoutFormConfig` | `layout-form-config` | | `boolean` | `false` |
30
- | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
31
- | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
32
- | `multipleEditionEnabled` | `multiple-edition-enabled` | | `boolean` | `true` |
33
- | `multipleSelection` | `multiple-selection` | | `boolean` | `undefined` |
34
- | `outlineMode` | `outline-mode` | | `boolean` | `false` |
35
- | `pageSize` | `page-size` | | `number` | `150` |
36
- | `paginationCounterMode` | `pagination-counter-mode` | | `"auto" \| "hidden" \| "show"` | `'auto'` |
37
- | `resourceID` | `resource-i-d` | | `string` | `undefined` |
38
- | `showConfiguratorButtons` | `show-configurator-buttons` | | `boolean` | `false` |
39
- | `taskbarManager` | -- | | `TaskbarManager` | `undefined` |
40
- | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
41
- | `useEnterLikeTab` | `use-enter-like-tab` | | `boolean` | `false` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ------------------------- |
12
+ | `actionsList` | -- | Ações a serem colocadas 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
+ | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
16
+ | `dataState` | -- | | `DataState` | `undefined` |
17
+ | `dataUnit` | -- | | `DataUnit` | `undefined` |
18
+ | `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
19
+ | `enableContinuousInsert` | `enable-continuous-insert` | | `boolean` | `false` |
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
+ | `entityName` | `entity-name` | Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD | `string` | `undefined` |
24
+ | `formConfig` | -- | | `IFormConfig` | `undefined` |
25
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
26
+ | `gridConfig` | -- | | `IGridConfig` | `undefined` |
27
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
28
+ | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `false` |
29
+ | `layoutFormConfig` | `layout-form-config` | Define se o LayoutFormConfig será exibido no configurador. | `boolean` | `false` |
30
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
31
+ | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
32
+ | `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultâneos. | `boolean` | `true` |
33
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
34
+ | `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` |
35
+ | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
36
+ | `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'auto'` |
37
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
38
+ | `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `false` |
39
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
40
+ | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
41
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
42
42
 
43
43
 
44
44
  ## Events
45
45
 
46
- | Event | Description | Type |
47
- | -------------------- | ----------- | ---------------------------- |
48
- | `actionClick` | | `CustomEvent<string>` |
49
- | `configuratorCancel` | | `CustomEvent<any>` |
50
- | `configuratorSave` | | `CustomEvent<any>` |
51
- | `dataStateChange` | | `CustomEvent<DataState>` |
52
- | `dataUnitReady` | | `CustomEvent<DataUnit>` |
53
- | `formItemsReady` | | `CustomEvent<HTMLElement[]>` |
46
+ | Event | Description | Type |
47
+ | -------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
48
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
49
+ | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
50
+ | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
51
+ | `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
52
+ | `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
53
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
54
54
 
55
55
 
56
56
  ## Methods
57
57
 
58
58
  ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
59
59
 
60
-
60
+ Registra um editor customizado para campos da grade e formulário.
61
61
 
62
62
  #### Returns
63
63
 
@@ -67,7 +67,7 @@ Type: `Promise<void>`
67
67
 
68
68
  ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
69
69
 
70
-
70
+ Registra um formatador de valores para uma coluna da grid.
71
71
 
72
72
  #### Returns
73
73
 
@@ -77,7 +77,7 @@ Type: `Promise<void>`
77
77
 
78
78
  ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
79
79
 
80
-
80
+ Registra um render customizado para colunas da grid.
81
81
 
82
82
  #### Returns
83
83
 
@@ -87,7 +87,7 @@ Type: `Promise<void>`
87
87
 
88
88
  ### `closeConfigurator() => Promise<void>`
89
89
 
90
-
90
+ Usado para fechar o configurator do CRUD
91
91
 
92
92
  #### Returns
93
93
 
@@ -103,13 +103,11 @@ Type: `Promise<void>`
103
103
 
104
104
  Type: `Promise<Record[]>`
105
105
 
106
- Uma promessa que resolve com a lista de registros.
107
-
108
106
  ---
109
107
 
110
108
  ### `goToView(view: VIEW_MODE) => Promise<void>`
111
109
 
112
-
110
+ Usado para alternar a visão entre GRID e FORM externamente.
113
111
 
114
112
  #### Returns
115
113
 
@@ -119,7 +117,7 @@ Type: `Promise<void>`
119
117
 
120
118
  ### `openConfigurator() => Promise<void>`
121
119
 
122
-
120
+ Usado para abrir o configurator do CRUD
123
121
 
124
122
  #### Returns
125
123
 
@@ -129,7 +127,7 @@ Type: `Promise<void>`
129
127
 
130
128
  ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
131
129
 
132
-
130
+ Remove o formatador de valores de uma coluna da grid.
133
131
 
134
132
  #### Returns
135
133
 
@@ -139,7 +137,7 @@ Type: `Promise<void>`
139
137
 
140
138
  ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
141
139
 
142
-
140
+ Altera/adiciona uma propriedade nos metadados do campo.
143
141
 
144
142
  #### Returns
145
143
 
package/components/snk-taskbar/readme.md CHANGED
@@ -7,32 +7,32 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | --------------------- | --------------------- | ----------- | ------------------------------------------------------------------------------------------- | --------------------------- |
12
- | `actionsList` | -- | | `Action[]` | `undefined` |
13
- | `actionsSettingsList` | -- | | `Action[]` | `undefined` |
14
- | `alignRigth` | `align-rigth` | | `boolean` | `false` |
15
- | `buttons` | `buttons` | | `string` | `undefined` |
16
- | `configName` | `config-name` | | `string` | `undefined` |
17
- | `customButtons` | -- | | `Map<string, CustomButton>` | `undefined` |
18
- | `customContainerId` | `custom-container-id` | | `string` | `undefined` |
19
- | `customSlotId` | `custom-slot-id` | | `string` | `"TASKBAR_CUSTOM_ELEMENTS"` |
20
- | `dataUnit` | -- | | `DataUnit` | `undefined` |
21
- | `disabledButtons` | -- | | `string[]` | `undefined` |
22
- | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
23
- | `overflowStrategy` | `overflow-strategy` | | `"hiddenItems" \| "none"` | `'hiddenItems'` |
24
- | `presentationMode` | `presentation-mode` | | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
25
- | `primaryButton` | `primary-button` | | `string` | `undefined` |
26
- | `resourceID` | `resource-i-d` | | `string` | `undefined` |
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
+ | `actionsSettingsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
14
+ | `alignRigth` | `align-rigth` | Usado para determinar O alinhamento dos items na taskbar. | `boolean` | `false` |
15
+ | `buttons` | `buttons` | Lista separada por virgula, contendo todos os elementos a serem criados. | `string` | `undefined` |
16
+ | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
17
+ | `customButtons` | -- | 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. | `Map<string, CustomButton>` | `undefined` |
18
+ | `customContainerId` | `custom-container-id` | 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. | `string` | `undefined` |
19
+ | `customSlotId` | `custom-slot-id` | Usado para determinar o identificador do slot que recebe elementos personalizados. | `string` | `"TASKBAR_CUSTOM_ELEMENTS"` |
20
+ | `dataUnit` | -- | Instância do DataUnit. | `DataUnit` | `undefined` |
21
+ | `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados. | `string[]` | `undefined` |
22
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
23
+ | `overflowStrategy` | `overflow-strategy` | Define como será o comportamento da taskbar quando ocorrer overflow | `"hiddenItems" \| "none"` | `'hiddenItems'` |
24
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
25
+ | `primaryButton` | `primary-button` | Determina qual botão deve ter aparência primária. | `string` | `undefined` |
26
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
27
27
 
28
28
 
29
29
  ## Events
30
30
 
31
- | Event | Description | Type |
32
- | --------------------- | ----------- | --------------------- |
33
- | `actionClick` | | `CustomEvent<string>` |
34
- | `taskbarSaveLocker` | | `CustomEvent<void>` |
35
- | `taskbarSaveUnlocker` | | `CustomEvent<void>` |
31
+ | Event | Description | Type |
32
+ | --------------------- | ------------------------------------------------------------ | --------------------- |
33
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
34
+ | `taskbarSaveLocker` | Emitido sempre que um save é iniciado pela taskbar. | `CustomEvent<void>` |
35
+ | `taskbarSaveUnlocker` | Emitido sempre que o ocorre alguma action que libera o save. | `CustomEvent<void>` |
36
36
 
37
37
 
38
38
  ## Dependencies
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "9.2.0-ms.13",
3
+ "version": "9.2.0-ms.3",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [