@sankhyalabs/sankhyablocks-docs 5.5.0 → 5.7.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 (13) hide show
  1. package/components/snk-crud/readme.md +0 -2
  2. package/components/snk-crud/subcomponents/readme.md +0 -2
  3. package/components/snk-filter-bar/filter-item/editors/readme.md +7 -0
  4. package/components/snk-filter-bar/filter-list/readme.md +0 -13
  5. package/components/snk-filter-bar/filter-modal/readme.md +10 -14
  6. package/components/snk-filter-bar/filter-modal/subcomponents/readme.md +37 -0
  7. package/components/snk-filter-bar/readme.md +0 -4
  8. package/components/snk-filter-field-search/readme.md +21 -6
  9. package/components/snk-grid/readme.md +0 -2
  10. package/components/snk-personalized-filter/readme.md +32 -0
  11. package/components/snk-personalized-filter/subcomponents/snk-expression-item/readme.md +47 -0
  12. package/components/snk-personalized-filter/subcomponents/snk-filter-param-config/readme.md +13 -0
  13. package/package.json +1 -1
package/components/snk-crud/readme.md CHANGED
@@ -62,8 +62,6 @@ graph TD;
62
62
  snk-grid --> snk-grid-config
63
63
  snk-grid --> snk-data-exporter
64
64
  snk-filter-bar --> snk-filter-item
65
- snk-filter-bar --> snk-filter-modal
66
- snk-filter-bar --> snk-filter-list
67
65
  snk-filter-item --> snk-filter-detail
68
66
  snk-taskbar --> snk-data-exporter
69
67
  snk-data-exporter --> snk-exporter-email-sender
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -81,8 +81,6 @@ graph TD;
81
81
  snk-grid --> snk-grid-config
82
82
  snk-grid --> snk-data-exporter
83
83
  snk-filter-bar --> snk-filter-item
84
- snk-filter-bar --> snk-filter-modal
85
- snk-filter-bar --> snk-filter-list
86
84
  snk-filter-item --> snk-filter-detail
87
85
  snk-taskbar --> snk-data-exporter
88
86
  snk-data-exporter --> snk-exporter-email-sender
package/components/snk-filter-bar/filter-item/editors/readme.md CHANGED
@@ -13,6 +13,13 @@
13
13
  | `value` | `value` | Define o valor do componente snk-filter-text. | `string` | `undefined` |
14
14
 
15
15
 
16
+ ## Events
17
+
18
+ | Event | Description | Type |
19
+ | -------------- | -------------------------------------------- | ------------------ |
20
+ | `valueChanged` | Emitido quando o valor do filtro é alterado. | `CustomEvent<any>` |
21
+
22
+
16
23
  ----------------------------------------------
17
24
 
18
25
 
package/components/snk-filter-bar/filter-list/readme.md CHANGED
@@ -38,19 +38,6 @@ Type: `Promise<void>`
38
38
 
39
39
 
40
40
 
41
- ## Dependencies
42
-
43
- ### Used by
44
-
45
- - [snk-filter-bar](..)
46
-
47
- ### Graph
48
- ```mermaid
49
- graph TD;
50
- snk-filter-bar --> snk-filter-list
51
- style snk-filter-list fill:#f9f,stroke:#333,stroke-width:4px
52
- ```
53
-
54
41
  ----------------------------------------------
55
42
 
56
43
 
package/components/snk-filter-bar/filter-modal/readme.md CHANGED
@@ -7,29 +7,25 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------------------- | --------------------- | --------------------------------------------------------------------------------- | -------------------------------------- | ----------- |
12
- | `cancelButtonLabel` | `cancel-button-label` | Define o label do botão de cancelar. | `string` | `undefined` |
13
- | `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
14
- | `infoText` | `info-text` | Define a descrição do filtro. | `string` | `undefined` |
15
- | `items` | -- | Guarda a lista de filtros. | `ModalItem[]` | `undefined` |
16
- | `modalSubTitle` | `modal-sub-title` | Define o subtítulo do filtro. | `string` | `undefined` |
17
- | `modalTitle` | `modal-title` | Define o título do filtro. | `string` | `undefined` |
18
- | `okButtonLabel` | `ok-button-label` | Define o label do botão de confirmar. | `string` | `undefined` |
19
- | `processModalAction` | -- | É disparado em qualquer interação com o filtro. | `(action: ModalAction) => void` | `undefined` |
20
- | `useSearch` | `use-search` | Se `true`, exibe a barra de pesquisa do filtro. | `boolean` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------- | --------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------ | ----------- |
12
+ | `applyFilters` | -- | Ação executada ao aplicar os filtros | `(updatedFilterConfig: SnkFilterItemConfig[]) => void` | `undefined` |
13
+ | `clearAll` | -- | Ação executada ao limpar os filtros | `(configSnapshot: SnkFilterItemConfig[]) => SnkFilterItemConfig[]` | `undefined` |
14
+ | `closeModal` | -- | Ação disparada ao fechar o modal | `() => void` | `undefined` |
15
+ | `filters` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
16
+ | `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
21
17
 
22
18
 
23
19
  ## Dependencies
24
20
 
25
- ### Used by
21
+ ### Depends on
26
22
 
27
- - [snk-filter-bar](..)
23
+ - [snk-filter-modal-item](subcomponents)
28
24
 
29
25
  ### Graph
30
26
  ```mermaid
31
27
  graph TD;
32
- snk-filter-bar --> snk-filter-modal
28
+ snk-filter-modal --> snk-filter-modal-item
33
29
  style snk-filter-modal fill:#f9f,stroke:#333,stroke-width:4px
34
30
  ```
35
31
 
package/components/snk-filter-bar/filter-modal/subcomponents/readme.md ADDED
@@ -0,0 +1,37 @@
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
+ | `filterItem` | -- | | `SnkFilterItemConfig` | `undefined` |
13
+
14
+
15
+ ## Events
16
+
17
+ | Event | Description | Type |
18
+ | -------------- | ----------- | ---------------------------------- |
19
+ | `filterChange` | | `CustomEvent<SnkFilterItemConfig>` |
20
+
21
+
22
+ ## Dependencies
23
+
24
+ ### Used by
25
+
26
+ - [snk-filter-modal](..)
27
+
28
+ ### Graph
29
+ ```mermaid
30
+ graph TD;
31
+ snk-filter-modal --> snk-filter-modal-item
32
+ style snk-filter-modal-item fill:#f9f,stroke:#333,stroke-width:4px
33
+ ```
34
+
35
+ ----------------------------------------------
36
+
37
+
package/components/snk-filter-bar/readme.md CHANGED
@@ -24,15 +24,11 @@
24
24
  ### Depends on
25
25
 
26
26
  - [snk-filter-item](filter-item)
27
- - [snk-filter-modal](filter-modal)
28
- - [snk-filter-list](filter-list)
29
27
 
30
28
  ### Graph
31
29
  ```mermaid
32
30
  graph TD;
33
31
  snk-filter-bar --> snk-filter-item
34
- snk-filter-bar --> snk-filter-modal
35
- snk-filter-bar --> snk-filter-list
36
32
  snk-filter-item --> snk-filter-detail
37
33
  snk-grid --> snk-filter-bar
38
34
  style snk-filter-bar fill:#f9f,stroke:#333,stroke-width:4px
package/components/snk-filter-field-search/readme.md CHANGED
@@ -7,9 +7,10 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------ | ------------ | -------------------------------------------------------- | --------- | ------- |
12
- | `searchable` | `searchable` | Define se o componente irá possuir um campo de pesquisa. | `boolean` | `true` |
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` |
13
14
 
14
15
 
15
16
  ## Events
@@ -21,7 +22,7 @@
21
22
 
22
23
  ## Methods
23
24
 
24
- ### `filterDataSource(filterText: string) => Promise<void>`
25
+ ### `applyFilter(filterText: string) => Promise<void>`
25
26
 
26
27
  Filtra a fonte de dados do componente.
27
28
 
@@ -31,9 +32,10 @@ Type: `Promise<void>`
31
32
 
32
33
 
33
34
 
34
- ### `setDataSource(currentLink: IFilterLink, fetchData: DataFetcher) => Promise<void>`
35
+ ### `show() => Promise<void>`
35
36
 
36
- Define a fonte de dados do componente.
37
+ Realiza a abertura do componente e faz a primeira carga
38
+ de dados.
37
39
 
38
40
  #### Returns
39
41
 
@@ -42,6 +44,19 @@ Type: `Promise<void>`
42
44
 
43
45
 
44
46
 
47
+ ## Dependencies
48
+
49
+ ### Used by
50
+
51
+ - [snk-expression-item](../snk-personalized-filter/subcomponents/snk-expression-item)
52
+
53
+ ### Graph
54
+ ```mermaid
55
+ graph TD;
56
+ snk-expression-item --> snk-filter-field-search
57
+ style snk-filter-field-search fill:#f9f,stroke:#333,stroke-width:4px
58
+ ```
59
+
45
60
  ----------------------------------------------
46
61
 
47
62
 
package/components/snk-grid/readme.md CHANGED
@@ -82,8 +82,6 @@ graph TD;
82
82
  snk-grid --> snk-grid-config
83
83
  snk-grid --> snk-data-exporter
84
84
  snk-filter-bar --> snk-filter-item
85
- snk-filter-bar --> snk-filter-modal
86
- snk-filter-bar --> snk-filter-list
87
85
  snk-filter-item --> snk-filter-detail
88
86
  snk-taskbar --> snk-data-exporter
89
87
  snk-data-exporter --> snk-exporter-email-sender
package/components/snk-personalized-filter/readme.md ADDED
@@ -0,0 +1,32 @@
1
+ # snk-personalized-filter
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
+
14
+
15
+ ## Dependencies
16
+
17
+ ### Depends on
18
+
19
+ - [snk-expression-item](./subcomponents/snk-expression-item)
20
+
21
+ ### Graph
22
+ ```mermaid
23
+ graph TD;
24
+ snk-personalized-filter --> snk-expression-item
25
+ snk-expression-item --> snk-filter-field-search
26
+ snk-expression-item --> snk-filter-param-config
27
+ style snk-personalized-filter fill:#f9f,stroke:#333,stroke-width:4px
28
+ ```
29
+
30
+ ----------------------------------------------
31
+
32
+
package/components/snk-personalized-filter/subcomponents/snk-expression-item/readme.md ADDED
@@ -0,0 +1,47 @@
1
+ # snk-expression-item
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | ------------ | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
+ | `canRemove` | `can-remove` | Controla a exibição do botão Remover. | `boolean` | `true` |
13
+ | `expression` | -- | Expressão que será representada visualmente. | `IExpressionItem` | `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
+ | `ezFilterItemChange` | Emitido quando acontece alterações na expressão. | `CustomEvent<IExpressionItem>` |
22
+ | `ezFilterItemRemove` | Emitido ao confirmar uma remoção. | `CustomEvent<IExpressionItem>` |
23
+
24
+
25
+ ## Dependencies
26
+
27
+ ### Used by
28
+
29
+ - [snk-personalized-filter](../..)
30
+
31
+ ### Depends on
32
+
33
+ - [snk-filter-field-search](../../../snk-filter-field-search)
34
+ - [snk-filter-param-config](../snk-filter-param-config)
35
+
36
+ ### Graph
37
+ ```mermaid
38
+ graph TD;
39
+ snk-expression-item --> snk-filter-field-search
40
+ snk-expression-item --> snk-filter-param-config
41
+ snk-personalized-filter --> snk-expression-item
42
+ style snk-expression-item fill:#f9f,stroke:#333,stroke-width:4px
43
+ ```
44
+
45
+ ----------------------------------------------
46
+
47
+
package/components/snk-personalized-filter/subcomponents/snk-filter-param-config/readme.md CHANGED
@@ -35,6 +35,19 @@ Type: `Promise<IExpressionItem>`
35
35
 
36
36
 
37
37
 
38
+ ## Dependencies
39
+
40
+ ### Used by
41
+
42
+ - [snk-expression-item](../snk-expression-item)
43
+
44
+ ### Graph
45
+ ```mermaid
46
+ graph TD;
47
+ snk-expression-item --> snk-filter-param-config
48
+ style snk-filter-param-config fill:#f9f,stroke:#333,stroke-width:4px
49
+ ```
50
+
38
51
  ----------------------------------------------
39
52
 
40
53
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "5.5.0",
3
+ "version": "5.7.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [