@sankhyalabs/sankhyablocks-docs 8.15.0-rc.8 → 8.15.0

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 (19) hide show
  1. package/components/snk-application/readme.md +7 -5
  2. package/components/snk-attach/readme.md +16 -9
  3. package/components/snk-configurator/readme.md +2 -0
  4. package/components/snk-crud/readme.md +21 -15
  5. package/components/snk-crud/subcomponents/readme.md +15 -1
  6. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +6 -0
  7. package/components/snk-custom-slot-elements/readme.md +7 -0
  8. package/components/snk-filter-bar/filter-item/readme.md +5 -4
  9. package/components/snk-filter-bar/readme.md +11 -10
  10. package/components/snk-form/readme.md +8 -7
  11. package/components/{snk-form/subcomponents/snk-form-config → snk-form-config}/readme.md +7 -5
  12. package/components/{snk-form → snk-form-config}/subcomponents/snk-config-options/readme.md +1 -1
  13. package/components/{snk-form → snk-form-config}/subcomponents/snk-field-config/readme.md +1 -1
  14. package/components/{snk-form → snk-form-config}/subcomponents/snk-tab-config/readme.md +1 -1
  15. package/components/snk-grid/readme.md +34 -22
  16. package/components/{snk-grid/subcomponents/snk-grid-config → snk-grid-config}/readme.md +4 -3
  17. package/components/{snk-grid/subcomponents → snk-grid-config}/snk-select-box/readme.md +1 -1
  18. package/components/snk-simple-crud/readme.md +67 -20
  19. package/package.json +1 -1
package/components/snk-application/readme.md CHANGED
@@ -7,11 +7,13 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- |
12
- | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
13
- | `loadByPK` | -- | Usado para receber um parâmetro na inicialização da tela, e utilizá-lo conforme necessário caso a tela receba um parâmetro, e, esta propriedade não seja informada é criado um filtro de forma automática através do método defaultLoadByPk | `(objPK: { pk: Record<string, any>; }) => void` | `undefined` |
14
- | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- |
12
+ | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
13
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
14
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
15
+ | `loadByPK` | -- | Usado para receber um parâmetro na inicialização da tela, e utilizá-lo conforme necessário caso a tela receba um parâmetro, e, esta propriedade não seja informada é criado um filtro de forma automática através do método defaultLoadByPk | `(objPK: { pk: Record<string, any>; }) => void` | `undefined` |
16
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
15
17
 
16
18
 
17
19
  ## Events
package/components/snk-attach/readme.md CHANGED
@@ -7,15 +7,15 @@
7
7
 
8
8
  ## Properties
9
9
 
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` |
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"` | `undefined` |
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` |
19
19
 
20
20
 
21
21
  ## Events
@@ -44,6 +44,9 @@ graph TD;
44
44
  snk-attach --> snk-simple-crud
45
45
  snk-simple-crud --> snk-data-unit
46
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
47
50
  snk-simple-crud --> snk-data-exporter
48
51
  snk-simple-crud --> snk-actions-button
49
52
  snk-simple-crud --> taskbar-actions-button
@@ -51,6 +54,10 @@ graph TD;
51
54
  snk-taskbar --> snk-actions-button
52
55
  snk-taskbar --> taskbar-actions-button
53
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
54
61
  snk-crud --> snk-attach
55
62
  snk-detail-view --> snk-attach
56
63
  style snk-attach fill:#f9f,stroke:#333,stroke-width:4px
package/components/snk-configurator/readme.md CHANGED
@@ -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
 
package/components/snk-crud/readme.md CHANGED
@@ -7,21 +7,24 @@
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
- | `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` |
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
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
16
+ | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
17
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
18
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
19
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
20
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
21
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
22
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
23
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
24
+ | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
25
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `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
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
25
28
 
26
29
 
27
30
  ## Events
@@ -154,6 +157,9 @@ graph TD;
154
157
  snk-attach --> snk-simple-crud
155
158
  snk-simple-crud --> snk-data-unit
156
159
  snk-simple-crud --> snk-taskbar
160
+ snk-simple-crud --> snk-form-config
161
+ snk-simple-crud --> snk-configurator
162
+ snk-simple-crud --> snk-grid-config
157
163
  snk-simple-crud --> snk-data-exporter
158
164
  snk-simple-crud --> snk-actions-button
159
165
  snk-simple-crud --> taskbar-actions-button
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -16,6 +16,7 @@
16
16
  | `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
17
17
  | `detailTaskbarCustomContainerId` | `detail-taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. | `string` | `undefined` |
18
18
  | `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
19
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
19
20
  | `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
20
21
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
21
22
  | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `undefined` |
@@ -46,6 +47,16 @@ Type: `Promise<void>`
46
47
 
47
48
 
48
49
 
50
+ ### `setFocus() => Promise<void>`
51
+
52
+ Atribui o foco para o componente.
53
+
54
+ #### Returns
55
+
56
+ Type: `Promise<void>`
57
+
58
+
59
+
49
60
  ### `showFormConfig(detail?: boolean) => Promise<void>`
50
61
 
51
62
  Abre o configurador do formulário
@@ -69,7 +80,7 @@ Type: `Promise<void>`
69
80
  - [snk-data-unit](../../snk-data-unit)
70
81
  - [snk-detail-view](snk-detail-view)
71
82
  - [snk-taskbar](../../snk-taskbar)
72
- - [snk-form-config](../../snk-form/subcomponents/snk-form-config)
83
+ - [snk-form-config](../../snk-form-config)
73
84
  - [snk-configurator](../../snk-configurator)
74
85
  - [snk-data-exporter](../../snk-data-exporter)
75
86
  - [snk-actions-button](../../snk-actions-button)
@@ -123,6 +134,9 @@ graph TD;
123
134
  snk-attach --> snk-simple-crud
124
135
  snk-simple-crud --> snk-data-unit
125
136
  snk-simple-crud --> snk-taskbar
137
+ snk-simple-crud --> snk-form-config
138
+ snk-simple-crud --> snk-configurator
139
+ snk-simple-crud --> snk-grid-config
126
140
  snk-simple-crud --> snk-data-exporter
127
141
  snk-simple-crud --> snk-actions-button
128
142
  snk-simple-crud --> taskbar-actions-button
package/components/snk-crud/subcomponents/snk-detail-view/readme.md CHANGED
@@ -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
  ```
package/components/snk-custom-slot-elements/readme.md CHANGED
@@ -12,6 +12,13 @@
12
12
  | `slotName` | `slot-name` | Nome do slot onde os elementos customizados deverão aparecer. | `string` | `'CUSTOM_SLOT_ELEMENTS'` |
13
13
 
14
14
 
15
+ ## Events
16
+
17
+ | Event | Description | Type |
18
+ | ----------------------------- | -------------------------------------------- | --------------------- |
19
+ | `snkCustomSlotElementsLoaded` | Emitido quando elemento é carregado na tela. | `CustomEvent<string>` |
20
+
21
+
15
22
  ----------------------------------------------
16
23
 
17
24
 
package/components/snk-filter-bar/filter-item/readme.md CHANGED
@@ -7,10 +7,11 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------ | --------- | --------------------------------------------------------------------------------- | -------------------------------------- | ----------- |
12
- | `config` | -- | Define as configurações do componente snk-filter-item. | `SnkFilterItemConfig` | `undefined` |
13
- | `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
+ | `config` | -- | Define as configurações do componente snk-filter-item. | `SnkFilterItemConfig` | `undefined` |
13
+ | `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
14
+ | `showChips` | `show-chips` | Usado para controlar a visibilidade dos chips de filtros | `boolean` | `true` |
14
15
 
15
16
 
16
17
  ## Events
package/components/snk-filter-bar/readme.md CHANGED
@@ -7,16 +7,17 @@
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
- | `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` |
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
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
16
+ | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
17
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
18
+ | `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
19
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
20
+ | `title` | `title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
20
21
 
21
22
 
22
23
  ## Events
package/components/snk-form/readme.md CHANGED
@@ -7,12 +7,13 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------ | -------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
13
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
14
- | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
15
- | `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` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
13
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
14
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
15
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
16
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
16
17
 
17
18
 
18
19
  ## Events
@@ -51,7 +52,7 @@ Type: `Promise<void>`
51
52
 
52
53
  ### Depends on
53
54
 
54
- - [snk-form-config](./subcomponents/snk-form-config)
55
+ - [snk-form-config](../snk-form-config)
55
56
 
56
57
  ### Graph
57
58
  ```mermaid
package/components/{snk-form/subcomponents/snk-form-config → snk-form-config}/readme.md RENAMED
@@ -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
 
package/components/{snk-form → snk-form-config}/subcomponents/snk-config-options/readme.md RENAMED
@@ -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
package/components/{snk-form → snk-form-config}/subcomponents/snk-field-config/readme.md RENAMED
@@ -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
package/components/{snk-form → snk-form-config}/subcomponents/snk-tab-config/readme.md RENAMED
@@ -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
package/components/snk-grid/readme.md CHANGED
@@ -7,27 +7,29 @@
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
- | `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` |
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
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
18
+ | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
19
+ | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
20
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
21
+ | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
22
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
23
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
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
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
26
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
27
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
28
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
29
+ | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
30
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
31
+ | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
32
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
31
33
 
32
34
 
33
35
  ## Events
@@ -90,6 +92,16 @@ Type: `Promise<void>`
90
92
 
91
93
 
92
94
 
95
+ ### `setFocus() => Promise<void>`
96
+
97
+ Atribui o foco para a grade.
98
+
99
+ #### Returns
100
+
101
+ Type: `Promise<void>`
102
+
103
+
104
+
93
105
  ### `showConfig() => Promise<void>`
94
106
 
95
107
  Exibe a janela de configurações da grade.
@@ -112,7 +124,7 @@ Type: `Promise<void>`
112
124
 
113
125
  - [snk-filter-bar](../snk-filter-bar)
114
126
  - [snk-taskbar](../snk-taskbar)
115
- - [snk-grid-config](./subcomponents/snk-grid-config)
127
+ - [snk-grid-config](../snk-grid-config)
116
128
  - [snk-data-exporter](../snk-data-exporter)
117
129
  - [snk-actions-button](../snk-actions-button)
118
130
  - [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
package/components/{snk-grid/subcomponents/snk-grid-config → snk-grid-config}/readme.md RENAMED
@@ -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
 
package/components/{snk-grid/subcomponents → snk-grid-config}/snk-select-box/readme.md RENAMED
@@ -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
package/components/snk-simple-crud/readme.md CHANGED
@@ -7,34 +7,51 @@
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
- | `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
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
22
- | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
23
- | `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
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
18
+ | `gridConfig` | -- | | `IGridConfig` | `undefined` |
19
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
20
+ | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `false` |
21
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
+ | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
23
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
24
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
25
+ | `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `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
+ | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
28
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
24
29
 
25
30
 
26
31
  ## Events
27
32
 
28
- | Event | Description | Type |
29
- | ----------------- | ------------------------------------------------------------------------------- | ---------------------------- |
30
- | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
31
- | `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
32
- | `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
33
- | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
33
+ | Event | Description | Type |
34
+ | -------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
35
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
36
+ | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
37
+ | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
38
+ | `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
39
+ | `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
40
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
34
41
 
35
42
 
36
43
  ## Methods
37
44
 
45
+ ### `closeConfigurator() => Promise<void>`
46
+
47
+ Usado para fechar o configurator do CRUD
48
+
49
+ #### Returns
50
+
51
+ Type: `Promise<void>`
52
+
53
+
54
+
38
55
  ### `getRecords() => Promise<Array<Record>>`
39
56
 
40
57
 
@@ -55,6 +72,16 @@ Type: `Promise<void>`
55
72
 
56
73
 
57
74
 
75
+ ### `openConfigurator() => Promise<void>`
76
+
77
+ Usado para abrir o configurator do CRUD
78
+
79
+ #### Returns
80
+
81
+ Type: `Promise<void>`
82
+
83
+
84
+
58
85
  ### `setMetadata(metadata: UnitMetadata) => Promise<void>`
59
86
 
60
87
 
@@ -75,6 +102,16 @@ Type: `Promise<void>`
75
102
 
76
103
 
77
104
 
105
+ ### `updateConfig() => Promise<void>`
106
+
107
+
108
+
109
+ #### Returns
110
+
111
+ Type: `Promise<void>`
112
+
113
+
114
+
78
115
 
79
116
  ## Dependencies
80
117
 
@@ -86,6 +123,9 @@ Type: `Promise<void>`
86
123
 
87
124
  - [snk-data-unit](../snk-data-unit)
88
125
  - [snk-taskbar](../snk-taskbar)
126
+ - [snk-form-config](../snk-form-config)
127
+ - [snk-configurator](../snk-configurator)
128
+ - [snk-grid-config](../snk-grid-config)
89
129
  - [snk-data-exporter](../snk-data-exporter)
90
130
  - [snk-actions-button](../snk-actions-button)
91
131
  - [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
@@ -95,6 +135,9 @@ Type: `Promise<void>`
95
135
  graph TD;
96
136
  snk-simple-crud --> snk-data-unit
97
137
  snk-simple-crud --> snk-taskbar
138
+ snk-simple-crud --> snk-form-config
139
+ snk-simple-crud --> snk-configurator
140
+ snk-simple-crud --> snk-grid-config
98
141
  snk-simple-crud --> snk-data-exporter
99
142
  snk-simple-crud --> snk-actions-button
100
143
  snk-simple-crud --> taskbar-actions-button
@@ -102,6 +145,10 @@ graph TD;
102
145
  snk-taskbar --> snk-actions-button
103
146
  snk-taskbar --> taskbar-actions-button
104
147
  snk-data-exporter --> snk-exporter-email-sender
148
+ snk-form-config --> snk-field-config
149
+ snk-form-config --> snk-config-options
150
+ snk-form-config --> snk-tab-config
151
+ snk-grid-config --> snk-select-box
105
152
  snk-attach --> snk-simple-crud
106
153
  style snk-simple-crud fill:#f9f,stroke:#333,stroke-width:4px
107
154
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "8.15.0-rc.8",
3
+ "version": "8.15.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [