@sankhyalabs/sankhyablocks-docs 0.0.0-bugfix-dev-KB-11997.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-actions-button/readme.md +33 -0
- package/components/snk-actions-button/subcomponents/readme.md +33 -0
- package/components/snk-application/readme.md +492 -0
- package/components/snk-attach/readme.md +55 -0
- package/components/snk-configurator/readme.md +69 -0
- package/components/snk-crud/readme.md +149 -0
- package/components/snk-crud/subcomponents/readme.md +122 -0
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +129 -0
- package/components/snk-data-exporter/exporter-email-sender/readme.md +53 -0
- package/components/snk-data-exporter/readme.md +46 -0
- package/components/snk-data-unit/readme.md +79 -0
- package/components/snk-entity-list/readme.md +39 -0
- package/components/snk-filter-bar/filter-item/editors/readme.md +25 -0
- package/components/snk-filter-bar/filter-item/editors/snk-personalized-filter-editor/readme.md +43 -0
- package/components/snk-filter-bar/filter-item/readme.md +67 -0
- package/components/snk-filter-bar/filter-list/readme.md +43 -0
- package/components/snk-filter-bar/filter-modal/readme.md +36 -0
- package/components/snk-filter-bar/filter-modal/subcomponents/readme.md +41 -0
- package/components/snk-filter-bar/readme.md +64 -0
- package/components/snk-filter-field-search/readme.md +65 -0
- package/components/snk-form/readme.md +68 -0
- package/components/snk-form/subcomponents/snk-config-options/readme.md +40 -0
- package/components/snk-form/subcomponents/snk-field-config/readme.md +41 -0
- package/components/snk-form/subcomponents/snk-form-config/readme.md +51 -0
- package/components/snk-form/subcomponents/snk-tab-config/readme.md +46 -0
- package/components/snk-grid/readme.md +128 -0
- package/components/snk-grid/subcomponents/snk-grid-config/readme.md +48 -0
- package/components/snk-grid/subcomponents/snk-select-box/readme.md +37 -0
- package/components/snk-personalized-filter/readme.md +71 -0
- package/components/snk-personalized-filter/subcomponents/snk-expression-group/readme.md +65 -0
- package/components/snk-personalized-filter/subcomponents/snk-expression-item/readme.md +48 -0
- package/components/snk-personalized-filter/subcomponents/snk-filter-advanced-mode/readme.md +38 -0
- package/components/snk-personalized-filter/subcomponents/snk-filter-assistent-mode/readme.md +50 -0
- package/components/snk-personalized-filter/subcomponents/snk-filter-param-config/readme.md +53 -0
- package/components/snk-pesquisa/readme.md +32 -0
- package/components/snk-print-selector/readme.md +23 -0
- package/components/snk-simple-bar/readme.md +42 -0
- package/components/snk-simple-crud/readme.md +106 -0
- package/components/snk-taskbar/readme.md +17 -0
- package/components/teste-pesquisa/readme.md +24 -0
- package/package.json +14 -0
package/components/snk-filter-bar/filter-item/editors/snk-personalized-filter-editor/readme.md
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# snk-personalized-filter-editor
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------------ | ------------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------- | ------------------------- |
|
|
12
|
+
| `config` | -- | Configuração que define as opções e comportamento do componente. | `SnkFilterItemConfig` | `undefined` |
|
|
13
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
14
|
+
| `presentationMode` | `presentation-mode` | Controla o modo de apresentação do componente, que pode ser configurado como modal ou chip. | `EPresentationMode.CHIP \| EPresentationMode.MODAL` | `EPresentationMode.MODAL` |
|
|
15
|
+
| `value` | -- | Controla o valor do componente. | `(string \| number \| boolean \| Date \| IOption)[]` | `undefined` |
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## Events
|
|
19
|
+
|
|
20
|
+
| Event | Description | Type |
|
|
21
|
+
| -------------- | -------------------------------------------- | ---------------------------------- |
|
|
22
|
+
| `addFilter` | | `CustomEvent<void>` |
|
|
23
|
+
| `deleteFilter` | | `CustomEvent<IPersonalizedFilter>` |
|
|
24
|
+
| `editFilter` | | `CustomEvent<string>` |
|
|
25
|
+
| `valueChanged` | Emitido quando o valor do filtro é alterado. | `CustomEvent<any>` |
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
## Methods
|
|
29
|
+
|
|
30
|
+
### `show() => Promise<void>`
|
|
31
|
+
|
|
32
|
+
Apresenta o componente
|
|
33
|
+
|
|
34
|
+
#### Returns
|
|
35
|
+
|
|
36
|
+
Type: `Promise<void>`
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
----------------------------------------------
|
|
42
|
+
|
|
43
|
+
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# snk-filter-item
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------ | --------- | --------------------------------------------------------------------------------- | -------------------------------------- | ----------- |
|
|
12
|
+
| `config` | -- | Define as configurações do componente snk-filter-item. | `SnkFilterItemConfig` | `undefined` |
|
|
13
|
+
| `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
## Events
|
|
17
|
+
|
|
18
|
+
| Event | Description | Type |
|
|
19
|
+
| ---------------- | ----------------------------------------------------------------- | ---------------------------------- |
|
|
20
|
+
| `filterChange` | Emitido quando há uma alteração nos filtros. | `CustomEvent<SnkFilterItemConfig>` |
|
|
21
|
+
| `visibleChanged` | Emitido quando o detalhe de um item da lista é aberto ou fechado. | `CustomEvent<boolean>` |
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
## Methods
|
|
25
|
+
|
|
26
|
+
### `hideDetail() => Promise<void>`
|
|
27
|
+
|
|
28
|
+
Oculta os detalhes de um item da lista.
|
|
29
|
+
|
|
30
|
+
#### Returns
|
|
31
|
+
|
|
32
|
+
Type: `Promise<void>`
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
### `showUp(open?: boolean) => Promise<void>`
|
|
37
|
+
|
|
38
|
+
Exibe os detalhes de um item da lista.
|
|
39
|
+
|
|
40
|
+
#### Returns
|
|
41
|
+
|
|
42
|
+
Type: `Promise<void>`
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
## Dependencies
|
|
48
|
+
|
|
49
|
+
### Used by
|
|
50
|
+
|
|
51
|
+
- [snk-filter-bar](..)
|
|
52
|
+
|
|
53
|
+
### Depends on
|
|
54
|
+
|
|
55
|
+
- [snk-filter-detail](.)
|
|
56
|
+
|
|
57
|
+
### Graph
|
|
58
|
+
```mermaid
|
|
59
|
+
graph TD;
|
|
60
|
+
snk-filter-item --> snk-filter-detail
|
|
61
|
+
snk-filter-bar --> snk-filter-item
|
|
62
|
+
style snk-filter-item fill:#f9f,stroke:#333,stroke-width:4px
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
----------------------------------------------
|
|
66
|
+
|
|
67
|
+
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# snk-filter-list
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ---------------- | ------------------ | ------------------------------------------------------------------------------------------------------ | -------------------------------------- | ----------- |
|
|
12
|
+
| `buttonClass` | `button-class` | Define a classe CSS a ser adicionada no botão (usado principalmente para sinalizar o filtro aplicado). | `string` | `undefined` |
|
|
13
|
+
| `emptyText` | `empty-text` | Define o texto exibido quando a lista está vazia. | `string` | `undefined` |
|
|
14
|
+
| `findFilterText` | `find-filter-text` | Define o texto exibido no componente de busca. | `string` | `undefined` |
|
|
15
|
+
| `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
|
|
16
|
+
| `iconName` | `icon-name` | Define o ícone usado no ez-button do filtro. | `string` | `undefined` |
|
|
17
|
+
| `items` | -- | Guarda a lista de filtros. | `ListItem[]` | `undefined` |
|
|
18
|
+
| `label` | `label` | Define o label usado no ez-button do filtro. | `string` | `undefined` |
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
## Events
|
|
22
|
+
|
|
23
|
+
| Event | Description | Type |
|
|
24
|
+
| ----------------- | -------------------------------------------- | --------------------- |
|
|
25
|
+
| `snkItemSelected` | Disparado quando um item da lista é clicado. | `CustomEvent<string>` |
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
## Methods
|
|
29
|
+
|
|
30
|
+
### `hideDetail() => Promise<void>`
|
|
31
|
+
|
|
32
|
+
Oculta os detalhes do componente snk-filter-list.
|
|
33
|
+
|
|
34
|
+
#### Returns
|
|
35
|
+
|
|
36
|
+
Type: `Promise<void>`
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
----------------------------------------------
|
|
42
|
+
|
|
43
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# snk-filter-modal
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
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
|
+
| `editPersonalizedFilter` | -- | Ação executada ao editart um filtro personalizado | `(id: string) => void` | `undefined` |
|
|
17
|
+
| `filters` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
|
|
18
|
+
| `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
## Dependencies
|
|
22
|
+
|
|
23
|
+
### Depends on
|
|
24
|
+
|
|
25
|
+
- [snk-filter-modal-item](subcomponents)
|
|
26
|
+
|
|
27
|
+
### Graph
|
|
28
|
+
```mermaid
|
|
29
|
+
graph TD;
|
|
30
|
+
snk-filter-modal --> snk-filter-modal-item
|
|
31
|
+
style snk-filter-modal fill:#f9f,stroke:#333,stroke-width:4px
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
----------------------------------------------
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# snk-filter-modal-item
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------ | -------------- | ---------------------------------------------------------------------------- | --------------------- | ----------- |
|
|
12
|
+
| `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
|
|
13
|
+
| `filterItem` | -- | | `SnkFilterItemConfig` | `undefined` |
|
|
14
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
## Events
|
|
18
|
+
|
|
19
|
+
| Event | Description | Type |
|
|
20
|
+
| ------------------------ | ----------- | ---------------------------------- |
|
|
21
|
+
| `addPersonalizedFilter` | | `CustomEvent<void>` |
|
|
22
|
+
| `editPersonalizedFilter` | | `CustomEvent<string>` |
|
|
23
|
+
| `filterChange` | | `CustomEvent<SnkFilterItemConfig>` |
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
## Dependencies
|
|
27
|
+
|
|
28
|
+
### Used by
|
|
29
|
+
|
|
30
|
+
- [snk-filter-modal](..)
|
|
31
|
+
|
|
32
|
+
### Graph
|
|
33
|
+
```mermaid
|
|
34
|
+
graph TD;
|
|
35
|
+
snk-filter-modal --> snk-filter-modal-item
|
|
36
|
+
style snk-filter-modal-item fill:#f9f,stroke:#333,stroke-width:4px
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
----------------------------------------------
|
|
40
|
+
|
|
41
|
+
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# snk-filter-bar
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ----------- |
|
|
12
|
+
| `configName` | `config-name` | Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma. | `string` | `undefined` |
|
|
13
|
+
| `dataUnit` | -- | Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros. | `DataUnit` | `undefined` |
|
|
14
|
+
| `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
|
|
15
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
16
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## Methods
|
|
20
|
+
|
|
21
|
+
### `reload() => Promise<void>`
|
|
22
|
+
|
|
23
|
+
Faz o recarregamento da filterbar buscando o state no servidor.
|
|
24
|
+
|
|
25
|
+
#### Returns
|
|
26
|
+
|
|
27
|
+
Type: `Promise<void>`
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
## Dependencies
|
|
33
|
+
|
|
34
|
+
### Used by
|
|
35
|
+
|
|
36
|
+
- [snk-grid](../snk-grid)
|
|
37
|
+
|
|
38
|
+
### Depends on
|
|
39
|
+
|
|
40
|
+
- [snk-filter-item](filter-item)
|
|
41
|
+
- [snk-personalized-filter](../snk-personalized-filter)
|
|
42
|
+
|
|
43
|
+
### Graph
|
|
44
|
+
```mermaid
|
|
45
|
+
graph TD;
|
|
46
|
+
snk-filter-bar --> snk-filter-item
|
|
47
|
+
snk-filter-bar --> snk-personalized-filter
|
|
48
|
+
snk-filter-item --> snk-filter-detail
|
|
49
|
+
snk-personalized-filter --> snk-filter-field-search
|
|
50
|
+
snk-personalized-filter --> snk-filter-assistent-mode
|
|
51
|
+
snk-personalized-filter --> snk-filter-advanced-mode
|
|
52
|
+
snk-personalized-filter --> snk-simple-bar
|
|
53
|
+
snk-filter-assistent-mode --> snk-expression-group
|
|
54
|
+
snk-expression-group --> snk-expression-item
|
|
55
|
+
snk-expression-group --> snk-expression-group
|
|
56
|
+
snk-expression-item --> snk-filter-field-search
|
|
57
|
+
snk-expression-item --> snk-filter-param-config
|
|
58
|
+
snk-grid --> snk-filter-bar
|
|
59
|
+
style snk-filter-bar fill:#f9f,stroke:#333,stroke-width:4px
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
----------------------------------------------
|
|
63
|
+
|
|
64
|
+
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# snk-filter-field-search
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------------ | ------------ | ----------------------------------------------------------------------------------- | ------------------------ | ----------- |
|
|
12
|
+
| `fieldsDataSource` | -- | Define a fonte de dados que o componente vai utilizar para carregamento dos campos. | `FilterFieldsDataSource` | `undefined` |
|
|
13
|
+
| `searchable` | `searchable` | Define se o componente irá possuir um campo de pesquisa. | `boolean` | `true` |
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
## Events
|
|
17
|
+
|
|
18
|
+
| Event | Description | Type |
|
|
19
|
+
| -------------------- | --------------------------------------------------- | ------------------------------------------ |
|
|
20
|
+
| `ezSelectFilterItem` | Emitido sempre que um item da lista for selecionado | `CustomEvent<IFilterField \| IFilterLink>` |
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
## Methods
|
|
24
|
+
|
|
25
|
+
### `applyFilter(filterText: string) => Promise<void>`
|
|
26
|
+
|
|
27
|
+
Filtra a fonte de dados do componente.
|
|
28
|
+
|
|
29
|
+
#### Returns
|
|
30
|
+
|
|
31
|
+
Type: `Promise<void>`
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
### `show(element?: HTMLElement, options?: IEzPopoverAnchorOptions) => Promise<void>`
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
Realiza a abertura do componente abaixo do elemento HTML informado
|
|
39
|
+
e faz a primeira carga de dados.
|
|
40
|
+
|
|
41
|
+
#### Returns
|
|
42
|
+
|
|
43
|
+
Type: `Promise<void>`
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
## Dependencies
|
|
49
|
+
|
|
50
|
+
### Used by
|
|
51
|
+
|
|
52
|
+
- [snk-expression-item](../snk-personalized-filter/subcomponents/snk-expression-item)
|
|
53
|
+
- [snk-personalized-filter](../snk-personalized-filter)
|
|
54
|
+
|
|
55
|
+
### Graph
|
|
56
|
+
```mermaid
|
|
57
|
+
graph TD;
|
|
58
|
+
snk-expression-item --> snk-filter-field-search
|
|
59
|
+
snk-personalized-filter --> snk-filter-field-search
|
|
60
|
+
style snk-filter-field-search fill:#f9f,stroke:#333,stroke-width:4px
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
----------------------------------------------
|
|
64
|
+
|
|
65
|
+
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# snk-form
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------------ | -------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
|
|
12
|
+
| `configName` | `config-name` | Nome usado para guardar/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
|
+
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
|
15
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## Events
|
|
19
|
+
|
|
20
|
+
| Event | Description | Type |
|
|
21
|
+
| ---------------- | ------------------------------------------------------------------------------- | ---------------------------- |
|
|
22
|
+
| `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
|
23
|
+
| `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
|
|
24
|
+
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## Methods
|
|
28
|
+
|
|
29
|
+
### `hideConfig() => Promise<void>`
|
|
30
|
+
|
|
31
|
+
Fecha a janela de configurações do formulário.
|
|
32
|
+
|
|
33
|
+
#### Returns
|
|
34
|
+
|
|
35
|
+
Type: `Promise<void>`
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
### `showConfig() => Promise<void>`
|
|
40
|
+
|
|
41
|
+
Exibe a janela de configurações do formulário.
|
|
42
|
+
|
|
43
|
+
#### Returns
|
|
44
|
+
|
|
45
|
+
Type: `Promise<void>`
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
## Dependencies
|
|
51
|
+
|
|
52
|
+
### Depends on
|
|
53
|
+
|
|
54
|
+
- [snk-form-config](./subcomponents/snk-form-config)
|
|
55
|
+
|
|
56
|
+
### Graph
|
|
57
|
+
```mermaid
|
|
58
|
+
graph TD;
|
|
59
|
+
snk-form --> snk-form-config
|
|
60
|
+
snk-form-config --> snk-field-config
|
|
61
|
+
snk-form-config --> snk-config-options
|
|
62
|
+
snk-form-config --> snk-tab-config
|
|
63
|
+
style snk-form fill:#f9f,stroke:#333,stroke-width:4px
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
----------------------------------------------
|
|
67
|
+
|
|
68
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# ez-config-options
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
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` | -- | Armazena as propriedades do campo. | `IFieldConfig` | `{} as IFieldConfig` |
|
|
14
|
+
| `idConfig` | `id-config` | Armazena a chave de opções de configuração. | `string` | `undefined` |
|
|
15
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## Events
|
|
19
|
+
|
|
20
|
+
| Event | Description | Type |
|
|
21
|
+
| ---------------------- | ------------------------------------------------ | ------------------ |
|
|
22
|
+
| `configOptionsChanged` | Emitido ao realizar alguma alteração nos campos. | `CustomEvent<any>` |
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
## Dependencies
|
|
26
|
+
|
|
27
|
+
### Used by
|
|
28
|
+
|
|
29
|
+
- [snk-form-config](../snk-form-config)
|
|
30
|
+
|
|
31
|
+
### Graph
|
|
32
|
+
```mermaid
|
|
33
|
+
graph TD;
|
|
34
|
+
snk-form-config --> snk-config-options
|
|
35
|
+
style snk-config-options fill:#f9f,stroke:#333,stroke-width:4px
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
----------------------------------------------
|
|
39
|
+
|
|
40
|
+
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# ez-field-config
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------------- | ---------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
|
|
12
|
+
| `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
|
|
13
|
+
| `fieldConfig` | -- | Armazena as propriedades do campo. | `IFieldConfig` | `undefined` |
|
|
14
|
+
| `isConfigActive` | -- | Define se o popover de configuração está ativo. | `Boolean` | `false` |
|
|
15
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
16
|
+
| `modeInsertion` | `mode-insertion` | Define se o componente está em modo de inserção. | `boolean` | `true` |
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## Events
|
|
20
|
+
|
|
21
|
+
| Event | Description | Type |
|
|
22
|
+
| ------------- | ------------------------------------ | --------------------- |
|
|
23
|
+
| `ezClickIcon` | Emitido ao clicar no ícone do botão. | `CustomEvent<Object>` |
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
## Dependencies
|
|
27
|
+
|
|
28
|
+
### Used by
|
|
29
|
+
|
|
30
|
+
- [snk-form-config](../snk-form-config)
|
|
31
|
+
|
|
32
|
+
### Graph
|
|
33
|
+
```mermaid
|
|
34
|
+
graph TD;
|
|
35
|
+
snk-form-config --> snk-field-config
|
|
36
|
+
style snk-field-config fill:#f9f,stroke:#333,stroke-width:4px
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
----------------------------------------------
|
|
40
|
+
|
|
41
|
+
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# ez-form-config
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------------- | --------- | -------------------------------------------------------------------------------------- | ---------------------- | ----------- |
|
|
12
|
+
| `configManager` | -- | Campos de configuração de formulário. | `SnkFormConfigManager` | `undefined` |
|
|
13
|
+
| `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
|
|
14
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
## Events
|
|
18
|
+
|
|
19
|
+
| Event | Description | Type |
|
|
20
|
+
| -------------- | ----------------------------------- | -------------------------- |
|
|
21
|
+
| `configChange` | Emitido ao salvar as configurações. | `CustomEvent<IFormConfig>` |
|
|
22
|
+
| `configClose` | Emitido ao fechar as configurações. | `CustomEvent<void>` |
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
## Dependencies
|
|
26
|
+
|
|
27
|
+
### Used by
|
|
28
|
+
|
|
29
|
+
- [snk-form](../..)
|
|
30
|
+
- [snk-guides-viewer](../../../snk-crud/subcomponents)
|
|
31
|
+
|
|
32
|
+
### Depends on
|
|
33
|
+
|
|
34
|
+
- [snk-field-config](../snk-field-config)
|
|
35
|
+
- [snk-config-options](../snk-config-options)
|
|
36
|
+
- [snk-tab-config](../snk-tab-config)
|
|
37
|
+
|
|
38
|
+
### Graph
|
|
39
|
+
```mermaid
|
|
40
|
+
graph TD;
|
|
41
|
+
snk-form-config --> snk-field-config
|
|
42
|
+
snk-form-config --> snk-config-options
|
|
43
|
+
snk-form-config --> snk-tab-config
|
|
44
|
+
snk-form --> snk-form-config
|
|
45
|
+
snk-guides-viewer --> snk-form-config
|
|
46
|
+
style snk-form-config fill:#f9f,stroke:#333,stroke-width:4px
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
----------------------------------------------
|
|
50
|
+
|
|
51
|
+
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# ez-tab-config
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------------- | ---------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
|
|
12
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
13
|
+
| `selectedIndex` | `selected-index` | Define o index da aba selecionada. | `number` | `undefined` |
|
|
14
|
+
| `selectedTab` | `selected-tab` | Define a aba selecionada. | `string` | `undefined` |
|
|
15
|
+
| `tabItems` | -- | Define o nome das abas do componente separadas por vírgulas ",". | `ITab[]` | `undefined` |
|
|
16
|
+
| `tabs` | `tabs` | Define o nome das abas do componente separadas por vírgulas ",". | `string` | `undefined` |
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## Events
|
|
20
|
+
|
|
21
|
+
| Event | Description | Type |
|
|
22
|
+
| ----------------- | ----------------------------------------------------------- | --------------------- |
|
|
23
|
+
| `canStartDrag` | Emitido ao ocultar uma aba. | `CustomEvent<any>` |
|
|
24
|
+
| `deleteTab` | Emitido ao deletar uma aba. | `CustomEvent<any>` |
|
|
25
|
+
| `editionTitleTab` | Emitido ao salvar uma alteração realizada no título da tab. | `CustomEvent<any>` |
|
|
26
|
+
| `ezOrderChange` | Emitido ao mover a ordem da aba. | `CustomEvent<number>` |
|
|
27
|
+
| `ezTabChange` | Emitido ao clicar para abrir o popup. | `CustomEvent<ITab>` |
|
|
28
|
+
| `hideTab` | Emitido ao ocultar uma aba. | `CustomEvent<any>` |
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
## Dependencies
|
|
32
|
+
|
|
33
|
+
### Used by
|
|
34
|
+
|
|
35
|
+
- [snk-form-config](../snk-form-config)
|
|
36
|
+
|
|
37
|
+
### Graph
|
|
38
|
+
```mermaid
|
|
39
|
+
graph TD;
|
|
40
|
+
snk-form-config --> snk-tab-config
|
|
41
|
+
style snk-tab-config fill:#f9f,stroke:#333,stroke-width:4px
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
----------------------------------------------
|
|
45
|
+
|
|
46
|
+
|