@sankhyalabs/sankhyablocks-docs 9.2.0-dev.2 → 9.2.0-dev.20

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.
@@ -33,7 +33,7 @@
33
33
  | `dataUnitFieldsHidded` | Emitido quando há campos no DataUnit que devem ser ocultados. | `CustomEvent<void>` |
34
34
  | `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
35
35
  | `insertionMode` | Emitido quando um registro é adicionado ou copiado. | `CustomEvent<void>` |
36
- | `messagesBuilderUpdated` | Emitido quando o DataUnit está pronto. | `CustomEvent<SnkMessageBuilder>` |
36
+ | `messagesBuilderUpdated` | Emitido quando o messagesBuilder é atualizado. | `CustomEvent<SnkMessageBuilder>` |
37
37
 
38
38
 
39
39
  ## Methods
@@ -46,7 +46,9 @@ Obtém o dataUnit.
46
46
 
47
47
  Type: `Promise<DataUnit>`
48
48
 
49
+ Uma promessa que resolve com a instância do DataUnit.
49
50
 
51
+ ---
50
52
 
51
53
  ### `getFieldsWithRmPrecision() => Promise<string[]>`
52
54
 
@@ -56,7 +58,9 @@ Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precisi
56
58
 
57
59
  Type: `Promise<string[]>`
58
60
 
61
+ Uma promessa que resolve com um array de nomes de campos.
59
62
 
63
+ ---
60
64
 
61
65
  ### `getFieldsWithRmp() => Promise<string[]>`
62
66
 
@@ -66,7 +70,9 @@ Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
66
70
 
67
71
  Type: `Promise<string[]>`
68
72
 
73
+ Uma promessa que resolve com um array de nomes de campos.
69
74
 
75
+ ---
70
76
 
71
77
  ### `getRowMetadata(record?: Record | string) => Promise<RowMetadata>`
72
78
 
@@ -76,7 +82,9 @@ Busca os metadados da linha selecionada.
76
82
 
77
83
  Type: `Promise<RowMetadata>`
78
84
 
85
+ Uma promessa que resolve com os metadados da linha.
79
86
 
87
+ ---
80
88
 
81
89
  ### `getSelectedRecordsIDsInfo() => Promise<Array<IRecordID>>`
82
90
 
@@ -86,7 +94,7 @@ Método que retorna a lista de IDs dos registros selecionados.
86
94
 
87
95
  Type: `Promise<IRecordID[]>`
88
96
 
89
- Retorna a lista de IDs dos registros selecionados.
97
+ Retorna uma promessa que resolve com a lista de IDs dos registros selecionados.
90
98
 
91
99
 
92
100
  ## Dependencies
@@ -10,6 +10,7 @@
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ---------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ----------- |
12
12
  | `config` | -- | Configurações para carregar os dados do componente | `SnkFilterItemConfig` | `undefined` |
13
+ | `errorMessage` | `error-message` | Usado para exibir mensagens de erro. | `string` | `undefined` |
13
14
  | `maxHeightList` | `max-height-list` | Permite definir uma altura máxima para o ez-list, adicionando um scroll ao atingir esta medida | `string` | `""` |
14
15
  | `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
16
  | `value` | -- | Define o valor do componente | `IOption` | `undefined` |
@@ -7,10 +7,11 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------- | --------- | ------------------------------------------------------ | --------------------- | ----------- |
12
- | `config` | -- | Define as configurações do componente snk-filter-text. | `SnkFilterItemConfig` | `undefined` |
13
- | `value` | `value` | Define o valor do componente snk-filter-text. | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------- | --------------- | ------------------------------------------------------ | --------------------- | ----------- |
12
+ | `config` | -- | Define as configurações do componente snk-filter-text. | `SnkFilterItemConfig` | `undefined` |
13
+ | `errorMessage` | `error-message` | Usado para exibir mensagens de erro. | `string` | `undefined` |
14
+ | `value` | `value` | Define o valor do componente snk-filter-text. | `string` | `undefined` |
14
15
 
15
16
 
16
17
  ## Events
@@ -20,6 +21,29 @@
20
21
  | `valueChanged` | Emitido quando o valor do filtro é alterado. | `CustomEvent<any>` |
21
22
 
22
23
 
24
+ ## Methods
25
+
26
+ ### `clearValue() => Promise<void>`
27
+
28
+ Limpa o valor do componente restaurando o valor original da configuração.
29
+
30
+ #### Returns
31
+
32
+ Type: `Promise<void>`
33
+
34
+ ---
35
+
36
+ ### `setFocus() => Promise<void>`
37
+
38
+ Define o foco no componente snk-filter-text.
39
+
40
+ #### Returns
41
+
42
+ Type: `Promise<void>`
43
+
44
+
45
+
46
+
23
47
  ----------------------------------------------
24
48
 
25
49
 
@@ -32,7 +32,7 @@ Oculta os detalhes de um item da lista.
32
32
 
33
33
  Type: `Promise<void>`
34
34
 
35
-
35
+ ---
36
36
 
37
37
  ### `showUp(open?: boolean) => Promise<void>`
38
38
 
@@ -7,23 +7,29 @@
7
7
 
8
8
  ## Properties
9
9
 
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` |
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
+ | `filterConfig` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
20
+ | `filterCustomConfigInterceptor` | -- | | `(config: SnkFilterItemConfig[]) => SnkFilterItemConfig[]` | `undefined` |
21
+ | `filterDefaultToDelete` | -- | Guarda o filtro a ser deletado no Apply do modal | `SnkFilterItemConfig` | `undefined` |
22
+ | `filtersToDelete` | -- | Guarda filtros a serem deletados no Apply do modal | `IPersonalizedFilter[]` | `[]` |
23
+ | `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
24
+ | `opened` | `opened` | Define se o modal está aberto ou não. | `boolean` | `false` |
23
25
 
24
26
 
25
27
  ## Dependencies
26
28
 
29
+ ### Used by
30
+
31
+ - [snk-filter-bar](..)
32
+
27
33
  ### Depends on
28
34
 
29
35
  - [snk-filter-modal-item](subcomponents)
@@ -34,6 +40,7 @@
34
40
  graph TD;
35
41
  snk-filter-modal --> snk-filter-modal-item
36
42
  snk-filter-modal --> snk-default-filter
43
+ snk-filter-bar --> snk-filter-modal
37
44
  style snk-filter-modal fill:#f9f,stroke:#333,stroke-width:4px
38
45
  ```
39
46
 
@@ -7,21 +7,23 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------------------ | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
12
- | `afterApplyConfig` | -- | Função chamada depois de aplicar os filtros. | `() => void` | `undefined` |
13
- | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
14
- | `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` |
15
- | `customFilterBarConfig` | -- | Loader customizado para carregar as configurações | `(configName: string, resourceId: string, options: any) => Promise<SnkFilterItemConfig[]>` | `undefined` |
16
- | `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` |
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
- | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento | `boolean` | `false` |
19
- | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
20
- | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
21
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
- | `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
23
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
24
- | `title` | `title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------------------- | ---------------------------------- | ----------- | ------------------------------------------------------------------------------------------ | ----------- |
12
+ | `afterApplyConfig` | -- | | `() => void` | `undefined` |
13
+ | `autoLoad` | `auto-load` | | `boolean` | `undefined` |
14
+ | `configName` | `config-name` | | `string` | `undefined` |
15
+ | `customFilterBarConfig` | -- | | `(configName: string, resourceId: string, options: any) => Promise<SnkFilterItemConfig[]>` | `undefined` |
16
+ | `dataUnit` | -- | | `DataUnit` | `undefined` |
17
+ | `disablePersonalizedFilter` | `disable-personalized-filter` | | `boolean` | `undefined` |
18
+ | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | | `boolean` | `false` |
19
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | | `string` | `undefined` |
20
+ | `filterConfig` | -- | | `SnkFilterItemConfig[]` | `undefined` |
21
+ | `filterCustomConfig` | -- | | `SnkFilterItemConfig[]` | `undefined` |
22
+ | `filterCustomConfigInterceptor` | -- | | `(config: SnkFilterItemConfig[]) => SnkFilterItemConfig[]` | `undefined` |
23
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
24
+ | `mode` | `mode` | | `"button" \| "hidden" \| "regular"` | `"regular"` |
25
+ | `resourceID` | `resource-i-d` | | `string` | `undefined` |
26
+ | `title` | `title` | | `string` | `undefined` |
25
27
 
26
28
 
27
29
  ## Events
@@ -35,63 +37,81 @@
35
37
 
36
38
  ### `addFilterItem(filterItem: SnkFilterItemConfig) => Promise<void>`
37
39
 
38
- Adiciona um item de filtro.
40
+
39
41
 
40
42
  #### Returns
41
43
 
42
44
  Type: `Promise<void>`
43
45
 
46
+ Retorna uma Promise que resolve quando o item for adicionado.
44
47
 
48
+ ---
45
49
 
46
50
  ### `getFilterItem(id: string) => Promise<SnkFilterItemConfig | undefined>`
47
51
 
48
- Retorna um item de filtro pelo ID.
52
+
49
53
 
50
54
  #### Returns
51
55
 
52
56
  Type: `Promise<SnkFilterItemConfig>`
53
57
 
58
+ O item de filtro correspondente ou undefined se não for encontrado.
59
+
60
+ ---
61
+
62
+ ### `getFilters() => Promise<Filter[]>`
63
+
64
+
65
+
66
+ #### Returns
67
+
68
+ Type: `Promise<Filter[]>`
54
69
 
70
+ ---
55
71
 
56
72
  ### `reload() => Promise<void>`
57
73
 
58
- Faz o recarregamento da filterbar buscando o state no servidor.
74
+
59
75
 
60
76
  #### Returns
61
77
 
62
78
  Type: `Promise<void>`
63
79
 
80
+ Retorna uma Promise que resolve quando o recarregamento for concluído.
64
81
 
82
+ ---
65
83
 
66
84
  ### `removeFilterItem(filterID: string) => Promise<SnkFilterItemConfig | undefined>`
67
85
 
68
- Remove um item de filtro.
86
+
69
87
 
70
88
  #### Returns
71
89
 
72
90
  Type: `Promise<SnkFilterItemConfig>`
73
91
 
74
- - Retorna o item de filtro removido, ou undefined caso não encontrado.
92
+ Retorna o item de filtro removido, ou undefined caso não seja encontrado.
93
+
94
+ ---
75
95
 
76
96
  ### `showFilterModal() => Promise<void>`
77
97
 
78
- Abre o modal de filtros
98
+
79
99
 
80
100
  #### Returns
81
101
 
82
102
  Type: `Promise<void>`
83
103
 
84
-
104
+ ---
85
105
 
86
106
  ### `updateFilterItem(newFilterItem: SnkFilterItemConfig) => Promise<void>`
87
107
 
88
- Atualiza um item do filtro.
108
+
89
109
 
90
110
  #### Returns
91
111
 
92
112
  Type: `Promise<void>`
93
113
 
94
-
114
+ Retorna uma Promise que resolve quando a atualização for concluída.
95
115
 
96
116
 
97
117
  ## Dependencies
@@ -104,12 +124,14 @@ Type: `Promise<void>`
104
124
 
105
125
  - [snk-filter-item](filter-item)
106
126
  - [snk-personalized-filter](../snk-personalized-filter)
127
+ - [snk-filter-modal](filter-modal)
107
128
 
108
129
  ### Graph
109
130
  ```mermaid
110
131
  graph TD;
111
132
  snk-filter-bar --> snk-filter-item
112
133
  snk-filter-bar --> snk-personalized-filter
134
+ snk-filter-bar --> snk-filter-modal
113
135
  snk-filter-item --> snk-filter-detail
114
136
  snk-personalized-filter --> snk-filter-field-search
115
137
  snk-personalized-filter --> snk-filter-assistent-mode
@@ -120,6 +142,8 @@ graph TD;
120
142
  snk-expression-group --> snk-expression-group
121
143
  snk-expression-item --> snk-filter-field-search
122
144
  snk-expression-item --> snk-filter-param-config
145
+ snk-filter-modal --> snk-filter-modal-item
146
+ snk-filter-modal --> snk-default-filter
123
147
  snk-grid --> snk-filter-bar
124
148
  style snk-filter-bar fill:#f9f,stroke:#333,stroke-width:4px
125
149
  ```
@@ -30,7 +30,7 @@ Filtra a fonte de dados do componente.
30
30
 
31
31
  Type: `Promise<void>`
32
32
 
33
-
33
+ ---
34
34
 
35
35
  ### `show(element?: HTMLElement, options?: IEzPopoverAnchorOptions) => Promise<void>`
36
36
 
@@ -10,7 +10,7 @@
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ---------------------- | ------------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
12
  | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
13
- | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
13
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legada do formulário. | `string` | `undefined` |
14
14
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
15
15
  | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
16
16
  | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
@@ -18,24 +18,24 @@
18
18
 
19
19
  ## Events
20
20
 
21
- | Event | Description | Type |
22
- | ---------------- | ------------------------------------------------------------------------------- | ---------------------------- |
23
- | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
24
- | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
25
- | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
21
+ | Event | Description | Type |
22
+ | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
23
+ | `actionClick` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente. | `CustomEvent<string>` |
24
+ | `exit` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente. | `CustomEvent<void>` |
25
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. OBS: Emitido no subcomponente snk-form-view | `CustomEvent<HTMLElement[]>` |
26
26
 
27
27
 
28
28
  ## Methods
29
29
 
30
30
  ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
31
31
 
32
- Registra um editor customizado para campos da grade e formulário.
32
+ Registra um editor customizado para campos do formulário.
33
33
 
34
34
  #### Returns
35
35
 
36
36
  Type: `Promise<void>`
37
37
 
38
-
38
+ ---
39
39
 
40
40
  ### `hideConfig() => Promise<void>`
41
41
 
@@ -45,7 +45,7 @@ Fecha a janela de configurações do formulário.
45
45
 
46
46
  Type: `Promise<void>`
47
47
 
48
-
48
+ ---
49
49
 
50
50
  ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
51
51
 
@@ -55,7 +55,7 @@ Altera/adiciona uma propriedade nos metadados do campo.
55
55
 
56
56
  Type: `Promise<void>`
57
57
 
58
-
58
+ ---
59
59
 
60
60
  ### `showConfig() => Promise<void>`
61
61
 
@@ -65,6 +65,16 @@ Exibe a janela de configurações do formulário.
65
65
 
66
66
  Type: `Promise<void>`
67
67
 
68
+ ---
69
+
70
+ ### `validate() => Promise<void>`
71
+
72
+ Valida o formulário.
73
+
74
+ #### Returns
75
+
76
+ Type: `Promise<void>`
77
+
68
78
 
69
79
 
70
80