@sankhyalabs/sankhyablocks-docs 8.16.0-dev.113 → 8.16.0-dev.114

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 (7) hide show
  1. package/components/snk-filter-bar/filter-modal/readme.md +15 -12
  2. package/components/snk-filter-bar/filter-modal/subcomponents/snk-default-filter/readme.md +38 -0
  3. package/components/snk-personalized-filter/readme.md +8 -7
  4. package/components/snk-personalized-filter/subcomponents/snk-expression-group/readme.md +8 -7
  5. package/components/snk-personalized-filter/subcomponents/snk-expression-item/readme.md +7 -6
  6. package/components/snk-personalized-filter/subcomponents/snk-filter-assistent-mode/readme.md +8 -7
  7. package/package.json +1 -1
package/components/snk-filter-bar/filter-modal/readme.md CHANGED
@@ -7,18 +7,19 @@
7
7
 
8
8
  ## Properties
9
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
- | `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` | `undefined` |
18
- | `editPersonalizedFilter` | -- | Ação executada ao editar um filtro personalizado | `(id: string) => void` | `undefined` |
19
- | `filters` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
20
- | `filtersToDelete` | -- | Guarda filtros a serem deletados no Apply do modal | `IPersonalizedFilter[]` | `[]` |
21
- | `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
+ | `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
 
package/components/snk-filter-bar/filter-modal/subcomponents/snk-default-filter/readme.md ADDED
@@ -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
+
package/components/snk-personalized-filter/readme.md CHANGED
@@ -7,13 +7,14 @@
7
7
 
8
8
  ## Properties
9
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
- | `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
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
16
- | `resourceID` | `resource-i-d` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
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
+ | `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
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
+ | `resourceID` | `resource-i-d` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
17
18
 
18
19
 
19
20
  ## Events
package/components/snk-personalized-filter/subcomponents/snk-expression-group/readme.md CHANGED
@@ -7,13 +7,14 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | -------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `entityURI` | `entity-u-r-i` | Identificador da unidade de dados. | `string` | `undefined` |
13
- | `filterId` | `filter-id` | Id do filtro que será carregado. | `string` | `undefined` |
14
- | `group` | -- | Grupo que será representado visualmente pelo componente. | `IExpressionGroup` | `undefined` |
15
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
16
- | `parentTop` | `parent-top` | Tamanho do elemento pai do grupo | `number` | `0` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | ------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
+ | `entityURI` | `entity-u-r-i` | Identificador da unidade de dados. | `string` | `undefined` |
13
+ | `filterId` | `filter-id` | Id do filtro que será carregado. | `string` | `undefined` |
14
+ | `group` | -- | Grupo que será representado visualmente pelo componente. | `IExpressionGroup` | `undefined` |
15
+ | `isDefaultFilter` | `is-default-filter` | Define se o filtro em questão é um filtro padrão. | `boolean` | `false` |
16
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
+ | `parentTop` | `parent-top` | Tamanho do elemento pai do grupo | `number` | `0` |
17
18
 
18
19
 
19
20
  ## Events
package/components/snk-personalized-filter/subcomponents/snk-expression-item/readme.md CHANGED
@@ -7,12 +7,13 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | -------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `canRemove` | `can-remove` | Controla a exibição do botão Remover. | `boolean` | `true` |
13
- | `entityURI` | `entity-u-r-i` | Identificador da unidade de dados. | `string` | `undefined` |
14
- | `expression` | -- | Expressão que será representada visualmente. | `IExpressionItem` | `undefined` |
15
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | ------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
+ | `canRemove` | `can-remove` | Controla a exibição do botão Remover. | `boolean` | `true` |
13
+ | `entityURI` | `entity-u-r-i` | Identificador da unidade de dados. | `string` | `undefined` |
14
+ | `expression` | -- | Expressão que será representada visualmente. | `IExpressionItem` | `undefined` |
15
+ | `isDefaultFilter` | `is-default-filter` | Define se o filtro em questão é um filtro padrão. | `boolean` | `false` |
16
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
16
17
 
17
18
 
18
19
  ## Events
package/components/snk-personalized-filter/subcomponents/snk-filter-assistent-mode/readme.md CHANGED
@@ -7,13 +7,14 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | ------------ | -------------------------------------------------------------------------------------- | --------------------- | ----------- |
12
- | `application` | -- | Propriedade que mantém informações relacionadas ao SnkApplication. | `SnkApplication` | `undefined` |
13
- | `entityUri` | `entity-uri` | Responsável por receber a URI da entidade. | `string` | `undefined` |
14
- | `filterAssistent` | -- | Propriedade que contém informações do filtro personalizado. | `IPersonalizedFilter` | `undefined` |
15
- | `filterId` | `filter-id` | Id do filtro que será carregado. | `string` | `undefined` |
16
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | ------------------- | -------------------------------------------------------------------------------------- | --------------------- | ----------- |
12
+ | `application` | -- | Propriedade que mantém informações relacionadas ao SnkApplication. | `SnkApplication` | `undefined` |
13
+ | `entityUri` | `entity-uri` | Responsável por receber a URI da entidade. | `string` | `undefined` |
14
+ | `filterAssistent` | -- | Propriedade que contém informações do filtro personalizado. | `IPersonalizedFilter` | `undefined` |
15
+ | `filterId` | `filter-id` | Id do filtro que será carregado. | `string` | `undefined` |
16
+ | `isDefaultFilter` | `is-default-filter` | Define se o filtro em questão é um filtro padrão. | `boolean` | `false` |
17
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
18
 
18
19
 
19
20
  ## Events
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "8.16.0-dev.113",
3
+ "version": "8.16.0-dev.114",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [