@sankhyalabs/sankhyablocks-docs 8.15.0-dev.3 → 8.15.0-dev.31

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.
@@ -439,6 +439,16 @@ Type: `Promise<any>`
439
439
 
440
440
 
441
441
 
442
+ ### `setSearchFilterContext(name: string, value: string) => Promise<void>`
443
+
444
+ Atribui valor para parâmetros de contexto no componente de pesquisa.
445
+
446
+ #### Returns
447
+
448
+ Type: `Promise<void>`
449
+
450
+
451
+
442
452
  ### `showAlerts(alerts: Array<AlertItem>) => Promise<void>`
443
453
 
444
454
  Apresenta uma lista de alertas,
@@ -7,11 +7,15 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------------------------- | -------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `entityName` _(required)_ | `entity-name` | Nome da entidade à ser utilizada para relacionar o anexo ao DataUnit pai. | `string` | `undefined` |
13
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
14
- | `registerKey` _(required)_ | `register-key` | Identificação do registro pai. | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------------------- | -------------- | -------------------------------------------------------------------------------------- | ----------------------------------------- | ---------------- |
12
+ | `dataUnit` | -- | DataUnit responsável por carregar os dados. | `DataUnit` | `undefined` |
13
+ | `dataUnitBuilder` | -- | DataUnitBuilder responsável por implementar dados a serem utilizados no DataUnit. | `FetcherFacade` | `undefined` |
14
+ | `entityName` | `entity-name` | Nome da entidade à ser utilizada para relacionar o anexo ao DataUnit pai. | `string` | `undefined` |
15
+ | `fetcher` | -- | Fetcher responsável por carregar os dados do DataUnit. | `AttachFetcherFacadeInterface` | `undefined` |
16
+ | `fetcherType` | `fetcher-type` | FetcherType define o tipo de fetcher responsável por carregar os dados do DataUnit. | `"AnexoSistema" \| "Another" \| "Attach"` | `"AnexoSistema"` |
17
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
18
+ | `registerKey` _(required)_ | `register-key` | Identificação do registro pai. | `string` | `undefined` |
15
19
 
16
20
 
17
21
  ## Events
@@ -40,6 +44,9 @@ graph TD;
40
44
  snk-attach --> snk-simple-crud
41
45
  snk-simple-crud --> snk-data-unit
42
46
  snk-simple-crud --> snk-taskbar
47
+ snk-simple-crud --> snk-form-config
48
+ snk-simple-crud --> snk-configurator
49
+ snk-simple-crud --> snk-grid-config
43
50
  snk-simple-crud --> snk-data-exporter
44
51
  snk-simple-crud --> snk-actions-button
45
52
  snk-simple-crud --> taskbar-actions-button
@@ -47,6 +54,10 @@ graph TD;
47
54
  snk-taskbar --> snk-actions-button
48
55
  snk-taskbar --> taskbar-actions-button
49
56
  snk-data-exporter --> snk-exporter-email-sender
57
+ snk-form-config --> snk-field-config
58
+ snk-form-config --> snk-config-options
59
+ snk-form-config --> snk-tab-config
60
+ snk-grid-config --> snk-select-box
50
61
  snk-crud --> snk-attach
51
62
  snk-detail-view --> snk-attach
52
63
  style snk-attach fill:#f9f,stroke:#333,stroke-width:4px
@@ -56,12 +56,14 @@ Type: `Promise<void>`
56
56
 
57
57
  - [snk-crud](../snk-crud)
58
58
  - [snk-guides-viewer](../snk-crud/subcomponents)
59
+ - [snk-simple-crud](../snk-simple-crud)
59
60
 
60
61
  ### Graph
61
62
  ```mermaid
62
63
  graph TD;
63
64
  snk-crud --> snk-configurator
64
65
  snk-guides-viewer --> snk-configurator
66
+ snk-simple-crud --> snk-configurator
65
67
  style snk-configurator fill:#f9f,stroke:#333,stroke-width:4px
66
68
  ```
67
69
 
@@ -7,19 +7,21 @@
7
7
 
8
8
  ## Properties
9
9
 
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
- | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
14
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
15
- | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
16
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `PresentationMode.PRIMARY` |
17
- | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
18
- | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
19
- | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
20
- | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
21
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
22
- | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `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
+ | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
14
+ | `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` |
15
+ | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
16
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
18
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
19
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
20
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
21
+ | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
22
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
23
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
24
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
23
25
 
24
26
 
25
27
  ## Events
@@ -152,6 +154,9 @@ graph TD;
152
154
  snk-attach --> snk-simple-crud
153
155
  snk-simple-crud --> snk-data-unit
154
156
  snk-simple-crud --> snk-taskbar
157
+ snk-simple-crud --> snk-form-config
158
+ snk-simple-crud --> snk-configurator
159
+ snk-simple-crud --> snk-grid-config
155
160
  snk-simple-crud --> snk-data-exporter
156
161
  snk-simple-crud --> snk-actions-button
157
162
  snk-simple-crud --> taskbar-actions-button
@@ -7,22 +7,22 @@
7
7
 
8
8
  ## Properties
9
9
 
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
- | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
- | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
15
- | `dataState` | -- | Representa o estado do dataUnit master. | `DataState` | `undefined` |
16
- | `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
17
- | `detailTaskbarCustomContainerId` | `detail-taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. | `string` | `undefined` |
18
- | `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
19
- | `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
20
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
21
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `undefined` |
22
- | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
23
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
24
- | `selectedGuide` | -- | Guia selecionada. | `IGuideItem` | `undefined` |
25
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
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
+ | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
+ | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
15
+ | `dataState` | -- | Representa o estado do dataUnit master. | `DataState` | `undefined` |
16
+ | `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
17
+ | `detailTaskbarCustomContainerId` | `detail-taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. | `string` | `undefined` |
18
+ | `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
19
+ | `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
20
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
21
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `undefined` |
22
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
23
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
24
+ | `selectedGuide` | -- | Guia selecionada. | `IGuideItem` | `undefined` |
25
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
26
26
 
27
27
 
28
28
  ## Events
@@ -69,7 +69,7 @@ Type: `Promise<void>`
69
69
  - [snk-data-unit](../../snk-data-unit)
70
70
  - [snk-detail-view](snk-detail-view)
71
71
  - [snk-taskbar](../../snk-taskbar)
72
- - [snk-form-config](../../snk-form/subcomponents/snk-form-config)
72
+ - [snk-form-config](../../snk-form-config)
73
73
  - [snk-configurator](../../snk-configurator)
74
74
  - [snk-data-exporter](../../snk-data-exporter)
75
75
  - [snk-actions-button](../../snk-actions-button)
@@ -123,6 +123,9 @@ graph TD;
123
123
  snk-attach --> snk-simple-crud
124
124
  snk-simple-crud --> snk-data-unit
125
125
  snk-simple-crud --> snk-taskbar
126
+ snk-simple-crud --> snk-form-config
127
+ snk-simple-crud --> snk-configurator
128
+ snk-simple-crud --> snk-grid-config
126
129
  snk-simple-crud --> snk-data-exporter
127
130
  snk-simple-crud --> snk-actions-button
128
131
  snk-simple-crud --> taskbar-actions-button
@@ -122,9 +122,15 @@ graph TD;
122
122
  snk-attach --> snk-simple-crud
123
123
  snk-simple-crud --> snk-data-unit
124
124
  snk-simple-crud --> snk-taskbar
125
+ snk-simple-crud --> snk-form-config
126
+ snk-simple-crud --> snk-configurator
127
+ snk-simple-crud --> snk-grid-config
125
128
  snk-simple-crud --> snk-data-exporter
126
129
  snk-simple-crud --> snk-actions-button
127
130
  snk-simple-crud --> taskbar-actions-button
131
+ snk-form-config --> snk-field-config
132
+ snk-form-config --> snk-config-options
133
+ snk-form-config --> snk-tab-config
128
134
  snk-guides-viewer --> snk-detail-view
129
135
  style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
130
136
  ```
@@ -7,15 +7,18 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------------ | ------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------ | ----------- |
12
- | `addPersonalizedFilter` | -- | Ação executada ao adicionar um filtro personalizado | `() => void` | `undefined` |
13
- | `applyFilters` | -- | Ação executada ao aplicar os filtros | `(updatedFilterConfig: SnkFilterItemConfig[]) => void` | `undefined` |
14
- | `closeModal` | -- | Ação disparada ao fechar o modal | `() => void` | `undefined` |
15
- | `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
16
- | `editPersonalizedFilter` | -- | Ação executada ao editart um filtro personalizado | `(id: string) => void` | `undefined` |
17
- | `filters` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
18
- | `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- | ----------- |
12
+ | `addPersonalizedFilter` | -- | Ação executada ao adicionar um filtro personalizado | `() => void` | `undefined` |
13
+ | `applyFilters` | -- | Ação executada ao aplicar os filtros | `(updatedFilterConfig: SnkFilterItemConfig[]) => void` | `undefined` |
14
+ | `closeModal` | -- | Ação disparada ao fechar o modal | `() => void` | `undefined` |
15
+ | `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
16
+ | `deletePersonalizedFilter` | -- | Ação executada ao deletar um filtro personalizado | `(filter: IPersonalizedFilter, configName: string) => void` | `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
+ | `editPersonalizedFilter` | -- | Ação executada ao editar um filtro personalizado | `(id: string) => void` | `undefined` |
19
+ | `filters` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
20
+ | `filtersToDelete` | -- | Guarda filtros a serem deletados no Apply do modal | `IPersonalizedFilter[]` | `[]` |
21
+ | `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
19
22
 
20
23
 
21
24
  ## Dependencies
@@ -7,13 +7,16 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ----------- |
12
- | `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` |
13
- | `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` |
14
- | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
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` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ----------- |
12
+ | `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` |
13
+ | `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` |
14
+ | `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` |
15
+ | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
16
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
+ | `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
18
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
19
+ | `title` | `title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
17
20
 
18
21
 
19
22
  ## Events
@@ -55,6 +58,26 @@ Type: `Promise<void>`
55
58
 
56
59
 
57
60
 
61
+ ### `removeFilterItem(filterID: string) => Promise<SnkFilterItemConfig | undefined>`
62
+
63
+ Remove um item de filtro.
64
+
65
+ #### Returns
66
+
67
+ Type: `Promise<SnkFilterItemConfig>`
68
+
69
+ - Retorna o item de filtro removido, ou undefined caso não encontrado.
70
+
71
+ ### `showFilterModal() => Promise<void>`
72
+
73
+ Abre o modal de filtros
74
+
75
+ #### Returns
76
+
77
+ Type: `Promise<void>`
78
+
79
+
80
+
58
81
  ### `updateFilterItem(newFilterItem: SnkFilterItemConfig) => Promise<void>`
59
82
 
60
83
  Atualiza um item do filtro.
@@ -51,7 +51,7 @@ Type: `Promise<void>`
51
51
 
52
52
  ### Depends on
53
53
 
54
- - [snk-form-config](./subcomponents/snk-form-config)
54
+ - [snk-form-config](../snk-form-config)
55
55
 
56
56
  ### Graph
57
57
  ```mermaid
@@ -26,14 +26,15 @@
26
26
 
27
27
  ### Used by
28
28
 
29
- - [snk-form](../..)
30
- - [snk-guides-viewer](../../../snk-crud/subcomponents)
29
+ - [snk-form](../snk-form)
30
+ - [snk-guides-viewer](../snk-crud/subcomponents)
31
+ - [snk-simple-crud](../snk-simple-crud)
31
32
 
32
33
  ### Depends on
33
34
 
34
- - [snk-field-config](../snk-field-config)
35
- - [snk-config-options](../snk-config-options)
36
- - [snk-tab-config](../snk-tab-config)
35
+ - [snk-field-config](./subcomponents/snk-field-config)
36
+ - [snk-config-options](./subcomponents/snk-config-options)
37
+ - [snk-tab-config](./subcomponents/snk-tab-config)
37
38
 
38
39
  ### Graph
39
40
  ```mermaid
@@ -43,6 +44,7 @@ graph TD;
43
44
  snk-form-config --> snk-tab-config
44
45
  snk-form --> snk-form-config
45
46
  snk-guides-viewer --> snk-form-config
47
+ snk-simple-crud --> snk-form-config
46
48
  style snk-form-config fill:#f9f,stroke:#333,stroke-width:4px
47
49
  ```
48
50
 
@@ -26,7 +26,7 @@
26
26
 
27
27
  ### Used by
28
28
 
29
- - [snk-form-config](../snk-form-config)
29
+ - [snk-form-config](../..)
30
30
 
31
31
  ### Graph
32
32
  ```mermaid
@@ -27,7 +27,7 @@
27
27
 
28
28
  ### Used by
29
29
 
30
- - [snk-form-config](../snk-form-config)
30
+ - [snk-form-config](../..)
31
31
 
32
32
  ### Graph
33
33
  ```mermaid
@@ -32,7 +32,7 @@
32
32
 
33
33
  ### Used by
34
34
 
35
- - [snk-form-config](../snk-form-config)
35
+ - [snk-form-config](../..)
36
36
 
37
37
  ### Graph
38
38
  ```mermaid
@@ -7,25 +7,27 @@
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
- | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
- | `columnFilterDataSource` | -- | | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
15
- | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
16
- | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
17
- | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
18
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
19
- | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
20
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `PresentationMode.PRIMARY` |
21
- | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
22
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
23
- | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
24
- | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
25
- | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
26
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
27
- | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
28
- | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
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
+ | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
+ | `columnFilterDataSource` | -- | | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
15
+ | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
16
+ | `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
+ | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
18
+ | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
19
+ | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
20
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
21
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
22
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
23
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
24
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
25
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
26
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
27
+ | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
28
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
29
+ | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
30
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
29
31
 
30
32
 
31
33
  ## Events
@@ -110,7 +112,7 @@ Type: `Promise<void>`
110
112
 
111
113
  - [snk-filter-bar](../snk-filter-bar)
112
114
  - [snk-taskbar](../snk-taskbar)
113
- - [snk-grid-config](./subcomponents/snk-grid-config)
115
+ - [snk-grid-config](../snk-grid-config)
114
116
  - [snk-data-exporter](../snk-data-exporter)
115
117
  - [snk-actions-button](../snk-actions-button)
116
118
  - [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
@@ -9,7 +9,6 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | --------------- | ---------------- | ------------------------------------------------ | ---------------- | ----------- |
12
- | `application` | -- | Referência para o SnkApplication | `SnkApplication` | `undefined` |
13
12
  | `columns` | -- | Colunas da grade. | `EzGridColumn[]` | `undefined` |
14
13
  | `config` | -- | Configurações da grade. | `IGridConfig` | `undefined` |
15
14
  | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
@@ -29,17 +28,19 @@
29
28
 
30
29
  ### Used by
31
30
 
32
- - [snk-grid](../..)
31
+ - [snk-grid](../snk-grid)
32
+ - [snk-simple-crud](../snk-simple-crud)
33
33
 
34
34
  ### Depends on
35
35
 
36
- - [snk-select-box](../snk-select-box)
36
+ - [snk-select-box](snk-select-box)
37
37
 
38
38
  ### Graph
39
39
  ```mermaid
40
40
  graph TD;
41
41
  snk-grid-config --> snk-select-box
42
42
  snk-grid --> snk-grid-config
43
+ snk-simple-crud --> snk-grid-config
43
44
  style snk-grid-config fill:#f9f,stroke:#333,stroke-width:4px
44
45
  ```
45
46
 
@@ -23,7 +23,7 @@
23
23
 
24
24
  ### Used by
25
25
 
26
- - [snk-grid-config](../snk-grid-config)
26
+ - [snk-grid-config](..)
27
27
 
28
28
  ### Graph
29
29
  ```mermaid
@@ -7,32 +7,47 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ------------------------- |
12
- | `dataState` | -- | | `DataState` | `undefined` |
13
- | `dataUnit` | -- | | `DataUnit` | `undefined` |
14
- | `formConfig` | -- | | `IFormConfig` | `undefined` |
15
- | `gridConfig` | -- | | `IGridConfig` | `undefined` |
16
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
- | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
18
- | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
19
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
20
- | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
21
- | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `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
+ | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
14
+ | `dataState` | -- | | `DataState` | `undefined` |
15
+ | `dataUnit` | -- | | `DataUnit` | `undefined` |
16
+ | `formConfig` | -- | | `IFormConfig` | `undefined` |
17
+ | `gridConfig` | -- | | `IGridConfig` | `undefined` |
18
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
19
+ | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
20
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
21
+ | `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `undefined` |
22
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
23
+ | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
24
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
22
25
 
23
26
 
24
27
  ## Events
25
28
 
26
- | Event | Description | Type |
27
- | ----------------- | ------------------------------------------------------------------------------- | ---------------------------- |
28
- | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
29
- | `dataStateChange` | Emitido quando qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
30
- | `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
31
- | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
29
+ | Event | Description | Type |
30
+ | -------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
31
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
32
+ | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
33
+ | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
34
+ | `dataStateChange` | Emitido quando qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
35
+ | `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
36
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
32
37
 
33
38
 
34
39
  ## Methods
35
40
 
41
+ ### `closeConfigurator() => Promise<void>`
42
+
43
+ Usado para fechar o configurator do CRUD
44
+
45
+ #### Returns
46
+
47
+ Type: `Promise<void>`
48
+
49
+
50
+
36
51
  ### `getRecords() => Promise<Array<Record>>`
37
52
 
38
53
 
@@ -53,6 +68,16 @@ Type: `Promise<void>`
53
68
 
54
69
 
55
70
 
71
+ ### `openConfigurator() => Promise<void>`
72
+
73
+ Usado para abrir o configurator do CRUD
74
+
75
+ #### Returns
76
+
77
+ Type: `Promise<void>`
78
+
79
+
80
+
56
81
  ### `setMetadata(metadata: UnitMetadata) => Promise<void>`
57
82
 
58
83
 
@@ -84,6 +109,9 @@ Type: `Promise<void>`
84
109
 
85
110
  - [snk-data-unit](../snk-data-unit)
86
111
  - [snk-taskbar](../snk-taskbar)
112
+ - [snk-form-config](../snk-form-config)
113
+ - [snk-configurator](../snk-configurator)
114
+ - [snk-grid-config](../snk-grid-config)
87
115
  - [snk-data-exporter](../snk-data-exporter)
88
116
  - [snk-actions-button](../snk-actions-button)
89
117
  - [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
@@ -93,6 +121,9 @@ Type: `Promise<void>`
93
121
  graph TD;
94
122
  snk-simple-crud --> snk-data-unit
95
123
  snk-simple-crud --> snk-taskbar
124
+ snk-simple-crud --> snk-form-config
125
+ snk-simple-crud --> snk-configurator
126
+ snk-simple-crud --> snk-grid-config
96
127
  snk-simple-crud --> snk-data-exporter
97
128
  snk-simple-crud --> snk-actions-button
98
129
  snk-simple-crud --> taskbar-actions-button
@@ -100,6 +131,10 @@ graph TD;
100
131
  snk-taskbar --> snk-actions-button
101
132
  snk-taskbar --> taskbar-actions-button
102
133
  snk-data-exporter --> snk-exporter-email-sender
134
+ snk-form-config --> snk-field-config
135
+ snk-form-config --> snk-config-options
136
+ snk-form-config --> snk-tab-config
137
+ snk-grid-config --> snk-select-box
103
138
  snk-attach --> snk-simple-crud
104
139
  style snk-simple-crud fill:#f9f,stroke:#333,stroke-width:4px
105
140
  ```
@@ -7,20 +7,22 @@
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
- | `buttons` | `buttons` | Lista separada por virgula, contendo todos os elementos a serem criados. | `string` | `undefined` |
14
- | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
15
- | `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` |
16
- | `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` |
17
- | `customSlotId` | `custom-slot-id` | Usado para determinar o identificador do slot que recebe elementos personalizados. | `string` | `"TASKBAR_CUSTOM_ELEMENTS"` |
18
- | `dataUnit` | -- | Instância do DataUnit. | `DataUnit` | `undefined` |
19
- | `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados. | `string[]` | `undefined` |
20
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
21
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `PresentationMode.PRIMARY` |
22
- | `primaryButton` | `primary-button` | Determina qual botão deve ter aparência primária. | `string` | `undefined` |
23
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `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
+ | `alignRigth` | `align-rigth` | Usado para determinar O alinhamento dos items na taskbar. | `boolean` | `false` |
14
+ | `buttons` | `buttons` | Lista separada por virgula, contendo todos os elementos a serem criados. | `string` | `undefined` |
15
+ | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
16
+ | `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` |
17
+ | `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` |
18
+ | `customSlotId` | `custom-slot-id` | Usado para determinar o identificador do slot que recebe elementos personalizados. | `string` | `"TASKBAR_CUSTOM_ELEMENTS"` |
19
+ | `dataUnit` | -- | Instância do DataUnit. | `DataUnit` | `undefined` |
20
+ | `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados. | `string[]` | `undefined` |
21
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
+ | `overflowStrategy` | `overflow-strategy` | Define como será o comportamento da taskbar quando ocorrer overflow | `"hiddenItems" \| "none"` | `'hiddenItems'` |
23
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
24
+ | `primaryButton` | `primary-button` | Determina qual botão deve ter aparência primária. | `string` | `undefined` |
25
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
24
26
 
25
27
 
26
28
  ## Events
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "8.15.0-dev.3",
3
+ "version": "8.15.0-dev.31",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [