@sankhyalabs/sankhyablocks-docs 5.11.0 → 5.13.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.
|
@@ -7,19 +7,22 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `configName`
|
|
13
|
-
| `messagesBuilder`
|
|
14
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------------- | --------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ---------------- |
|
|
12
|
+
| `configName` | `config-name` | Usado para guardar ou 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
|
+
| `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação | `boolean` | `false` |
|
|
15
|
+
| `viewMode` | `view-mode` | Define qual modo de visualização está ativo. | `VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID` | `VIEW_MODE.GRID` |
|
|
15
16
|
|
|
16
17
|
|
|
17
18
|
## Events
|
|
18
19
|
|
|
19
|
-
| Event | Description
|
|
20
|
-
| ---------------- |
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
20
|
+
| Event | Description | Type |
|
|
21
|
+
| ---------------- | ---------------------------------------------------- | ----------------------------------------------------------------------- |
|
|
22
|
+
| `cancel` | Emitido quando cancela o salvamento da configuração. | `CustomEvent<void>` |
|
|
23
|
+
| `configSelected` | Emitido quando seleciona o modo de visualização. | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
|
|
24
|
+
| `openConfig` | Emitido quando clica para abrir a configuração. | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
|
|
25
|
+
| `save` | Emitido quando salva a configuração. | `CustomEvent<void>` |
|
|
23
26
|
|
|
24
27
|
|
|
25
28
|
## Methods
|
|
@@ -7,27 +7,40 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute
|
|
11
|
-
| ------------------- |
|
|
12
|
-
| `actionsList` | --
|
|
13
|
-
| `configName` | `config-name`
|
|
14
|
-
| `messagesBuilder` | --
|
|
15
|
-
| `multipleSelection` | `multiple-selection`
|
|
16
|
-
| `presentationMode` | `presentation-mode`
|
|
17
|
-
| `recordsValidator` | --
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
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
|
+
| `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
|
|
19
|
+
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
|
|
20
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
20
21
|
|
|
21
22
|
|
|
22
23
|
## Events
|
|
23
24
|
|
|
24
|
-
| Event
|
|
25
|
-
|
|
|
26
|
-
| `actionClick`
|
|
25
|
+
| Event | Description | Type |
|
|
26
|
+
| -------------------- | ---------------------------------------------------------------------------- | --------------------- |
|
|
27
|
+
| `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
|
28
|
+
| `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
|
|
29
|
+
| `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
|
|
27
30
|
|
|
28
31
|
|
|
29
32
|
## Methods
|
|
30
33
|
|
|
34
|
+
### `closeConfigurator() => Promise<void>`
|
|
35
|
+
|
|
36
|
+
Usado para fechar o configurator do CRUD
|
|
37
|
+
|
|
38
|
+
#### Returns
|
|
39
|
+
|
|
40
|
+
Type: `Promise<void>`
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
31
44
|
### `goToView(mode: string) => Promise<void>`
|
|
32
45
|
|
|
33
46
|
Usado para alternar a visão entre GRID e FORM externamente.
|
|
@@ -38,6 +51,16 @@ Type: `Promise<void>`
|
|
|
38
51
|
|
|
39
52
|
|
|
40
53
|
|
|
54
|
+
### `openConfigurator() => Promise<void>`
|
|
55
|
+
|
|
56
|
+
Usado para abrir o configurator do CRUD
|
|
57
|
+
|
|
58
|
+
#### Returns
|
|
59
|
+
|
|
60
|
+
Type: `Promise<void>`
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
|
|
41
64
|
|
|
42
65
|
## Dependencies
|
|
43
66
|
|