@sankhyalabs/sankhyablocks-docs 9.2.0-ms.1 → 9.2.0-ms.10

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 (18) hide show
  1. package/components/snk-application/readme.md +92 -28
  2. package/components/snk-configurator/readme.md +1 -1
  3. package/components/snk-crud/readme.md +9 -9
  4. package/components/snk-crud/subcomponents/readme.md +4 -4
  5. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +4 -4
  6. package/components/snk-data-exporter/exporter-email-sender/readme.md +1 -1
  7. package/components/snk-data-unit/readme.md +10 -2
  8. package/components/snk-filter-bar/filter-item/readme.md +1 -1
  9. package/components/snk-filter-bar/readme.md +32 -24
  10. package/components/snk-filter-field-search/readme.md +1 -1
  11. package/components/snk-form/readme.md +20 -10
  12. package/components/snk-grid/readme.md +70 -51
  13. package/components/snk-personalized-filter/subcomponents/snk-filter-param-config/readme.md +1 -1
  14. package/components/snk-simple-bar/readme.md +6 -6
  15. package/components/snk-simple-crud/readme.md +11 -11
  16. package/components/snk-taskbar/elements/taskbar-actions-button/readme.md +2 -2
  17. package/components/snk-taskbar/readme.md +22 -22
  18. package/package.json +1 -1
package/components/snk-simple-crud/readme.md CHANGED
@@ -63,7 +63,7 @@ Registra um editor customizado para campos da grade e formulário.
63
63
 
64
64
  Type: `Promise<void>`
65
65
 
66
-
66
+ ---
67
67
 
68
68
  ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
69
69
 
@@ -73,7 +73,7 @@ Registra um formatador de valores para uma coluna da grid.
73
73
 
74
74
  Type: `Promise<void>`
75
75
 
76
-
76
+ ---
77
77
 
78
78
  ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
79
79
 
@@ -83,7 +83,7 @@ Registra um render customizado para colunas da grid.
83
83
 
84
84
  Type: `Promise<void>`
85
85
 
86
-
86
+ ---
87
87
 
88
88
  ### `closeConfigurator() => Promise<void>`
89
89
 
@@ -93,7 +93,7 @@ Usado para fechar o configurator do CRUD
93
93
 
94
94
  Type: `Promise<void>`
95
95
 
96
-
96
+ ---
97
97
 
98
98
  ### `getRecords() => Promise<Array<Record>>`
99
99
 
@@ -103,7 +103,7 @@ Type: `Promise<void>`
103
103
 
104
104
  Type: `Promise<Record[]>`
105
105
 
106
-
106
+ ---
107
107
 
108
108
  ### `goToView(view: VIEW_MODE) => Promise<void>`
109
109
 
@@ -113,7 +113,7 @@ Usado para alternar a visão entre GRID e FORM externamente.
113
113
 
114
114
  Type: `Promise<void>`
115
115
 
116
-
116
+ ---
117
117
 
118
118
  ### `openConfigurator() => Promise<void>`
119
119
 
@@ -123,7 +123,7 @@ Usado para abrir o configurator do CRUD
123
123
 
124
124
  Type: `Promise<void>`
125
125
 
126
-
126
+ ---
127
127
 
128
128
  ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
129
129
 
@@ -133,7 +133,7 @@ Remove o formatador de valores de uma coluna da grid.
133
133
 
134
134
  Type: `Promise<void>`
135
135
 
136
-
136
+ ---
137
137
 
138
138
  ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
139
139
 
@@ -143,7 +143,7 @@ Altera/adiciona uma propriedade nos metadados do campo.
143
143
 
144
144
  Type: `Promise<void>`
145
145
 
146
-
146
+ ---
147
147
 
148
148
  ### `setMetadata(metadata: UnitMetadata) => Promise<void>`
149
149
 
@@ -153,7 +153,7 @@ Type: `Promise<void>`
153
153
 
154
154
  Type: `Promise<void>`
155
155
 
156
-
156
+ ---
157
157
 
158
158
  ### `setRecords(records: Array<Record>) => Promise<void>`
159
159
 
@@ -163,7 +163,7 @@ Type: `Promise<void>`
163
163
 
164
164
  Type: `Promise<void>`
165
165
 
166
-
166
+ ---
167
167
 
168
168
  ### `updateConfig() => Promise<void>`
169
169
 
package/components/snk-taskbar/elements/taskbar-actions-button/readme.md CHANGED
@@ -33,7 +33,7 @@ Esaconde a lista de ações.
33
33
 
34
34
  Type: `Promise<void>`
35
35
 
36
-
36
+ ---
37
37
 
38
38
  ### `isOpened() => Promise<boolean>`
39
39
 
@@ -43,7 +43,7 @@ Informa se a lista de ações está aberta.
43
43
 
44
44
  Type: `Promise<boolean>`
45
45
 
46
-
46
+ ---
47
47
 
48
48
  ### `showActions() => Promise<void>`
49
49
 
package/components/snk-taskbar/readme.md CHANGED
@@ -7,32 +7,32 @@
7
7
 
8
8
  ## Properties
9
9
 
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
- | `actionsSettingsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
14
- | `alignRigth` | `align-rigth` | Usado para determinar O alinhamento dos items na taskbar. | `boolean` | `false` |
15
- | `buttons` | `buttons` | Lista separada por virgula, contendo todos os elementos a serem criados. | `string` | `undefined` |
16
- | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
17
- | `customButtons` | -- | Mapa com definição de botões personalizados. A chave do mapa deve ser passada na lista "buttons" no lugar onde o botão irá aparecer. | `Map<string, CustomButton>` | `undefined` |
18
- | `customContainerId` | `custom-container-id` | Usado para determinar o identificador do container na DOM que é responsavel por guardar os elementos personalizados que não podem ser passados por slot. Exemplo: Elementos customizados na Taskbar da aba de detalhes. | `string` | `undefined` |
19
- | `customSlotId` | `custom-slot-id` | Usado para determinar o identificador do slot que recebe elementos personalizados. | `string` | `"TASKBAR_CUSTOM_ELEMENTS"` |
20
- | `dataUnit` | -- | Instância do DataUnit. | `DataUnit` | `undefined` |
21
- | `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados. | `string[]` | `undefined` |
22
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
23
- | `overflowStrategy` | `overflow-strategy` | Define como será o comportamento da taskbar quando ocorrer overflow | `"hiddenItems" \| "none"` | `'hiddenItems'` |
24
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
25
- | `primaryButton` | `primary-button` | Determina qual botão deve ter aparência primária. | `string` | `undefined` |
26
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------------- | --------------------- | ----------- | ------------------------------------------------------------------------------------------- | --------------------------- |
12
+ | `actionsList` | -- | | `Action[]` | `undefined` |
13
+ | `actionsSettingsList` | -- | | `Action[]` | `undefined` |
14
+ | `alignRigth` | `align-rigth` | | `boolean` | `false` |
15
+ | `buttons` | `buttons` | | `string` | `undefined` |
16
+ | `configName` | `config-name` | | `string` | `undefined` |
17
+ | `customButtons` | -- | | `Map<string, CustomButton>` | `undefined` |
18
+ | `customContainerId` | `custom-container-id` | | `string` | `undefined` |
19
+ | `customSlotId` | `custom-slot-id` | | `string` | `"TASKBAR_CUSTOM_ELEMENTS"` |
20
+ | `dataUnit` | -- | | `DataUnit` | `undefined` |
21
+ | `disabledButtons` | -- | | `string[]` | `undefined` |
22
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
23
+ | `overflowStrategy` | `overflow-strategy` | | `"hiddenItems" \| "none"` | `'hiddenItems'` |
24
+ | `presentationMode` | `presentation-mode` | | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
25
+ | `primaryButton` | `primary-button` | | `string` | `undefined` |
26
+ | `resourceID` | `resource-i-d` | | `string` | `undefined` |
27
27
 
28
28
 
29
29
  ## Events
30
30
 
31
- | Event | Description | Type |
32
- | --------------------- | ------------------------------------------------------------ | --------------------- |
33
- | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
34
- | `taskbarSaveLocker` | Emitido sempre que um save é iniciado pela taskbar. | `CustomEvent<void>` |
35
- | `taskbarSaveUnlocker` | Emitido sempre que o ocorre alguma action que libera o save. | `CustomEvent<void>` |
31
+ | Event | Description | Type |
32
+ | --------------------- | ----------- | --------------------- |
33
+ | `actionClick` | | `CustomEvent<string>` |
34
+ | `taskbarSaveLocker` | | `CustomEvent<void>` |
35
+ | `taskbarSaveUnlocker` | | `CustomEvent<void>` |
36
36
 
37
37
 
38
38
  ## Dependencies
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "9.2.0-ms.1",
3
+ "version": "9.2.0-ms.10",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [