@sankhyalabs/sankhyablocks-docs 8.15.0-rc.5 → 8.15.0-rc.6
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.
|
@@ -7,15 +7,16 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description | Type
|
|
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`
|
|
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`
|
|
14
|
-
| `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`
|
|
15
|
-
| `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]`
|
|
16
|
-
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder`
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
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
|
+
| `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` |
|
|
15
|
+
| `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
|
|
16
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
17
|
+
| `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
|
|
18
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
19
|
+
| `title` | `title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
|
|
19
20
|
|
|
20
21
|
|
|
21
22
|
## Events
|
|
@@ -67,6 +68,16 @@ Type: `Promise<SnkFilterItemConfig>`
|
|
|
67
68
|
|
|
68
69
|
- Retorna o item de filtro removido, ou undefined caso não encontrado.
|
|
69
70
|
|
|
71
|
+
### `showFilterModal() => Promise<void>`
|
|
72
|
+
|
|
73
|
+
Abre o modal de filtros
|
|
74
|
+
|
|
75
|
+
#### Returns
|
|
76
|
+
|
|
77
|
+
Type: `Promise<void>`
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
70
81
|
### `updateFilterItem(newFilterItem: SnkFilterItemConfig) => Promise<void>`
|
|
71
82
|
|
|
72
83
|
Atualiza um item do filtro.
|