@sankhyalabs/sankhyablocks-docs 8.15.0-dev.3 → 8.15.0-dev.5
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.
- package/components/snk-application/readme.md +2 -2
- package/components/snk-crud/readme.md +13 -13
- package/components/snk-crud/subcomponents/readme.md +16 -16
- package/components/snk-filter-bar/filter-modal/readme.md +11 -9
- package/components/snk-filter-bar/readme.md +10 -0
- package/components/snk-grid/readme.md +19 -19
- package/components/snk-taskbar/readme.md +14 -14
- package/package.json +1 -1
@@ -132,7 +132,7 @@ Ex.: snk-config-options
|
|
132
132
|
|
133
133
|
#### Returns
|
134
134
|
|
135
|
-
Type: `Promise<
|
135
|
+
Type: `Promise<any>`
|
136
136
|
|
137
137
|
|
138
138
|
|
@@ -143,7 +143,7 @@ Ex.: snk-config-options
|
|
143
143
|
|
144
144
|
#### Returns
|
145
145
|
|
146
|
-
Type: `Promise<
|
146
|
+
Type: `Promise<any>`
|
147
147
|
|
148
148
|
|
149
149
|
|
@@ -7,19 +7,19 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute | Description | Type
|
11
|
-
| ---------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
12
|
-
| `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]`
|
13
|
-
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string`
|
14
|
-
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder`
|
15
|
-
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean`
|
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`
|
18
|
-
| `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig`
|
19
|
-
| `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean`
|
20
|
-
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver`
|
21
|
-
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager`
|
22
|
-
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean`
|
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.SINGLE_TASKBAR` | `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` |
|
23
23
|
|
24
24
|
|
25
25
|
## Events
|
@@ -7,22 +7,22 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute | Description | Type
|
11
|
-
| -------------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------- |
|
12
|
-
| `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]`
|
13
|
-
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean`
|
14
|
-
| `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string`
|
15
|
-
| `dataState` | -- | Representa o estado do dataUnit master. | `DataState`
|
16
|
-
| `dataUnit` | -- | Instância do DataUnit master. | `DataUnit`
|
17
|
-
| `detailTaskbarCustomContainerId` | `detail-taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. | `string`
|
18
|
-
| `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string`
|
19
|
-
| `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig`
|
20
|
-
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder`
|
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`
|
23
|
-
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string`
|
24
|
-
| `selectedGuide` | -- | Guia selecionada. | `IGuideItem`
|
25
|
-
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager`
|
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
|
@@ -7,15 +7,17 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property
|
11
|
-
|
|
12
|
-
| `addPersonalizedFilter`
|
13
|
-
| `applyFilters`
|
14
|
-
| `closeModal`
|
15
|
-
| `configName`
|
16
|
-
| `
|
17
|
-
| `
|
18
|
-
| `
|
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
|
+
| `editPersonalizedFilter` | -- | Ação executada ao editar um filtro personalizado | `(id: string) => void` | `undefined` |
|
18
|
+
| `filters` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
|
19
|
+
| `filtersToDelete` | -- | Guarda filtros a serem deletados no Apply do modal | `IPersonalizedFilter[]` | `[]` |
|
20
|
+
| `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
|
19
21
|
|
20
22
|
|
21
23
|
## Dependencies
|
@@ -55,6 +55,16 @@ Type: `Promise<void>`
|
|
55
55
|
|
56
56
|
|
57
57
|
|
58
|
+
### `removeFilterItem(filterID: string) => Promise<SnkFilterItemConfig | undefined>`
|
59
|
+
|
60
|
+
Remove um item de filtro.
|
61
|
+
|
62
|
+
#### Returns
|
63
|
+
|
64
|
+
Type: `Promise<SnkFilterItemConfig>`
|
65
|
+
|
66
|
+
- Retorna o item de filtro removido, ou undefined caso não encontrado.
|
67
|
+
|
58
68
|
### `updateFilterItem(newFilterItem: SnkFilterItemConfig) => Promise<void>`
|
59
69
|
|
60
70
|
Atualiza um item do filtro.
|
@@ -7,25 +7,25 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute | Description | Type
|
11
|
-
| -------------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
12
|
-
| `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]`
|
13
|
-
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean`
|
14
|
-
| `columnFilterDataSource` | -- | | `IMultiSelectionListDataSource`
|
15
|
-
| `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string`
|
16
|
-
| `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string`
|
17
|
-
| `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean`
|
18
|
-
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder`
|
19
|
-
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean`
|
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`
|
22
|
-
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string`
|
23
|
-
| `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig`
|
24
|
-
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver`
|
25
|
-
| `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string`
|
26
|
-
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager`
|
27
|
-
| `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string`
|
28
|
-
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean`
|
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.SINGLE_TASKBAR` | `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` |
|
29
29
|
|
30
30
|
|
31
31
|
## Events
|
@@ -7,20 +7,20 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute | Description | Type
|
11
|
-
| ------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
12
|
-
| `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]`
|
13
|
-
| `buttons` | `buttons` | Lista separada por virgula, contendo todos os elementos a serem criados. | `string`
|
14
|
-
| `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string`
|
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>`
|
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`
|
17
|
-
| `customSlotId` | `custom-slot-id` | Usado para determinar o identificador do slot que recebe elementos personalizados. | `string`
|
18
|
-
| `dataUnit` | -- | Instância do DataUnit. | `DataUnit`
|
19
|
-
| `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados. | `string[]`
|
20
|
-
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder`
|
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`
|
23
|
-
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string`
|
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.SINGLE_TASKBAR` | `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` |
|
24
24
|
|
25
25
|
|
26
26
|
## Events
|