@sankhyalabs/sankhyablocks-docs 0.0.0-hotfix-ga-KB-104932.0 → 0.0.0-hotfix-ga-kb-105552.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.
- package/components/snk-application/readme.md +91 -61
- package/components/snk-attach/readme.md +2 -0
- package/components/snk-crud/readme.md +17 -4
- package/components/snk-crud/subcomponents/readme.md +20 -18
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +23 -17
- package/components/snk-entity-list/readme.md +1 -0
- package/components/snk-filter-bar/filter-modal/readme.md +15 -12
- package/components/snk-filter-bar/filter-modal/subcomponents/snk-default-filter/readme.md +38 -0
- package/components/snk-form/readme.md +8 -3
- package/components/snk-form-config/config-header/configs-button/readme.md +40 -0
- package/components/snk-form-config/config-header/readme.md +47 -0
- package/components/snk-form-config/field-item/field-config/readme.md +53 -0
- package/components/snk-form-config/field-item/readme.md +48 -0
- package/components/snk-form-config/fields-layout/readme.md +64 -0
- package/components/snk-form-config/fields-selector/readme.md +44 -0
- package/components/snk-form-config/guides-configurator/readme.md +42 -0
- package/components/snk-form-config/readme.md +13 -7
- package/components/snk-grid/readme.md +12 -15
- package/components/snk-personalized-filter/readme.md +8 -7
- package/components/snk-personalized-filter/subcomponents/snk-expression-group/readme.md +8 -7
- package/components/snk-personalized-filter/subcomponents/snk-expression-item/readme.md +7 -6
- package/components/snk-personalized-filter/subcomponents/snk-filter-assistent-mode/readme.md +8 -7
- package/components/snk-simple-crud/readme.md +5 -1
- package/components/snk-taskbar/elements/taskbar-split-button/readme.md +47 -0
- package/components/snk-taskbar/readme.md +19 -16
- package/package.json +1 -1
- package/components/snk-form-config/subcomponents/snk-config-options/readme.md +0 -40
- package/components/snk-form-config/subcomponents/snk-field-config/readme.md +0 -41
- package/components/snk-form-config/subcomponents/snk-tab-config/readme.md +0 -46
|
@@ -7,23 +7,24 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description | Type
|
|
11
|
-
| -------------------------- | ----------------------------- | ------------------------------------------------------------------------- |
|
|
12
|
-
| `branchGuide` | -- | | `IGuideItem`
|
|
13
|
-
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean`
|
|
14
|
-
| `customEditors` | -- | Registra um editor customizado para campos da grade e formulário. | `PropsCustomEditor`
|
|
15
|
-
| `customRenders` | -- | Render customizados da grade. | `PropsCustomRender`
|
|
16
|
-
| `dataState` | -- | Representa o estado do dataUnit detail. | `DataState`
|
|
17
|
-
| `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit`
|
|
18
|
-
| `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string`
|
|
19
|
-
| `entityName` | `entity-name` | Nome da entidade detail. | `string`
|
|
20
|
-
| `formConfigManager` | -- | Gerenciador de configuração do formulário. | `SnkFormConfigManager`
|
|
21
|
-
| `guideItemPath` | -- | Caminho do identificador da guia vinculada. | `IGuideItem[]`
|
|
22
|
-
| `label` | `label` | Descrição amigável do cadastro detalhe. | `string`
|
|
23
|
-
| `messagesBuilder` | -- | | `SnkMessageBuilder`
|
|
24
|
-
| `
|
|
25
|
-
| `
|
|
26
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| -------------------------- | ----------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ---------------------------- |
|
|
12
|
+
| `branchGuide` | -- | | `IGuideItem` | `undefined` |
|
|
13
|
+
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
|
|
14
|
+
| `customEditors` | -- | Registra um editor customizado para campos da grade e formulário. | `PropsCustomEditor` | `undefined` |
|
|
15
|
+
| `customRenders` | -- | Render customizados da grade. | `PropsCustomRender` | `undefined` |
|
|
16
|
+
| `dataState` | -- | Representa o estado do dataUnit detail. | `DataState` | `undefined` |
|
|
17
|
+
| `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit` | `undefined` |
|
|
18
|
+
| `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string` | `undefined` |
|
|
19
|
+
| `entityName` | `entity-name` | Nome da entidade detail. | `string` | `undefined` |
|
|
20
|
+
| `formConfigManager` | -- | Gerenciador de configuração do formulário. | `SnkFormConfigManager` | `undefined` |
|
|
21
|
+
| `guideItemPath` | -- | Caminho do identificador da guia vinculada. | `IGuideItem[]` | `undefined` |
|
|
22
|
+
| `label` | `label` | Descrição amigável do cadastro detalhe. | `string` | `undefined` |
|
|
23
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `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.SECONDARY` |
|
|
25
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
26
|
+
| `selectedForm` | `selected-form` | Representa o formulário selecionado. | `string` | `undefined` |
|
|
27
|
+
| `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
|
|
27
28
|
|
|
28
29
|
|
|
29
30
|
## Events
|
|
@@ -103,6 +104,7 @@ Type: `Promise<void>`
|
|
|
103
104
|
- [snk-attach](../../../snk-attach)
|
|
104
105
|
- [snk-data-exporter](../../../snk-data-exporter)
|
|
105
106
|
- [snk-actions-button](../../../snk-actions-button)
|
|
107
|
+
- [taskbar-split-button](../../../snk-taskbar/elements/taskbar-split-button)
|
|
106
108
|
- [taskbar-actions-button](../../../snk-taskbar/elements/taskbar-actions-button)
|
|
107
109
|
|
|
108
110
|
### Graph
|
|
@@ -115,12 +117,14 @@ graph TD;
|
|
|
115
117
|
snk-detail-view --> snk-attach
|
|
116
118
|
snk-detail-view --> snk-data-exporter
|
|
117
119
|
snk-detail-view --> snk-actions-button
|
|
120
|
+
snk-detail-view --> taskbar-split-button
|
|
118
121
|
snk-detail-view --> taskbar-actions-button
|
|
119
122
|
snk-grid --> snk-filter-bar
|
|
120
123
|
snk-grid --> snk-taskbar
|
|
121
124
|
snk-grid --> snk-grid-config
|
|
122
125
|
snk-grid --> snk-data-exporter
|
|
123
126
|
snk-grid --> snk-actions-button
|
|
127
|
+
snk-grid --> taskbar-split-button
|
|
124
128
|
snk-grid --> taskbar-actions-button
|
|
125
129
|
snk-filter-bar --> snk-filter-item
|
|
126
130
|
snk-filter-bar --> snk-personalized-filter
|
|
@@ -136,6 +140,7 @@ graph TD;
|
|
|
136
140
|
snk-expression-item --> snk-filter-param-config
|
|
137
141
|
snk-taskbar --> snk-data-exporter
|
|
138
142
|
snk-taskbar --> snk-actions-button
|
|
143
|
+
snk-taskbar --> taskbar-split-button
|
|
139
144
|
snk-taskbar --> taskbar-actions-button
|
|
140
145
|
snk-data-exporter --> snk-exporter-email-sender
|
|
141
146
|
snk-grid-config --> snk-select-box
|
|
@@ -149,6 +154,7 @@ graph TD;
|
|
|
149
154
|
snk-simple-crud --> snk-grid-config
|
|
150
155
|
snk-simple-crud --> snk-data-exporter
|
|
151
156
|
snk-simple-crud --> snk-actions-button
|
|
157
|
+
snk-simple-crud --> taskbar-split-button
|
|
152
158
|
snk-simple-crud --> taskbar-actions-button
|
|
153
159
|
snk-configurator --> snk-layout-form-config
|
|
154
160
|
snk-layout-form-config --> snk-view-representation
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
| `config` | -- | Configurações para carregar os dados do componente | `SnkFilterItemConfig` | `undefined` |
|
|
13
13
|
| `maxHeightList` | `max-height-list` | Permite definir uma altura máxima para o ez-list, adicionando um scroll ao atingir esta medida | `string` | `""` |
|
|
14
14
|
| `rightListSlotBuilder` | -- | Método que possibilita alterar como o item da lista vai ser apresentado. Observação: No React ele se transforma em VNode e não HTMLElement. | `(item: ListItem, group?: ListGroup) => string \| HTMLElement` | `undefined` |
|
|
15
|
+
| `value` | -- | Define o valor do componente | `IOption` | `undefined` |
|
|
15
16
|
|
|
16
17
|
|
|
17
18
|
## Events
|
|
@@ -7,18 +7,19 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description | Type
|
|
11
|
-
| --------------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
12
|
-
| `addPersonalizedFilter` | -- | Ação executada ao adicionar um filtro personalizado | `() => void`
|
|
13
|
-
| `applyFilters` | -- | Ação executada ao aplicar os filtros | `(updatedFilterConfig: SnkFilterItemConfig[]) => void`
|
|
14
|
-
| `closeModal` | -- | Ação disparada ao fechar o modal | `() => void`
|
|
15
|
-
| `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string`
|
|
16
|
-
| `deletePersonalizedFilter` | -- | Ação executada ao deletar um filtro personalizado | `(filter: IPersonalizedFilter, configName: string) => void` | `undefined` |
|
|
17
|
-
| `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`
|
|
18
|
-
| `editPersonalizedFilter` | -- | Ação executada ao editar um filtro personalizado | `(id: string) => void` | `undefined` |
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| --------------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- | ----------- |
|
|
12
|
+
| `addPersonalizedFilter` | -- | Ação executada ao adicionar um filtro personalizado | `(isDefault?: boolean) => 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, isDefault?: boolean) => void` | `undefined` |
|
|
17
|
+
| `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` |
|
|
18
|
+
| `editPersonalizedFilter` | -- | Ação executada ao editar um filtro personalizado | `(id: string, isDefault?: boolean) => void` | `undefined` |
|
|
19
|
+
| `filterDefaultToDelete` | -- | Guarda o filtro a ser deletado no Apply do modal | `SnkFilterItemConfig` | `undefined` |
|
|
20
|
+
| `filters` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
|
|
21
|
+
| `filtersToDelete` | -- | Guarda filtros a serem deletados no Apply do modal | `IPersonalizedFilter[]` | `[]` |
|
|
22
|
+
| `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
|
|
22
23
|
|
|
23
24
|
|
|
24
25
|
## Dependencies
|
|
@@ -26,11 +27,13 @@
|
|
|
26
27
|
### Depends on
|
|
27
28
|
|
|
28
29
|
- [snk-filter-modal-item](subcomponents)
|
|
30
|
+
- [snk-default-filter](./subcomponents/snk-default-filter)
|
|
29
31
|
|
|
30
32
|
### Graph
|
|
31
33
|
```mermaid
|
|
32
34
|
graph TD;
|
|
33
35
|
snk-filter-modal --> snk-filter-modal-item
|
|
36
|
+
snk-filter-modal --> snk-default-filter
|
|
34
37
|
style snk-filter-modal fill:#f9f,stroke:#333,stroke-width:4px
|
|
35
38
|
```
|
|
36
39
|
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# snk-default-filter
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------------ | -------------------- | --------------------------------------------------------------------------------- | -------------------------------------- | ----------- |
|
|
12
|
+
| `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
|
|
13
|
+
| `hasDefaultFilter` | `has-default-filter` | Informa se já existe um filtro padrão criado. | `boolean` | `false` |
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
## Events
|
|
17
|
+
|
|
18
|
+
| Event | Description | Type |
|
|
19
|
+
| ---------------- | ----------- | --------------------------------------------------------------------------------------------------- |
|
|
20
|
+
| `actionSelected` | | `CustomEvent<ActionDefaultFilter.CREATE \| ActionDefaultFilter.EDIT \| ActionDefaultFilter.REMOVE>` |
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
## Dependencies
|
|
24
|
+
|
|
25
|
+
### Used by
|
|
26
|
+
|
|
27
|
+
- [snk-filter-modal](../..)
|
|
28
|
+
|
|
29
|
+
### Graph
|
|
30
|
+
```mermaid
|
|
31
|
+
graph TD;
|
|
32
|
+
snk-filter-modal --> snk-default-filter
|
|
33
|
+
style snk-default-filter fill:#f9f,stroke:#333,stroke-width:4px
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
----------------------------------------------
|
|
37
|
+
|
|
38
|
+
|
|
@@ -78,9 +78,14 @@ Type: `Promise<void>`
|
|
|
78
78
|
```mermaid
|
|
79
79
|
graph TD;
|
|
80
80
|
snk-form --> snk-form-config
|
|
81
|
-
snk-form-config -->
|
|
82
|
-
snk-form-config -->
|
|
83
|
-
snk-form-config -->
|
|
81
|
+
snk-form-config --> config-header
|
|
82
|
+
snk-form-config --> guides-configurator
|
|
83
|
+
snk-form-config --> fields-layout
|
|
84
|
+
snk-form-config --> fields-selector
|
|
85
|
+
config-header --> configs-button
|
|
86
|
+
fields-layout --> field-item
|
|
87
|
+
field-item --> field-config
|
|
88
|
+
fields-selector --> field-item
|
|
84
89
|
style snk-form fill:#f9f,stroke:#333,stroke-width:4px
|
|
85
90
|
```
|
|
86
91
|
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# configs-button
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------------- | ------------- | ----------- | ------------------- | ----------- |
|
|
12
|
+
| `configOptions` | -- | | `IUserConfig[]` | `[]` |
|
|
13
|
+
| `hasChanges` | `has-changes` | | `boolean` | `false` |
|
|
14
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
|
15
|
+
| `selectedConfig` | -- | | `IUserConfig` | `undefined` |
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## Events
|
|
19
|
+
|
|
20
|
+
| Event | Description | Type |
|
|
21
|
+
| -------------------------- | ----------- | -------------------------- |
|
|
22
|
+
| `formConfigOptionSelected` | | `CustomEvent<IUserConfig>` |
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
## Dependencies
|
|
26
|
+
|
|
27
|
+
### Used by
|
|
28
|
+
|
|
29
|
+
- [config-header](..)
|
|
30
|
+
|
|
31
|
+
### Graph
|
|
32
|
+
```mermaid
|
|
33
|
+
graph TD;
|
|
34
|
+
config-header --> configs-button
|
|
35
|
+
style configs-button fill:#f9f,stroke:#333,stroke-width:4px
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
----------------------------------------------
|
|
39
|
+
|
|
40
|
+
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# config-header
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| --------------------- | ----------------------- | ----------- | ------------------- | ----------- |
|
|
12
|
+
| `configOptions` | -- | | `IUserConfig[]` | `[]` |
|
|
13
|
+
| `hasChanges` | `has-changes` | | `boolean` | `false` |
|
|
14
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
|
15
|
+
| `optionConfigChanged` | `option-config-changed` | | `boolean` | `false` |
|
|
16
|
+
| `selectedConfig` | -- | | `IUserConfig` | `undefined` |
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## Events
|
|
20
|
+
|
|
21
|
+
| Event | Description | Type |
|
|
22
|
+
| ------------- | ----------- | ------------------- |
|
|
23
|
+
| `configClose` | | `CustomEvent<void>` |
|
|
24
|
+
| `saveConfig` | | `CustomEvent<void>` |
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## Dependencies
|
|
28
|
+
|
|
29
|
+
### Used by
|
|
30
|
+
|
|
31
|
+
- [snk-form-config](..)
|
|
32
|
+
|
|
33
|
+
### Depends on
|
|
34
|
+
|
|
35
|
+
- [configs-button](configs-button)
|
|
36
|
+
|
|
37
|
+
### Graph
|
|
38
|
+
```mermaid
|
|
39
|
+
graph TD;
|
|
40
|
+
config-header --> configs-button
|
|
41
|
+
snk-form-config --> config-header
|
|
42
|
+
style config-header fill:#f9f,stroke:#333,stroke-width:4px
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
----------------------------------------------
|
|
46
|
+
|
|
47
|
+
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# field-config
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------------- | -------------- | ----------- | ------------------- | ----------- |
|
|
12
|
+
| `dataUnit` | -- | | `DataUnit` | `undefined` |
|
|
13
|
+
| `fieldConfig` | `field-config` | | `IFieldConfig` | `undefined` |
|
|
14
|
+
| `fieldDescriptor` | -- | | `FieldDescriptor` | `undefined` |
|
|
15
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## Events
|
|
19
|
+
|
|
20
|
+
| Event | Description | Type |
|
|
21
|
+
| -------------------- | ----------- | --------------------------- |
|
|
22
|
+
| `fieldConfigChanged` | | `CustomEvent<IFieldConfig>` |
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
## Methods
|
|
26
|
+
|
|
27
|
+
### `show(_anchorElement: HTMLElement) => Promise<void>`
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
#### Returns
|
|
32
|
+
|
|
33
|
+
Type: `Promise<void>`
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
## Dependencies
|
|
39
|
+
|
|
40
|
+
### Used by
|
|
41
|
+
|
|
42
|
+
- [field-item](..)
|
|
43
|
+
|
|
44
|
+
### Graph
|
|
45
|
+
```mermaid
|
|
46
|
+
graph TD;
|
|
47
|
+
field-item --> field-config
|
|
48
|
+
style field-config fill:#f9f,stroke:#333,stroke-width:4px
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
----------------------------------------------
|
|
52
|
+
|
|
53
|
+
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# field-item
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------------- | ------------------ | ----------- | ------------------- | ----------- |
|
|
12
|
+
| `dataUnit` | -- | | `DataUnit` | `undefined` |
|
|
13
|
+
| `fieldConfig` | `field-config` | | `IFieldConfig` | `undefined` |
|
|
14
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
|
15
|
+
| `onLayoutConfig` | `on-layout-config` | | `boolean` | `false` |
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## Events
|
|
19
|
+
|
|
20
|
+
| Event | Description | Type |
|
|
21
|
+
| --------------------- | ----------- | --------------------------- |
|
|
22
|
+
| `addFieldToGuide` | | `CustomEvent<IFieldConfig>` |
|
|
23
|
+
| `setFieldAsAvailable` | | `CustomEvent<IFieldConfig>` |
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
## Dependencies
|
|
27
|
+
|
|
28
|
+
### Used by
|
|
29
|
+
|
|
30
|
+
- [fields-layout](../fields-layout)
|
|
31
|
+
- [fields-selector](../fields-selector)
|
|
32
|
+
|
|
33
|
+
### Depends on
|
|
34
|
+
|
|
35
|
+
- [field-config](field-config)
|
|
36
|
+
|
|
37
|
+
### Graph
|
|
38
|
+
```mermaid
|
|
39
|
+
graph TD;
|
|
40
|
+
field-item --> field-config
|
|
41
|
+
fields-layout --> field-item
|
|
42
|
+
fields-selector --> field-item
|
|
43
|
+
style field-item fill:#f9f,stroke:#333,stroke-width:4px
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
----------------------------------------------
|
|
47
|
+
|
|
48
|
+
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# fields-layout
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------------- | --------- | ----------- | ------------------- | ----------- |
|
|
12
|
+
| `dataUnit` | -- | | `DataUnit` | `undefined` |
|
|
13
|
+
| `groupsList` | -- | | `IGroupConfig[]` | `[]` |
|
|
14
|
+
| `guideNames` | -- | | `string[]` | `[]` |
|
|
15
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
|
16
|
+
| `selectedGuide` | -- | | `IGuideConfig` | `undefined` |
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## Events
|
|
20
|
+
|
|
21
|
+
| Event | Description | Type |
|
|
22
|
+
| ------------------------- | ----------- | ----------------------------- |
|
|
23
|
+
| `guideRenamed` | | `CustomEvent<string>` |
|
|
24
|
+
| `isEditingGroupName` | | `CustomEvent<boolean>` |
|
|
25
|
+
| `isEditingGuideName` | | `CustomEvent<boolean>` |
|
|
26
|
+
| `layoutChanged` | | `CustomEvent<IGroupConfig[]>` |
|
|
27
|
+
| `setFieldListAsAvailable` | | `CustomEvent<IFieldConfig[]>` |
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
## Methods
|
|
31
|
+
|
|
32
|
+
### `addFieldToLayout(incomingField: IFieldConfig) => Promise<void>`
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
#### Returns
|
|
37
|
+
|
|
38
|
+
Type: `Promise<void>`
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
## Dependencies
|
|
44
|
+
|
|
45
|
+
### Used by
|
|
46
|
+
|
|
47
|
+
- [snk-form-config](..)
|
|
48
|
+
|
|
49
|
+
### Depends on
|
|
50
|
+
|
|
51
|
+
- [field-item](../field-item)
|
|
52
|
+
|
|
53
|
+
### Graph
|
|
54
|
+
```mermaid
|
|
55
|
+
graph TD;
|
|
56
|
+
fields-layout --> field-item
|
|
57
|
+
field-item --> field-config
|
|
58
|
+
snk-form-config --> fields-layout
|
|
59
|
+
style fields-layout fill:#f9f,stroke:#333,stroke-width:4px
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
----------------------------------------------
|
|
63
|
+
|
|
64
|
+
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# fields-selector
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------------- | --------- | ----------- | ---------------- | ----------- |
|
|
12
|
+
| `availableFields` | -- | | `IFieldConfig[]` | `[]` |
|
|
13
|
+
| `dataUnit` | -- | | `DataUnit` | `undefined` |
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
## Events
|
|
17
|
+
|
|
18
|
+
| Event | Description | Type |
|
|
19
|
+
| ------------------ | ----------- | ----------------------------- |
|
|
20
|
+
| `fieldListChanged` | | `CustomEvent<IFieldConfig[]>` |
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
## Dependencies
|
|
24
|
+
|
|
25
|
+
### Used by
|
|
26
|
+
|
|
27
|
+
- [snk-form-config](..)
|
|
28
|
+
|
|
29
|
+
### Depends on
|
|
30
|
+
|
|
31
|
+
- [field-item](../field-item)
|
|
32
|
+
|
|
33
|
+
### Graph
|
|
34
|
+
```mermaid
|
|
35
|
+
graph TD;
|
|
36
|
+
fields-selector --> field-item
|
|
37
|
+
field-item --> field-config
|
|
38
|
+
snk-form-config --> fields-selector
|
|
39
|
+
style fields-selector fill:#f9f,stroke:#333,stroke-width:4px
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
----------------------------------------------
|
|
43
|
+
|
|
44
|
+
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# guides-configurator
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------------- | --------- | ----------- | ------------------- | ----------- |
|
|
12
|
+
| `guidesList` | -- | | `IGuideConfig[]` | `[]` |
|
|
13
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
|
14
|
+
| `selectedGuide` | -- | | `IGuideConfig` | `undefined` |
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
## Events
|
|
18
|
+
|
|
19
|
+
| Event | Description | Type |
|
|
20
|
+
| ------------------ | ----------- | ----------------------------- |
|
|
21
|
+
| `createNewGuide` | | `CustomEvent<void>` |
|
|
22
|
+
| `guideDeleted` | | `CustomEvent<IGuideConfig>` |
|
|
23
|
+
| `guideListChanged` | | `CustomEvent<IGuideConfig[]>` |
|
|
24
|
+
| `guideSelected` | | `CustomEvent<IGuideConfig>` |
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## Dependencies
|
|
28
|
+
|
|
29
|
+
### Used by
|
|
30
|
+
|
|
31
|
+
- [snk-form-config](..)
|
|
32
|
+
|
|
33
|
+
### Graph
|
|
34
|
+
```mermaid
|
|
35
|
+
graph TD;
|
|
36
|
+
snk-form-config --> guides-configurator
|
|
37
|
+
style guides-configurator fill:#f9f,stroke:#333,stroke-width:4px
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
----------------------------------------------
|
|
41
|
+
|
|
42
|
+
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# snk-form-config
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
|
|
@@ -32,16 +32,22 @@
|
|
|
32
32
|
|
|
33
33
|
### Depends on
|
|
34
34
|
|
|
35
|
-
- [
|
|
36
|
-
- [
|
|
37
|
-
- [
|
|
35
|
+
- [config-header](config-header)
|
|
36
|
+
- [guides-configurator](guides-configurator)
|
|
37
|
+
- [fields-layout](fields-layout)
|
|
38
|
+
- [fields-selector](fields-selector)
|
|
38
39
|
|
|
39
40
|
### Graph
|
|
40
41
|
```mermaid
|
|
41
42
|
graph TD;
|
|
42
|
-
snk-form-config -->
|
|
43
|
-
snk-form-config -->
|
|
44
|
-
snk-form-config -->
|
|
43
|
+
snk-form-config --> config-header
|
|
44
|
+
snk-form-config --> guides-configurator
|
|
45
|
+
snk-form-config --> fields-layout
|
|
46
|
+
snk-form-config --> fields-selector
|
|
47
|
+
config-header --> configs-button
|
|
48
|
+
fields-layout --> field-item
|
|
49
|
+
field-item --> field-config
|
|
50
|
+
fields-selector --> field-item
|
|
45
51
|
snk-form --> snk-form-config
|
|
46
52
|
snk-guides-viewer --> snk-form-config
|
|
47
53
|
style snk-form-config fill:#f9f,stroke:#333,stroke-width:4px
|