@sankhyalabs/sankhyablocks-docs 0.0.0-hotfix-ga-kb-107385.0 → 0.0.0-hotfix-ga-kb-107962.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.
Files changed (4) hide show
  1. package/components/snk-filter-bar/readme.md +29 -23
  2. package/components/snk-personalized-filter/readme.md +11 -11
  3. package/components/snk-pesquisa/readme.md +9 -9
  4. package/package.json +1 -1
package/components/snk-filter-bar/readme.md CHANGED
@@ -7,21 +7,21 @@
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
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
22
+ | `mode` | `mode` | | `"button" \| "hidden" \| "regular"` | `"regular"` |
23
+ | `resourceID` | `resource-i-d` | | `string` | `undefined` |
24
+ | `title` | `title` | | `string` | `undefined` |
25
25
 
26
26
 
27
27
  ## Events
@@ -35,49 +35,55 @@
35
35
 
36
36
  ### `addFilterItem(filterItem: SnkFilterItemConfig) => Promise<void>`
37
37
 
38
- Adiciona um item de filtro.
38
+
39
39
 
40
40
  #### Returns
41
41
 
42
42
  Type: `Promise<void>`
43
43
 
44
+ Retorna uma Promise que resolve quando o item for adicionado.
45
+
44
46
  ---
45
47
 
46
48
  ### `getFilterItem(id: string) => Promise<SnkFilterItemConfig | undefined>`
47
49
 
48
- Retorna um item de filtro pelo ID.
50
+
49
51
 
50
52
  #### Returns
51
53
 
52
54
  Type: `Promise<SnkFilterItemConfig>`
53
55
 
56
+ O item de filtro correspondente ou undefined se não for encontrado.
57
+
54
58
  ---
55
59
 
56
60
  ### `reload() => Promise<void>`
57
61
 
58
- Faz o recarregamento da filterbar buscando o state no servidor.
62
+
59
63
 
60
64
  #### Returns
61
65
 
62
66
  Type: `Promise<void>`
63
67
 
68
+ Retorna uma Promise que resolve quando o recarregamento for concluído.
69
+
64
70
  ---
65
71
 
66
72
  ### `removeFilterItem(filterID: string) => Promise<SnkFilterItemConfig | undefined>`
67
73
 
68
- Remove um item de filtro.
74
+
69
75
 
70
76
  #### Returns
71
77
 
72
78
  Type: `Promise<SnkFilterItemConfig>`
73
79
 
74
- - Retorna o item de filtro removido, ou undefined caso não encontrado.
80
+ Retorna o item de filtro removido, ou undefined caso não seja encontrado.
75
81
 
76
82
  ---
77
83
 
78
84
  ### `showFilterModal() => Promise<void>`
79
85
 
80
- Abre o modal de filtros
86
+
81
87
 
82
88
  #### Returns
83
89
 
@@ -87,13 +93,13 @@ Type: `Promise<void>`
87
93
 
88
94
  ### `updateFilterItem(newFilterItem: SnkFilterItemConfig) => Promise<void>`
89
95
 
90
- Atualiza um item do filtro.
96
+
91
97
 
92
98
  #### Returns
93
99
 
94
100
  Type: `Promise<void>`
95
101
 
96
-
102
+ Retorna uma Promise que resolve quando a atualização for concluída.
97
103
 
98
104
 
99
105
  ## Dependencies
package/components/snk-personalized-filter/readme.md CHANGED
@@ -9,28 +9,28 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ----------------- | ------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `configName` | `config-name` | Nome da configuração, utilizado para distinguir múltiplas instâncias do componente. | `string` | `undefined` |
13
- | `entityUri` | `entity-uri` | URI da entidade utilizada para buscar os campos disponíveis para filtro. | `string` | `undefined` |
14
- | `filterId` | `filter-id` | Identificador do filtro a ser carregado. | `string` | `undefined` |
15
- | `isDefaultFilter` | `is-default-filter` | Indica se o filtro é o filtro padrão do sistema. | `boolean` | `false` |
12
+ | `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
13
+ | `entityUri` | `entity-uri` | Responsável por receber a URI da entidade. | `string` | `undefined` |
14
+ | `filterId` | `filter-id` | Id do filtro que será carregado. | `string` | `undefined` |
15
+ | `isDefaultFilter` | `is-default-filter` | Define se o filtro em questão é um filtro padrão. | `boolean` | `false` |
16
16
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
- | `resourceID` | `resource-i-d` | Identificador do recurso utilizado para salvar e recuperar filtros. | `string` | `undefined` |
17
+ | `resourceID` | `resource-i-d` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
18
18
 
19
19
 
20
20
  ## Events
21
21
 
22
- | Event | Description | Type |
23
- | ------------- | ----------------------------------------------------------------- | --------------------- |
24
- | `ezAfterSave` | Evento emitido após salvar as alterações do filtro personalizado. | `CustomEvent<void>` |
25
- | `ezCancel` | Evento emitido ao cancelar a personalização do filtro. | `CustomEvent<void>` |
26
- | `ezSave` | Evento emitido ao salvar as alterações do filtro personalizado. | `CustomEvent<string>` |
22
+ | Event | Description | Type |
23
+ | ------------- | ----------- | --------------------- |
24
+ | `ezAfterSave` | | `CustomEvent<void>` |
25
+ | `ezCancel` | | `CustomEvent<void>` |
26
+ | `ezSave` | | `CustomEvent<string>` |
27
27
 
28
28
 
29
29
  ## Methods
30
30
 
31
31
  ### `createPersonalizedFilter() => Promise<void>`
32
32
 
33
- Cria um novo filtro personalizado caso não exista nenhum.
33
+
34
34
 
35
35
  #### Returns
36
36
 
package/components/snk-pesquisa/readme.md CHANGED
@@ -7,15 +7,15 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------- | --------------------- | ------------------------------------------------------------------- | -------------------------------- | ----------- |
12
- | `allowsNonAnalytic` | `allows-non-analytic` | Define se permite seleção de items não analíticos | `boolean` | `false` |
13
- | `argument` | `argument` | Argumentos que serão usados ao chamar a função searchLoader. | `string` | `undefined` |
14
- | `entityName` | `entity-name` | Nome da entidade onde a pesquisa é aplicada. | `string` | `undefined` |
15
- | `isHierarchyEntity` | `is-hierarchy-entity` | Define se a popup de pesquisa possuirá ou não modo Hierarquico. | `boolean` | `false` |
16
- | `searchLoader` | -- | Função responsável em carregar os itens do componente snk-pesquisa. | `(text: string) => Promise<any>` | `undefined` |
17
- | `selectItem` | -- | Função disparada ao selecionar um item. | `(option: IOption) => void` | `undefined` |
18
- | `treeLoader` | -- | Função responsável por carregar a árvore hierárquica do componente | `(text: string) => Promise<any>` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ----------- |
12
+ | `allowsNonAnalytic` | `allows-non-analytic` | Define se permite a seleção de itens não analíticos. | `boolean` | `false` |
13
+ | `argument` | `argument` | Argumento utilizado ao chamar a função searchLoader. Pode ser alterado externamente. | `string` | `undefined` |
14
+ | `entityName` | `entity-name` | Nome da entidade sobre a qual a pesquisa será realizada. | `string` | `undefined` |
15
+ | `isHierarchyEntity` | `is-hierarchy-entity` | Define se a popup de pesquisa terá ou não modo hierárquico. | `boolean` | `false` |
16
+ | `searchLoader` | -- | Função responsável em carregar os itens do componente snk-pesquisa. Deve retornar uma Promise com os dados encontrados. | `(text: string) => Promise<any>` | `undefined` |
17
+ | `selectItem` | -- | Função disparada ao selecionar um item da pesquisa. | `(option: IOption) => void` | `undefined` |
18
+ | `treeLoader` | -- | Função responsável por carregar a árvore hierárquica do componente. Opcional. Caso não seja fornecida, o modo árvore não estará disponível. | `(text: string) => Promise<any>` | `undefined` |
19
19
 
20
20
 
21
21
  ## Dependencies
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "0.0.0-hotfix-ga-kb-107385.0",
3
+ "version": "0.0.0-hotfix-ga-kb-107962.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [