@sankhyalabs/sankhyablocks-docs 0.0.0-hotfix-rc-kb-79636.0 → 0.0.0-hotfix-ga-5603306.1

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 (12) hide show
  1. package/components/snk-application/readme.md +7 -18
  2. package/components/snk-attach/readme.md +1 -1
  3. package/components/snk-crud/readme.md +7 -65
  4. package/components/snk-crud/subcomponents/readme.md +1 -34
  5. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +1 -23
  6. package/components/snk-data-unit/readme.md +21 -53
  7. package/components/snk-filter-bar/readme.md +11 -14
  8. package/components/snk-form/readme.md +0 -20
  9. package/components/snk-form-config/readme.md +5 -6
  10. package/components/snk-grid/readme.md +0 -44
  11. package/components/snk-simple-crud/readme.md +2 -59
  12. package/package.json +1 -1
package/components/snk-application/readme.md CHANGED
@@ -7,13 +7,13 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | ----------- |
12
- | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
13
- | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
14
- | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
15
- | `loadByPK` | -- | Usado para receber um parâmetro na inicialização da tela, e utilizá-lo conforme necessário caso a tela receba um parâmetro, e, esta propriedade não seja informada é criado um filtro de forma automática através do método defaultLoadByPk | `(objPK: { pk: any; }, redirectFrom?: string) => void` | `undefined` |
16
- | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- |
12
+ | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
13
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
14
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
15
+ | `loadByPK` | -- | Usado para receber um parâmetro na inicialização da tela, e utilizá-lo conforme necessário caso a tela receba um parâmetro, e, esta propriedade não seja informada é criado um filtro de forma automática através do método defaultLoadByPk | `(objPK: { pk: Record<string, any>; }) => void` | `undefined` |
16
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
17
17
 
18
18
 
19
19
  ## Events
@@ -421,17 +421,6 @@ Type: `Promise<void>`
421
421
 
422
422
 
423
423
 
424
- ### `preloadMangerRemoveRecord(dataUnit: DataUnit, recordsIDs: Array<string>) => Promise<void>`
425
-
426
- Remove registro do cache do PreLoader do dataunit.
427
- Deve ser usado quando existe um dataunit usando loader do application, mas o removeLoader está sendo sobrescrito.
428
-
429
- #### Returns
430
-
431
- Type: `Promise<void>`
432
-
433
-
434
-
435
424
  ### `removeClientEvent(eventID: String) => Promise<void>`
436
425
 
437
426
  Remove um client event para o DataFetcher da aplicação.
package/components/snk-attach/readme.md CHANGED
@@ -42,8 +42,8 @@
42
42
  graph TD;
43
43
  snk-attach --> snk-simple-bar
44
44
  snk-attach --> snk-simple-crud
45
- snk-simple-crud --> snk-taskbar
46
45
  snk-simple-crud --> snk-data-unit
46
+ snk-simple-crud --> snk-taskbar
47
47
  snk-simple-crud --> snk-form-config
48
48
  snk-simple-crud --> snk-configurator
49
49
  snk-simple-crud --> snk-grid-config
package/components/snk-crud/readme.md CHANGED
@@ -10,24 +10,17 @@
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | --------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -------------------------- |
12
12
  | `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
13
- | `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
14
- | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
15
13
  | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
16
14
  | `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` |
17
- | `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
18
- | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
19
- | `enableLockManger` | `enable-lock-manger` | Ativa o gerenciamento de locks na grade. | `boolean` | `false` |
20
15
  | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
21
16
  | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
22
17
  | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
23
18
  | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
24
- | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
25
19
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
26
20
  | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
27
21
  | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
28
22
  | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
29
23
  | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
30
- | `setCustomFormTitle` | -- | Define uma função para configurar um título cusotmizado no modo formulário. | `() => string` | `undefined` |
31
24
  | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
32
25
  | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
33
26
  | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
@@ -36,47 +29,16 @@
36
29
 
37
30
  ## Events
38
31
 
39
- | Event | Description | Type |
40
- | -------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
41
- | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
42
- | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
43
- | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
44
- | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
45
- | `viewModeChanged` | | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
32
+ | Event | Description | Type |
33
+ | -------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
34
+ | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
35
+ | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
36
+ | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
37
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
46
38
 
47
39
 
48
40
  ## Methods
49
41
 
50
- ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
51
-
52
- Registra um editor customizado para campos da grade e formulário.
53
-
54
- #### Returns
55
-
56
- Type: `Promise<void>`
57
-
58
-
59
-
60
- ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
61
-
62
- Registra um formatador de valores para uma coluna da grid.
63
-
64
- #### Returns
65
-
66
- Type: `Promise<void>`
67
-
68
-
69
-
70
- ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
71
-
72
- Registra um render customizado para colunas da grid.
73
-
74
- #### Returns
75
-
76
- Type: `Promise<void>`
77
-
78
-
79
-
80
42
  ### `closeConfigurator() => Promise<void>`
81
43
 
82
44
  Usado para fechar o configurator do CRUD
@@ -127,26 +89,6 @@ Type: `Promise<void>`
127
89
 
128
90
 
129
91
 
130
- ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
131
-
132
- Remove o formatador de valores de uma coluna da grid.
133
-
134
- #### Returns
135
-
136
- Type: `Promise<void>`
137
-
138
-
139
-
140
- ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
141
-
142
- Altera/adiciona uma propriedade nos metadados do campo.
143
-
144
- #### Returns
145
-
146
- Type: `Promise<void>`
147
-
148
-
149
-
150
92
 
151
93
  ## Dependencies
152
94
 
@@ -213,8 +155,8 @@ graph TD;
213
155
  snk-detail-view --> taskbar-actions-button
214
156
  snk-attach --> snk-simple-bar
215
157
  snk-attach --> snk-simple-crud
216
- snk-simple-crud --> snk-taskbar
217
158
  snk-simple-crud --> snk-data-unit
159
+ snk-simple-crud --> snk-taskbar
218
160
  snk-simple-crud --> snk-form-config
219
161
  snk-simple-crud --> snk-configurator
220
162
  snk-simple-crud --> snk-grid-config
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -15,11 +15,8 @@
15
15
  | `dataState` | -- | Representa o estado do dataUnit master. | `DataState` | `undefined` |
16
16
  | `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
17
17
  | `detailTaskbarCustomContainerId` | `detail-taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. | `string` | `undefined` |
18
- | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
19
18
  | `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
20
19
  | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
21
- | `getCustomTitle` | -- | Fornece uma função para obter um título customizado do formulário. | `() => string` | `undefined` |
22
- | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
23
20
  | `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
24
21
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
25
22
  | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `undefined` |
@@ -40,26 +37,6 @@
40
37
 
41
38
  ## Methods
42
39
 
43
- ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
44
-
45
- Registra um editor customizado para campos da grade e formulário
46
-
47
- #### Returns
48
-
49
- Type: `Promise<void>`
50
-
51
-
52
-
53
- ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
54
-
55
- Registra um render customizado para colunas da grid.
56
-
57
- #### Returns
58
-
59
- Type: `Promise<void>`
60
-
61
-
62
-
63
40
  ### `findField() => Promise<void>`
64
41
 
65
42
  Abre o localizador de campos
@@ -70,16 +47,6 @@ Type: `Promise<void>`
70
47
 
71
48
 
72
49
 
73
- ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
74
-
75
- Altera/adiciona uma propriedade nos metadados do campo.
76
-
77
- #### Returns
78
-
79
- Type: `Promise<void>`
80
-
81
-
82
-
83
50
  ### `setFocus() => Promise<void>`
84
51
 
85
52
  Atribui o foco para o componente.
@@ -165,8 +132,8 @@ graph TD;
165
132
  snk-grid-config --> snk-select-box
166
133
  snk-attach --> snk-simple-bar
167
134
  snk-attach --> snk-simple-crud
168
- snk-simple-crud --> snk-taskbar
169
135
  snk-simple-crud --> snk-data-unit
136
+ snk-simple-crud --> snk-taskbar
170
137
  snk-simple-crud --> snk-form-config
171
138
  snk-simple-crud --> snk-configurator
172
139
  snk-simple-crud --> snk-grid-config
package/components/snk-crud/subcomponents/snk-detail-view/readme.md CHANGED
@@ -11,8 +11,6 @@
11
11
  | -------------------------- | ----------------------------- | ------------------------------------------------------------------------- | ---------------------- | ----------- |
12
12
  | `branchGuide` | -- | | `IGuideItem` | `undefined` |
13
13
  | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
- | `customEditors` | -- | Registra um editor customizado para campos da grade e formulário. | `PropsCustomEditor` | `undefined` |
15
- | `customRenders` | -- | Render customizados da grade. | `PropsCustomRender` | `undefined` |
16
14
  | `dataState` | -- | Representa o estado do dataUnit detail. | `DataState` | `undefined` |
17
15
  | `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit` | `undefined` |
18
16
  | `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string` | `undefined` |
@@ -37,26 +35,6 @@
37
35
 
38
36
  ## Methods
39
37
 
40
- ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
41
-
42
- Registra um editor customizado para campos da grade e formulário.
43
-
44
- #### Returns
45
-
46
- Type: `Promise<void>`
47
-
48
-
49
-
50
- ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
51
-
52
- Registra um render customizado para colunas da grid.
53
-
54
- #### Returns
55
-
56
- Type: `Promise<void>`
57
-
58
-
59
-
60
38
  ### `changeViewMode(mode: VIEW_MODE) => Promise<void>`
61
39
 
62
40
  Muda o modo de visualização do componente entre VIEW_MODE.GRID e VIEW_MODE.FORM
@@ -142,8 +120,8 @@ graph TD;
142
120
  snk-form-view --> snk-form-summary
143
121
  snk-attach --> snk-simple-bar
144
122
  snk-attach --> snk-simple-crud
145
- snk-simple-crud --> snk-taskbar
146
123
  snk-simple-crud --> snk-data-unit
124
+ snk-simple-crud --> snk-taskbar
147
125
  snk-simple-crud --> snk-form-config
148
126
  snk-simple-crud --> snk-configurator
149
127
  snk-simple-crud --> snk-grid-config
package/components/snk-data-unit/readme.md CHANGED
@@ -7,33 +7,31 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | ----------- |
12
- | `afterSave` | -- | Executado após a ação de salvar. | `(dataUnit: DataUnit) => void` | `undefined` |
13
- | `beforeSave` | -- | Executado imediatamente antes da ação de salvar as alterações. Útil no caso de validações por exemplo. Caso retorne "false" (ou a promessa se resolva como false), cancela a ação. | `(dataUnit: DataUnit) => boolean \| Promise<boolean>` | `undefined` |
14
- | `configName` | `config-name` | Usado para obter configuração de metadados. | `string` | `undefined` |
15
- | `dataState` | -- | Controla o estado atual dos dados. | `DataState` | `undefined` |
16
- | `dataUnit` | -- | Uma vez instanciado, pode-se obter o dataUnit por esta propriedade. | `DataUnit` | `undefined` |
17
- | `dataUnitName` | `data-unit-name` | Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade. | `string` | `undefined` |
18
- | `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
19
- | `entityName` | `entity-name` | Determina qual a entidade que representa os dados em questão. | `string` | `undefined` |
20
- | `ignoreSaveMessage` | `ignore-save-message` | Responsável por evitar a mensagem de sucesso ao salvar. | `boolean` | `undefined` |
21
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
- | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
23
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
24
- | `useCancelConfirm` | `use-cancel-confirm` | Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição. | `boolean` | `true` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | ----------- |
12
+ | `afterSave` | -- | Executado após a ação de salvar. | `(dataUnit: DataUnit) => void` | `undefined` |
13
+ | `beforeSave` | -- | Executado imediatamente antes da ação de salvar as alterações. Útil no caso de validações por exemplo. Caso retorne "false" (ou a promessa se resolva como false), cancela a ação. | `(dataUnit: DataUnit) => boolean \| Promise<boolean>` | `undefined` |
14
+ | `configName` | `config-name` | Usado para obter configuração de metadados. | `string` | `undefined` |
15
+ | `dataState` | -- | Controla o estado atual dos dados. | `DataState` | `undefined` |
16
+ | `dataUnit` | -- | Uma vez instanciado, pode-se obter o dataUnit por esta propriedade. | `DataUnit` | `undefined` |
17
+ | `dataUnitName` | `data-unit-name` | Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade. | `string` | `undefined` |
18
+ | `entityName` | `entity-name` | Determina qual a entidade que representa os dados em questão. | `string` | `undefined` |
19
+ | `ignoreSaveMessage` | `ignore-save-message` | Responsável por evitar a mensagem de sucesso ao salvar. | `boolean` | `undefined` |
20
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
21
+ | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
22
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
23
+ | `useCancelConfirm` | `use-cancel-confirm` | Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição. | `boolean` | `true` |
25
24
 
26
25
 
27
26
  ## Events
28
27
 
29
- | Event | Description | Type |
30
- | ------------------------ | ------------------------------------------------------------- | -------------------------------- |
31
- | `cancelEdition` | Emitido quando se cancela uma inserção ou cópia. | `CustomEvent<void>` |
32
- | `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
33
- | `dataUnitFieldsHidded` | Emitido quando há campos no DataUnit que devem ser ocultados. | `CustomEvent<void>` |
34
- | `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
35
- | `insertionMode` | Emitido quando um registro é adicionado ou copiado. | `CustomEvent<void>` |
36
- | `messagesBuilderUpdated` | Emitido quando o DataUnit está pronto. | `CustomEvent<SnkMessageBuilder>` |
28
+ | Event | Description | Type |
29
+ | ------------------------ | --------------------------------------------------------- | -------------------------------- |
30
+ | `cancelEdition` | Emitido quando se cancela uma inserção ou cópia. | `CustomEvent<void>` |
31
+ | `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
32
+ | `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
33
+ | `insertionMode` | Emitido quando um registro é adicionado ou copiado. | `CustomEvent<void>` |
34
+ | `messagesBuilderUpdated` | Emitido quando o DataUnit está pronto. | `CustomEvent<SnkMessageBuilder>` |
37
35
 
38
36
 
39
37
  ## Methods
@@ -48,36 +46,6 @@ Type: `Promise<DataUnit>`
48
46
 
49
47
 
50
48
 
51
- ### `getFieldsWithRmPrecision() => Promise<string[]>`
52
-
53
- Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precision).
54
-
55
- #### Returns
56
-
57
- Type: `Promise<string[]>`
58
-
59
-
60
-
61
- ### `getFieldsWithRmp() => Promise<string[]>`
62
-
63
- Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
64
-
65
- #### Returns
66
-
67
- Type: `Promise<string[]>`
68
-
69
-
70
-
71
- ### `getRowMetadata(record?: Record | string) => Promise<RowMetadata>`
72
-
73
- Busca os metadados da linha selecionada.
74
-
75
- #### Returns
76
-
77
- Type: `Promise<RowMetadata>`
78
-
79
-
80
-
81
49
  ### `getSelectedRecordsIDsInfo() => Promise<Array<IRecordID>>`
82
50
 
83
51
  Método que retorna a lista de IDs dos registros selecionados.
package/components/snk-filter-bar/readme.md CHANGED
@@ -7,20 +7,17 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | --------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
12
- | `afterApplyConfig` | -- | Função chamada depois de aplicar os filtros. | `() => void` | `undefined` |
13
- | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
14
- | `configName` | `config-name` | Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma. | `string` | `undefined` |
15
- | `customFilterBarConfig` | -- | Loader customizado para carregar as configurações | `(configName: string, resourceId: string, options: any) => Promise<SnkFilterItemConfig[]>` | `undefined` |
16
- | `dataUnit` | -- | Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros. | `DataUnit` | `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
- | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
19
- | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
20
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
21
- | `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
22
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
23
- | `title` | `title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ----------- |
12
+ | `configName` | `config-name` | Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma. | `string` | `undefined` |
13
+ | `dataUnit` | -- | Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros. | `DataUnit` | `undefined` |
14
+ | `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` |
15
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
16
+ | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
17
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
18
+ | `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
19
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
20
+ | `title` | `title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
24
21
 
25
22
 
26
23
  ## Events
package/components/snk-form/readme.md CHANGED
@@ -27,16 +27,6 @@
27
27
 
28
28
  ## Methods
29
29
 
30
- ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
31
-
32
- Registra um editor customizado para campos da grade e formulário.
33
-
34
- #### Returns
35
-
36
- Type: `Promise<void>`
37
-
38
-
39
-
40
30
  ### `hideConfig() => Promise<void>`
41
31
 
42
32
  Fecha a janela de configurações do formulário.
@@ -47,16 +37,6 @@ Type: `Promise<void>`
47
37
 
48
38
 
49
39
 
50
- ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
51
-
52
- Altera/adiciona uma propriedade nos metadados do campo.
53
-
54
- #### Returns
55
-
56
- Type: `Promise<void>`
57
-
58
-
59
-
60
40
  ### `showConfig() => Promise<void>`
61
41
 
62
42
  Exibe a janela de configurações do formulário.
package/components/snk-form-config/readme.md CHANGED
@@ -7,12 +7,11 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------------------------- | ------------------------------ | -------------------------------------------------------------------------------------- | ---------------------- | ----------- |
12
- | `configManager` | -- | Campos de configuração de formulário. | `SnkFormConfigManager` | `undefined` |
13
- | `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
14
- | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `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
+ | `configManager` | -- | Campos de configuração de formulário. | `SnkFormConfigManager` | `undefined` |
13
+ | `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
14
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
16
15
 
17
16
 
18
17
  ## Events
package/components/snk-grid/readme.md CHANGED
@@ -10,14 +10,10 @@
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | --------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | --------------------------------------- |
12
12
  | `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
13
- | `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
14
- | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
15
13
  | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
16
14
  | `columnFilterDataSource` | -- | | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
17
15
  | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
18
16
  | `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` |
19
- | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
20
- | `enableLockManger` | `enable-lock-manger` | Ativa o gerenciamento de locks na grade. | `boolean` | `false` |
21
17
  | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
22
18
  | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
23
19
  | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
@@ -46,36 +42,6 @@
46
42
 
47
43
  ## Methods
48
44
 
49
- ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
50
-
51
- Registra um editor customizado para campos da grade e formulário
52
-
53
- #### Returns
54
-
55
- Type: `Promise<void>`
56
-
57
-
58
-
59
- ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
60
-
61
- Registra um formatador de valores para uma coluna da grid.
62
-
63
- #### Returns
64
-
65
- Type: `Promise<void>`
66
-
67
-
68
-
69
- ### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
70
-
71
- Registra um render customizado para colunas da grid.
72
-
73
- #### Returns
74
-
75
- Type: `Promise<void>`
76
-
77
-
78
-
79
45
  ### `findColumn() => Promise<void>`
80
46
 
81
47
  Abre o localizador de colunas
@@ -116,16 +82,6 @@ Type: `Promise<void>`
116
82
 
117
83
 
118
84
 
119
- ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
120
-
121
- Remove o formatador de valores de uma coluna da grid.
122
-
123
- #### Returns
124
-
125
- Type: `Promise<void>`
126
-
127
-
128
-
129
85
  ### `setConfig(config: IGridConfig) => Promise<void>`
130
86
 
131
87
  Atribui o valor da configuração da grade.
package/components/snk-simple-crud/readme.md CHANGED
@@ -10,15 +10,9 @@
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | -------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ------------------------- |
12
12
  | `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
13
- | `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
14
- | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
15
13
  | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
16
14
  | `dataState` | -- | | `DataState` | `undefined` |
17
15
  | `dataUnit` | -- | | `DataUnit` | `undefined` |
18
- | `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
19
- | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
20
- | `enableLockManger` | `enable-lock-manger` | | `boolean` | `false` |
21
- | `entityName` | `entity-name` | Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD | `string` | `undefined` |
22
16
  | `formConfig` | -- | | `IFormConfig` | `undefined` |
23
17
  | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
24
18
  | `gridConfig` | -- | | `IGridConfig` | `undefined` |
@@ -27,7 +21,6 @@
27
21
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
28
22
  | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
29
23
  | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
30
- | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
31
24
  | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
32
25
  | `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `undefined` |
33
26
  | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
@@ -49,36 +42,6 @@
49
42
 
50
43
  ## Methods
51
44
 
52
- ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
53
-
54
- Registra um editor customizado para campos da grade e formulário.
55
-
56
- #### Returns
57
-
58
- Type: `Promise<void>`
59
-
60
-
61
-
62
- ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
63
-
64
- Registra um formatador de valores para uma coluna da grid.
65
-
66
- #### Returns
67
-
68
- Type: `Promise<void>`
69
-
70
-
71
-
72
- ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
73
-
74
- Registra um render customizado para colunas da grid.
75
-
76
- #### Returns
77
-
78
- Type: `Promise<void>`
79
-
80
-
81
-
82
45
  ### `closeConfigurator() => Promise<void>`
83
46
 
84
47
  Usado para fechar o configurator do CRUD
@@ -119,26 +82,6 @@ Type: `Promise<void>`
119
82
 
120
83
 
121
84
 
122
- ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
123
-
124
- Remove o formatador de valores de uma coluna da grid.
125
-
126
- #### Returns
127
-
128
- Type: `Promise<void>`
129
-
130
-
131
-
132
- ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
133
-
134
- Altera/adiciona uma propriedade nos metadados do campo.
135
-
136
- #### Returns
137
-
138
- Type: `Promise<void>`
139
-
140
-
141
-
142
85
  ### `setMetadata(metadata: UnitMetadata) => Promise<void>`
143
86
 
144
87
 
@@ -178,8 +121,8 @@ Type: `Promise<void>`
178
121
 
179
122
  ### Depends on
180
123
 
181
- - [snk-taskbar](../snk-taskbar)
182
124
  - [snk-data-unit](../snk-data-unit)
125
+ - [snk-taskbar](../snk-taskbar)
183
126
  - [snk-form-config](../snk-form-config)
184
127
  - [snk-configurator](../snk-configurator)
185
128
  - [snk-grid-config](../snk-grid-config)
@@ -190,8 +133,8 @@ Type: `Promise<void>`
190
133
  ### Graph
191
134
  ```mermaid
192
135
  graph TD;
193
- snk-simple-crud --> snk-taskbar
194
136
  snk-simple-crud --> snk-data-unit
137
+ snk-simple-crud --> snk-taskbar
195
138
  snk-simple-crud --> snk-form-config
196
139
  snk-simple-crud --> snk-configurator
197
140
  snk-simple-crud --> snk-grid-config
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "0.0.0-hotfix-rc-kb-79636.0",
3
+ "version": "0.0.0-hotfix-ga-5603306.1",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [