@sankhyalabs/sankhyablocks-docs 5.19.0 → 6.0.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 +7 -0
  2. package/components/snk-crud/subcomponents/readme.md +7 -0
  3. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +7 -0
  4. package/components/snk-filter-bar/filter-item/editors/snk-filter-personalized/readme.md +43 -0
  5. package/components/snk-filter-bar/filter-modal/readme.md +10 -7
  6. package/components/snk-filter-bar/filter-modal/subcomponents/readme.md +9 -6
  7. package/components/snk-filter-bar/readme.md +8 -0
  8. package/components/snk-grid/readme.md +7 -0
  9. package/components/snk-personalized-filter/readme.md +38 -5
  10. package/components/snk-personalized-filter/subcomponents/snk-expression-group/readme.md +65 -0
  11. package/components/snk-personalized-filter/subcomponents/snk-expression-item/readme.md +8 -7
  12. package/components/snk-simple-bar/readme.md +2 -0
  13. package/package.json +1 -1
package/components/snk-crud/readme.md CHANGED
@@ -98,7 +98,14 @@ graph TD;
98
98
  snk-grid --> snk-data-exporter
99
99
  snk-grid --> snk-actions-button
100
100
  snk-filter-bar --> snk-filter-item
101
+ snk-filter-bar --> snk-personalized-filter
101
102
  snk-filter-item --> snk-filter-detail
103
+ snk-personalized-filter --> snk-simple-bar
104
+ snk-personalized-filter --> snk-expression-group
105
+ snk-expression-group --> snk-expression-item
106
+ snk-expression-group --> snk-expression-group
107
+ snk-expression-item --> snk-filter-field-search
108
+ snk-expression-item --> snk-filter-param-config
102
109
  snk-taskbar --> snk-data-exporter
103
110
  snk-taskbar --> snk-actions-button
104
111
  snk-data-exporter --> snk-exporter-email-sender
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -86,7 +86,14 @@ graph TD;
86
86
  snk-grid --> snk-data-exporter
87
87
  snk-grid --> snk-actions-button
88
88
  snk-filter-bar --> snk-filter-item
89
+ snk-filter-bar --> snk-personalized-filter
89
90
  snk-filter-item --> snk-filter-detail
91
+ snk-personalized-filter --> snk-simple-bar
92
+ snk-personalized-filter --> snk-expression-group
93
+ snk-expression-group --> snk-expression-item
94
+ snk-expression-group --> snk-expression-group
95
+ snk-expression-item --> snk-filter-field-search
96
+ snk-expression-item --> snk-filter-param-config
90
97
  snk-taskbar --> snk-data-exporter
91
98
  snk-taskbar --> snk-actions-button
92
99
  snk-data-exporter --> snk-exporter-email-sender
package/components/snk-crud/subcomponents/snk-detail-view/readme.md CHANGED
@@ -94,7 +94,14 @@ graph TD;
94
94
  snk-grid --> snk-data-exporter
95
95
  snk-grid --> snk-actions-button
96
96
  snk-filter-bar --> snk-filter-item
97
+ snk-filter-bar --> snk-personalized-filter
97
98
  snk-filter-item --> snk-filter-detail
99
+ snk-personalized-filter --> snk-simple-bar
100
+ snk-personalized-filter --> snk-expression-group
101
+ snk-expression-group --> snk-expression-item
102
+ snk-expression-group --> snk-expression-group
103
+ snk-expression-item --> snk-filter-field-search
104
+ snk-expression-item --> snk-filter-param-config
98
105
  snk-taskbar --> snk-data-exporter
99
106
  snk-taskbar --> snk-actions-button
100
107
  snk-data-exporter --> snk-exporter-email-sender
package/components/snk-filter-bar/filter-item/editors/snk-filter-personalized/readme.md ADDED
@@ -0,0 +1,43 @@
1
+ # snk-filter-personalized
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------ | ------------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------- | ------------------------- |
12
+ | `config` | -- | Configuração que define as opções e comportamento do componente. | `SnkFilterItemConfig` | `undefined` |
13
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
14
+ | `presentationMode` | `presentation-mode` | Controla o modo de apresentação do componente, que pode ser configurado como modal ou chip. | `EPresentationMode.CHIP \| EPresentationMode.MODAL` | `EPresentationMode.MODAL` |
15
+ | `value` | -- | Controla o valor do componente. | `(string \| number \| boolean \| Date \| IOption)[]` | `undefined` |
16
+
17
+
18
+ ## Events
19
+
20
+ | Event | Description | Type |
21
+ | -------------- | -------------------------------------------- | ---------------------------------- |
22
+ | `addFilter` | | `CustomEvent<void>` |
23
+ | `deleteFilter` | | `CustomEvent<IPersonalizedFilter>` |
24
+ | `editFilter` | | `CustomEvent<string>` |
25
+ | `valueChanged` | Emitido quando o valor do filtro é alterado. | `CustomEvent<any>` |
26
+
27
+
28
+ ## Methods
29
+
30
+ ### `show() => Promise<void>`
31
+
32
+ Apresenta o componente
33
+
34
+ #### Returns
35
+
36
+ Type: `Promise<void>`
37
+
38
+
39
+
40
+
41
+ ----------------------------------------------
42
+
43
+
package/components/snk-filter-bar/filter-modal/readme.md CHANGED
@@ -7,13 +7,16 @@
7
7
 
8
8
  ## Properties
9
9
 
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` |
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
+ | `clearAll` | -- | Ação executada ao limpar os filtros | `(configSnapshot: SnkFilterItemConfig[]) => SnkFilterItemConfig[]` | `undefined` |
15
+ | `closeModal` | -- | Ação disparada ao fechar o modal | `() => void` | `undefined` |
16
+ | `configName` | `config-name` | Nome da config para buscar no resourceId | `string` | `undefined` |
17
+ | `editPersonalizedFilter` | -- | Ação executada ao editart um filtro personalizado | `(id: string) => void` | `undefined` |
18
+ | `filters` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
19
+ | `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
17
20
 
18
21
 
19
22
  ## Dependencies
package/components/snk-filter-bar/filter-modal/subcomponents/readme.md CHANGED
@@ -7,16 +7,19 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------ | --------- | ----------- | --------------------- | ----------- |
12
- | `filterItem` | -- | | `SnkFilterItemConfig` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------ | ------------- | ---------------------------------------- | --------------------- | ----------- |
12
+ | `configName` | `config-name` | Nome da config para buscar no resourceId | `string` | `undefined` |
13
+ | `filterItem` | -- | | `SnkFilterItemConfig` | `undefined` |
13
14
 
14
15
 
15
16
  ## Events
16
17
 
17
- | Event | Description | Type |
18
- | -------------- | ----------- | ---------------------------------- |
19
- | `filterChange` | | `CustomEvent<SnkFilterItemConfig>` |
18
+ | Event | Description | Type |
19
+ | ------------------------ | ----------- | ---------------------------------- |
20
+ | `addPersonalizedFilter` | | `CustomEvent<void>` |
21
+ | `editPersonalizedFilter` | | `CustomEvent<string>` |
22
+ | `filterChange` | | `CustomEvent<SnkFilterItemConfig>` |
20
23
 
21
24
 
22
25
  ## Dependencies
package/components/snk-filter-bar/readme.md CHANGED
@@ -37,12 +37,20 @@ Type: `Promise<void>`
37
37
  ### Depends on
38
38
 
39
39
  - [snk-filter-item](filter-item)
40
+ - [snk-personalized-filter](../snk-personalized-filter)
40
41
 
41
42
  ### Graph
42
43
  ```mermaid
43
44
  graph TD;
44
45
  snk-filter-bar --> snk-filter-item
46
+ snk-filter-bar --> snk-personalized-filter
45
47
  snk-filter-item --> snk-filter-detail
48
+ snk-personalized-filter --> snk-simple-bar
49
+ snk-personalized-filter --> snk-expression-group
50
+ snk-expression-group --> snk-expression-item
51
+ snk-expression-group --> snk-expression-group
52
+ snk-expression-item --> snk-filter-field-search
53
+ snk-expression-item --> snk-filter-param-config
46
54
  snk-grid --> snk-filter-bar
47
55
  style snk-filter-bar fill:#f9f,stroke:#333,stroke-width:4px
48
56
  ```
package/components/snk-grid/readme.md CHANGED
@@ -94,7 +94,14 @@ graph TD;
94
94
  snk-grid --> snk-data-exporter
95
95
  snk-grid --> snk-actions-button
96
96
  snk-filter-bar --> snk-filter-item
97
+ snk-filter-bar --> snk-personalized-filter
97
98
  snk-filter-item --> snk-filter-detail
99
+ snk-personalized-filter --> snk-simple-bar
100
+ snk-personalized-filter --> snk-expression-group
101
+ snk-expression-group --> snk-expression-item
102
+ snk-expression-group --> snk-expression-group
103
+ snk-expression-item --> snk-filter-field-search
104
+ snk-expression-item --> snk-filter-param-config
98
105
  snk-taskbar --> snk-data-exporter
99
106
  snk-taskbar --> snk-actions-button
100
107
  snk-data-exporter --> snk-exporter-email-sender
package/components/snk-personalized-filter/readme.md CHANGED
@@ -7,23 +7,56 @@
7
7
 
8
8
  ## Properties
9
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` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | ------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
+ | `configName` | `config-name` | Nome da config para buscar no resourceId | `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
+
17
+
18
+ ## Events
19
+
20
+ | Event | Description | Type |
21
+ | ---------- | ----------- | --------------------- |
22
+ | `ezCancel` | | `CustomEvent<void>` |
23
+ | `ezSave` | | `CustomEvent<string>` |
24
+
25
+
26
+ ## Methods
27
+
28
+ ### `createPersonalizedFilter() => Promise<void>`
29
+
30
+
31
+
32
+ #### Returns
33
+
34
+ Type: `Promise<void>`
35
+
36
+
13
37
 
14
38
 
15
39
  ## Dependencies
16
40
 
41
+ ### Used by
42
+
43
+ - [snk-filter-bar](../snk-filter-bar)
44
+
17
45
  ### Depends on
18
46
 
19
- - [snk-expression-item](./subcomponents/snk-expression-item)
47
+ - [snk-simple-bar](../snk-simple-bar)
48
+ - [snk-expression-group](./subcomponents/snk-expression-group)
20
49
 
21
50
  ### Graph
22
51
  ```mermaid
23
52
  graph TD;
24
- snk-personalized-filter --> snk-expression-item
53
+ snk-personalized-filter --> snk-simple-bar
54
+ snk-personalized-filter --> snk-expression-group
55
+ snk-expression-group --> snk-expression-item
56
+ snk-expression-group --> snk-expression-group
25
57
  snk-expression-item --> snk-filter-field-search
26
58
  snk-expression-item --> snk-filter-param-config
59
+ snk-filter-bar --> snk-personalized-filter
27
60
  style snk-personalized-filter fill:#f9f,stroke:#333,stroke-width:4px
28
61
  ```
29
62
 
package/components/snk-personalized-filter/subcomponents/snk-expression-group/readme.md ADDED
@@ -0,0 +1,65 @@
1
+ # snk-expression-group
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
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` |
17
+
18
+
19
+ ## Events
20
+
21
+ | Event | Description | Type |
22
+ | --------------------------- | ----------------------------------------------------- | ------------------------------- |
23
+ | `ezExpressionLayoutChanged` | Emitido ao alterar quantidade de grupos ou expressões | `CustomEvent<null>` |
24
+ | `ezFilterGroupChange` | Emitido quando ocorrer alterações no grupo. | `CustomEvent<IExpressionGroup>` |
25
+ | `ezFilterGroupRemove` | Emitido ao pressionar o botão de remover grupo. | `CustomEvent<IExpressionGroup>` |
26
+
27
+
28
+ ## Methods
29
+
30
+ ### `getExpressionGroup() => Promise<IExpressionGroup>`
31
+
32
+
33
+
34
+ #### Returns
35
+
36
+ Type: `Promise<IExpressionGroup>`
37
+
38
+
39
+
40
+
41
+ ## Dependencies
42
+
43
+ ### Used by
44
+
45
+ - [snk-expression-group](.)
46
+ - [snk-personalized-filter](../..)
47
+
48
+ ### Depends on
49
+
50
+ - [snk-expression-item](../snk-expression-item)
51
+ - [snk-expression-group](.)
52
+
53
+ ### Graph
54
+ ```mermaid
55
+ graph TD;
56
+ snk-expression-group --> snk-expression-group
57
+ snk-expression-item --> snk-filter-field-search
58
+ snk-expression-item --> snk-filter-param-config
59
+ snk-personalized-filter --> snk-expression-group
60
+ style snk-expression-group fill:#f9f,stroke:#333,stroke-width:4px
61
+ ```
62
+
63
+ ----------------------------------------------
64
+
65
+
package/components/snk-personalized-filter/subcomponents/snk-expression-item/readme.md CHANGED
@@ -7,11 +7,12 @@
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
- | `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` |
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` |
15
16
 
16
17
 
17
18
  ## Events
@@ -26,7 +27,7 @@
26
27
 
27
28
  ### Used by
28
29
 
29
- - [snk-personalized-filter](../..)
30
+ - [snk-expression-group](../snk-expression-group)
30
31
 
31
32
  ### Depends on
32
33
 
@@ -38,7 +39,7 @@
38
39
  graph TD;
39
40
  snk-expression-item --> snk-filter-field-search
40
41
  snk-expression-item --> snk-filter-param-config
41
- snk-personalized-filter --> snk-expression-item
42
+ snk-expression-group --> snk-expression-item
42
43
  style snk-expression-item fill:#f9f,stroke:#333,stroke-width:4px
43
44
  ```
44
45
 
package/components/snk-simple-bar/readme.md CHANGED
@@ -27,11 +27,13 @@
27
27
  ### Used by
28
28
 
29
29
  - [snk-attach](../snk-attach)
30
+ - [snk-personalized-filter](../snk-personalized-filter)
30
31
 
31
32
  ### Graph
32
33
  ```mermaid
33
34
  graph TD;
34
35
  snk-attach --> snk-simple-bar
36
+ snk-personalized-filter --> snk-simple-bar
35
37
  style snk-simple-bar fill:#f9f,stroke:#333,stroke-width:4px
36
38
  ```
37
39
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "5.19.0",
3
+ "version": "6.0.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [