@sankhyalabs/sankhyablocks-docs 8.15.0-rc.2 → 8.15.0-rc.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/components/snk-application/readme.md +2 -2
  2. package/components/snk-crud/readme.md +14 -13
  3. package/components/snk-grid/readme.md +20 -19
  4. package/components/snk-taskbar/readme.md +2 -0
  5. package/package.json +1 -1
package/components/snk-application/readme.md CHANGED
@@ -132,7 +132,7 @@ Ex.: snk-config-options
132
132
 
133
133
  #### Returns
134
134
 
135
- Type: `Promise<any>`
135
+ Type: `Promise<IOption | IOption[]>`
136
136
 
137
137
 
138
138
 
@@ -143,7 +143,7 @@ Ex.: snk-config-options
143
143
 
144
144
  #### Returns
145
145
 
146
- Type: `Promise<any>`
146
+ Type: `Promise<IOption | IOption[]>`
147
147
 
148
148
 
149
149
 
package/components/snk-crud/readme.md CHANGED
@@ -7,19 +7,20 @@
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.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` |
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
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
16
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
17
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
18
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
19
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
20
+ | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
21
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `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
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
23
24
 
24
25
 
25
26
  ## Events
package/components/snk-grid/readme.md CHANGED
@@ -7,25 +7,26 @@
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.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` |
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
+ | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
18
+ | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `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. | `boolean` | `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
+ | `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
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
25
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
26
+ | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
27
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
28
+ | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
29
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
29
30
 
30
31
 
31
32
  ## Events
package/components/snk-taskbar/readme.md CHANGED
@@ -10,6 +10,7 @@
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- | --------------------------- |
12
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` |
13
14
  | `buttons` | `buttons` | Lista separada por virgula, contendo todos os elementos a serem criados. | `string` | `undefined` |
14
15
  | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
15
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` |
@@ -18,6 +19,7 @@
18
19
  | `dataUnit` | -- | Instância do DataUnit. | `DataUnit` | `undefined` |
19
20
  | `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados. | `string[]` | `undefined` |
20
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'` |
21
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` |
22
24
  | `primaryButton` | `primary-button` | Determina qual botão deve ter aparência primária. | `string` | `undefined` |
23
25
  | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "8.15.0-rc.2",
3
+ "version": "8.15.0-rc.3",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [