@sankhyalabs/sankhyablocks-docs 2.5.2 → 2.6.1
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-crud/readme.md +4 -1
- package/components/snk-data-exporter/exporter-email-sender/readme.md +2 -2
- package/components/snk-data-exporter/readme.md +39 -0
- package/components/snk-form/readme.md +7 -6
- package/components/snk-form/subcomponents/snk-config-options/readme.md +5 -5
- package/components/snk-form/subcomponents/snk-field-config/readme.md +1 -1
- package/components/snk-form/subcomponents/snk-form-config/readme.md +1 -1
- package/components/snk-grid/readme.md +1 -0
- package/components/snk-taskbar/readme.md +5 -0
- package/package.json +1 -1
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
|
|
14
14
|
| `enableDataExporter` | `enable-data-exporter` | Determina se haverá exportação de dados | `boolean` | `false` |
|
|
15
15
|
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
|
|
16
|
-
| `recordsValidator` |
|
|
16
|
+
| `recordsValidator` | `records-validator` | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
|
17
17
|
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `IStatusResolver` | `undefined` |
|
|
18
18
|
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
19
19
|
|
|
@@ -45,6 +45,7 @@ Type: `Promise<void>`
|
|
|
45
45
|
- [snk-grid](../snk-grid)
|
|
46
46
|
- [snk-form](../snk-form)
|
|
47
47
|
- [snk-configurator](../snk-configurator)
|
|
48
|
+
- [snk-data-exporter](../snk-data-exporter)
|
|
48
49
|
|
|
49
50
|
### Graph
|
|
50
51
|
```mermaid
|
|
@@ -52,6 +53,7 @@ graph TD;
|
|
|
52
53
|
snk-crud --> snk-grid
|
|
53
54
|
snk-crud --> snk-form
|
|
54
55
|
snk-crud --> snk-configurator
|
|
56
|
+
snk-crud --> snk-data-exporter
|
|
55
57
|
snk-grid --> snk-filter-bar
|
|
56
58
|
snk-grid --> snk-taskbar
|
|
57
59
|
snk-grid --> snk-exporter-email-sender
|
|
@@ -60,6 +62,7 @@ graph TD;
|
|
|
60
62
|
snk-filter-bar --> snk-filter-modal
|
|
61
63
|
snk-filter-bar --> snk-filter-list
|
|
62
64
|
snk-filter-item --> snk-filter-detail
|
|
65
|
+
snk-taskbar --> snk-data-exporter
|
|
63
66
|
snk-grid-config --> snk-select-box
|
|
64
67
|
snk-form --> snk-taskbar
|
|
65
68
|
snk-form --> snk-form-config
|
|
@@ -14,13 +14,13 @@
|
|
|
14
14
|
|
|
15
15
|
## Methods
|
|
16
16
|
|
|
17
|
-
### `open(config:
|
|
17
|
+
### `open(config: IExportConfig) => Promise<IExportResult>`
|
|
18
18
|
|
|
19
19
|
|
|
20
20
|
|
|
21
21
|
#### Returns
|
|
22
22
|
|
|
23
|
-
Type: `Promise<
|
|
23
|
+
Type: `Promise<IExportResult>`
|
|
24
24
|
|
|
25
25
|
|
|
26
26
|
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# snk-data-exporter
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ---------- | --------- | --------------------------------------------------- | ------------------- | ------- |
|
|
12
|
+
| `provider` | -- | Provedor das informações para exportação dos dados. | `IExporterProvider` | `null` |
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## Events
|
|
16
|
+
|
|
17
|
+
| Event | Description | Type |
|
|
18
|
+
| --------------------- | ---------------------------------------------------------- | ------------------ |
|
|
19
|
+
| `ezClickDataExporter` | Evento emitido quando uma opção de exportação for clicada. | `CustomEvent<any>` |
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
## Dependencies
|
|
23
|
+
|
|
24
|
+
### Used by
|
|
25
|
+
|
|
26
|
+
- [snk-crud](../snk-crud)
|
|
27
|
+
- [snk-taskbar](../snk-taskbar)
|
|
28
|
+
|
|
29
|
+
### Graph
|
|
30
|
+
```mermaid
|
|
31
|
+
graph TD;
|
|
32
|
+
snk-crud --> snk-data-exporter
|
|
33
|
+
snk-taskbar --> snk-data-exporter
|
|
34
|
+
style snk-data-exporter fill:#f9f,stroke:#333,stroke-width:4px
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
----------------------------------------------
|
|
38
|
+
|
|
39
|
+
|
|
@@ -7,12 +7,12 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute
|
|
11
|
-
| ------------------ |
|
|
12
|
-
| `actionsList` | --
|
|
13
|
-
| `configName` | `config-name`
|
|
14
|
-
| `recordsValidator` |
|
|
15
|
-
| `taskbarManager` | --
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
|
|
12
|
+
| `actionsList` | -- | Define a lista de ações que devem ser usadas no botão "Mais opções" do snk-taskbar. | `Action[]` | `undefined` |
|
|
13
|
+
| `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
|
|
14
|
+
| `recordsValidator` | `records-validator` | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
|
15
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
## Events
|
|
@@ -62,6 +62,7 @@ Type: `Promise<void>`
|
|
|
62
62
|
graph TD;
|
|
63
63
|
snk-form --> snk-taskbar
|
|
64
64
|
snk-form --> snk-form-config
|
|
65
|
+
snk-taskbar --> snk-data-exporter
|
|
65
66
|
snk-form-config --> snk-field-config
|
|
66
67
|
snk-form-config --> snk-config-options
|
|
67
68
|
snk-form-config --> snk-tab-config
|
|
@@ -7,11 +7,11 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute
|
|
11
|
-
| ------------- |
|
|
12
|
-
| `dataUnit` | --
|
|
13
|
-
| `fieldConfig` |
|
|
14
|
-
| `idConfig` | `id-config`
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------- | -------------- | ----------------------------------------------------------------------- | -------------- | -------------------- |
|
|
12
|
+
| `dataUnit` | -- | Repositório de dados responsável por controlar a manipulação dos dados. | `DataUnit` | `undefined` |
|
|
13
|
+
| `fieldConfig` | `field-config` | Armazena as propriedades do campo. | `IFieldConfig` | `{} as IFieldConfig` |
|
|
14
|
+
| `idConfig` | `id-config` | Armazena a chave de opções de configuração. | `string` | `undefined` |
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
## Events
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
|
11
11
|
| ---------------- | ---------------- | ------------------------------------------------------- | -------------- | ----------- |
|
|
12
12
|
| `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
|
|
13
|
-
| `fieldConfig` |
|
|
13
|
+
| `fieldConfig` | `field-config` | Armazena as propriedades do campo. | `IFieldConfig` | `undefined` |
|
|
14
14
|
| `isConfigActive` | -- | Define se o popover de configuração está ativo. | `Boolean` | `false` |
|
|
15
15
|
| `modeInsertion` | `mode-insertion` | Define se o componente está em modo de inserção. | `boolean` | `true` |
|
|
16
16
|
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
| ------------ | ------------- | -------------------------------------------------------------------- | ------------- | ------------------- |
|
|
12
12
|
| `configName` | `config-name` | Nome usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
|
|
13
13
|
| `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
|
|
14
|
-
| `formConfig` |
|
|
14
|
+
| `formConfig` | `form-config` | Campos de configuração de formulário. | `IFormConfig` | `{} as IFormConfig` |
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
## Events
|
|
@@ -82,6 +82,7 @@ graph TD;
|
|
|
82
82
|
snk-filter-bar --> snk-filter-modal
|
|
83
83
|
snk-filter-bar --> snk-filter-list
|
|
84
84
|
snk-filter-item --> snk-filter-detail
|
|
85
|
+
snk-taskbar --> snk-data-exporter
|
|
85
86
|
snk-grid-config --> snk-select-box
|
|
86
87
|
snk-crud --> snk-grid
|
|
87
88
|
style snk-grid fill:#f9f,stroke:#333,stroke-width:4px
|
|
@@ -32,9 +32,14 @@
|
|
|
32
32
|
- [snk-form](../snk-form)
|
|
33
33
|
- [snk-grid](../snk-grid)
|
|
34
34
|
|
|
35
|
+
### Depends on
|
|
36
|
+
|
|
37
|
+
- [snk-data-exporter](../snk-data-exporter)
|
|
38
|
+
|
|
35
39
|
### Graph
|
|
36
40
|
```mermaid
|
|
37
41
|
graph TD;
|
|
42
|
+
snk-taskbar --> snk-data-exporter
|
|
38
43
|
snk-form --> snk-taskbar
|
|
39
44
|
snk-grid --> snk-taskbar
|
|
40
45
|
style snk-taskbar fill:#f9f,stroke:#333,stroke-width:4px
|