@sankhyalabs/sankhyablocks-docs 6.4.2 → 6.6.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.
- package/components/snk-crud/readme.md +13 -12
- package/components/snk-crud/subcomponents/readme.md +1 -1
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +1 -1
- package/components/snk-filter-bar/filter-item/editors/{snk-filter-personalized → snk-personalized-filter-editor}/readme.md +1 -1
- package/components/snk-filter-bar/readme.md +1 -1
- package/components/snk-grid/readme.md +12 -11
- package/components/snk-personalized-filter/readme.md +2 -2
- package/package.json +1 -1
@@ -7,17 +7,18 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property
|
11
|
-
|
|
12
|
-
| `actionsList`
|
13
|
-
| `configName`
|
14
|
-
| `messagesBuilder`
|
15
|
-
| `multipleSelection`
|
16
|
-
| `presentationMode`
|
17
|
-
| `recordsValidator`
|
18
|
-
| `
|
19
|
-
| `
|
20
|
-
| `
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ---------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -------------------------- |
|
12
|
+
| `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
|
13
|
+
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
|
14
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
15
|
+
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
|
16
|
+
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `PresentationMode.PRIMARY` |
|
17
|
+
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
18
|
+
| `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
|
19
|
+
| `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
|
20
|
+
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
|
21
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
21
22
|
|
22
23
|
|
23
24
|
## Events
|
@@ -100,8 +101,8 @@ graph TD;
|
|
100
101
|
snk-filter-bar --> snk-filter-item
|
101
102
|
snk-filter-bar --> snk-personalized-filter
|
102
103
|
snk-filter-item --> snk-filter-detail
|
103
|
-
snk-personalized-filter --> snk-simple-bar
|
104
104
|
snk-personalized-filter --> snk-expression-group
|
105
|
+
snk-personalized-filter --> snk-simple-bar
|
105
106
|
snk-expression-group --> snk-expression-item
|
106
107
|
snk-expression-group --> snk-expression-group
|
107
108
|
snk-expression-item --> snk-filter-field-search
|
@@ -88,8 +88,8 @@ graph TD;
|
|
88
88
|
snk-filter-bar --> snk-filter-item
|
89
89
|
snk-filter-bar --> snk-personalized-filter
|
90
90
|
snk-filter-item --> snk-filter-detail
|
91
|
-
snk-personalized-filter --> snk-simple-bar
|
92
91
|
snk-personalized-filter --> snk-expression-group
|
92
|
+
snk-personalized-filter --> snk-simple-bar
|
93
93
|
snk-expression-group --> snk-expression-item
|
94
94
|
snk-expression-group --> snk-expression-group
|
95
95
|
snk-expression-item --> snk-filter-field-search
|
@@ -96,8 +96,8 @@ graph TD;
|
|
96
96
|
snk-filter-bar --> snk-filter-item
|
97
97
|
snk-filter-bar --> snk-personalized-filter
|
98
98
|
snk-filter-item --> snk-filter-detail
|
99
|
-
snk-personalized-filter --> snk-simple-bar
|
100
99
|
snk-personalized-filter --> snk-expression-group
|
100
|
+
snk-personalized-filter --> snk-simple-bar
|
101
101
|
snk-expression-group --> snk-expression-item
|
102
102
|
snk-expression-group --> snk-expression-group
|
103
103
|
snk-expression-item --> snk-filter-field-search
|
@@ -45,8 +45,8 @@ graph TD;
|
|
45
45
|
snk-filter-bar --> snk-filter-item
|
46
46
|
snk-filter-bar --> snk-personalized-filter
|
47
47
|
snk-filter-item --> snk-filter-detail
|
48
|
-
snk-personalized-filter --> snk-simple-bar
|
49
48
|
snk-personalized-filter --> snk-expression-group
|
49
|
+
snk-personalized-filter --> snk-simple-bar
|
50
50
|
snk-expression-group --> snk-expression-item
|
51
51
|
snk-expression-group --> snk-expression-group
|
52
52
|
snk-expression-item --> snk-filter-field-search
|
@@ -7,16 +7,17 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property
|
11
|
-
|
|
12
|
-
| `actionsList`
|
13
|
-
| `configName`
|
14
|
-
| `isDetail`
|
15
|
-
| `messagesBuilder`
|
16
|
-
| `multipleSelection`
|
17
|
-
| `presentationMode`
|
18
|
-
| `
|
19
|
-
| `
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ---------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -------------------------- |
|
12
|
+
| `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
|
13
|
+
| `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
|
14
|
+
| `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
|
15
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
16
|
+
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
|
17
|
+
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `PresentationMode.PRIMARY` |
|
18
|
+
| `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
|
19
|
+
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
|
20
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
20
21
|
|
21
22
|
|
22
23
|
## Events
|
@@ -96,8 +97,8 @@ graph TD;
|
|
96
97
|
snk-filter-bar --> snk-filter-item
|
97
98
|
snk-filter-bar --> snk-personalized-filter
|
98
99
|
snk-filter-item --> snk-filter-detail
|
99
|
-
snk-personalized-filter --> snk-simple-bar
|
100
100
|
snk-personalized-filter --> snk-expression-group
|
101
|
+
snk-personalized-filter --> snk-simple-bar
|
101
102
|
snk-expression-group --> snk-expression-item
|
102
103
|
snk-expression-group --> snk-expression-group
|
103
104
|
snk-expression-item --> snk-filter-field-search
|
@@ -44,14 +44,14 @@ Type: `Promise<void>`
|
|
44
44
|
|
45
45
|
### Depends on
|
46
46
|
|
47
|
-
- [snk-simple-bar](../snk-simple-bar)
|
48
47
|
- [snk-expression-group](./subcomponents/snk-expression-group)
|
48
|
+
- [snk-simple-bar](../snk-simple-bar)
|
49
49
|
|
50
50
|
### Graph
|
51
51
|
```mermaid
|
52
52
|
graph TD;
|
53
|
-
snk-personalized-filter --> snk-simple-bar
|
54
53
|
snk-personalized-filter --> snk-expression-group
|
54
|
+
snk-personalized-filter --> snk-simple-bar
|
55
55
|
snk-expression-group --> snk-expression-item
|
56
56
|
snk-expression-group --> snk-expression-group
|
57
57
|
snk-expression-item --> snk-filter-field-search
|