@sankhyalabs/sankhyablocks-docs 0.0.0-hotfix-ga-KB-41473.0 → 0.0.0-hotfix-ga-kb-70929.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 (12) hide show
  1. package/components/snk-application/readme.md +7 -7
  2. package/components/snk-attach/readme.md +1 -1
  3. package/components/snk-crud/readme.md +64 -7
  4. package/components/snk-crud/subcomponents/readme.md +34 -1
  5. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +23 -1
  6. package/components/snk-data-unit/readme.md +53 -21
  7. package/components/snk-filter-bar/readme.md +13 -11
  8. package/components/snk-form/readme.md +20 -0
  9. package/components/snk-form-config/readme.md +6 -5
  10. package/components/snk-grid/readme.md +43 -0
  11. package/components/snk-simple-crud/readme.md +58 -2
  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: Record<string, any>; }) => 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>; }, redirectFrom?: string) => void` | `undefined` |
16
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
17
17
 
18
18
 
19
19
  ## Events
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-data-unit
46
45
  snk-simple-crud --> snk-taskbar
46
+ snk-simple-crud --> snk-data-unit
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,17 +10,23 @@
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` |
13
15
  | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
14
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` |
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` |
15
19
  | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
16
20
  | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
17
21
  | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
18
22
  | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
23
+ | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
19
24
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
20
25
  | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
21
26
  | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
22
27
  | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
23
28
  | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
29
+ | `setCustomFormTitle` | -- | Define uma função para configurar um título cusotmizado no modo formulário. | `() => string` | `undefined` |
24
30
  | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
25
31
  | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
26
32
  | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
@@ -29,16 +35,47 @@
29
35
 
30
36
  ## Events
31
37
 
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[]>` |
38
+ | Event | Description | Type |
39
+ | -------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
40
+ | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
41
+ | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
42
+ | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
43
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
44
+ | `viewModeChanged` | | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
38
45
 
39
46
 
40
47
  ## Methods
41
48
 
49
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => 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) => Promise<void>`
70
+
71
+ Registra um render customizado para colunas da grid.
72
+
73
+ #### Returns
74
+
75
+ Type: `Promise<void>`
76
+
77
+
78
+
42
79
  ### `closeConfigurator() => Promise<void>`
43
80
 
44
81
  Usado para fechar o configurator do CRUD
@@ -89,6 +126,26 @@ Type: `Promise<void>`
89
126
 
90
127
 
91
128
 
129
+ ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
130
+
131
+ Remove o formatador de valores de uma coluna da grid.
132
+
133
+ #### Returns
134
+
135
+ Type: `Promise<void>`
136
+
137
+
138
+
139
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
140
+
141
+ Altera/adiciona uma propriedade nos metadados do campo.
142
+
143
+ #### Returns
144
+
145
+ Type: `Promise<void>`
146
+
147
+
148
+
92
149
 
93
150
  ## Dependencies
94
151
 
@@ -155,8 +212,8 @@ graph TD;
155
212
  snk-detail-view --> taskbar-actions-button
156
213
  snk-attach --> snk-simple-bar
157
214
  snk-attach --> snk-simple-crud
158
- snk-simple-crud --> snk-data-unit
159
215
  snk-simple-crud --> snk-taskbar
216
+ snk-simple-crud --> snk-data-unit
160
217
  snk-simple-crud --> snk-form-config
161
218
  snk-simple-crud --> snk-configurator
162
219
  snk-simple-crud --> snk-grid-config
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -15,8 +15,11 @@
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` |
18
19
  | `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
19
20
  | `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` |
20
23
  | `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
21
24
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
25
  | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `undefined` |
@@ -37,6 +40,26 @@
37
40
 
38
41
  ## Methods
39
42
 
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
+
40
63
  ### `findField() => Promise<void>`
41
64
 
42
65
  Abre o localizador de campos
@@ -47,6 +70,16 @@ Type: `Promise<void>`
47
70
 
48
71
 
49
72
 
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
+
50
83
  ### `setFocus() => Promise<void>`
51
84
 
52
85
  Atribui o foco para o componente.
@@ -132,8 +165,8 @@ graph TD;
132
165
  snk-grid-config --> snk-select-box
133
166
  snk-attach --> snk-simple-bar
134
167
  snk-attach --> snk-simple-crud
135
- snk-simple-crud --> snk-data-unit
136
168
  snk-simple-crud --> snk-taskbar
169
+ snk-simple-crud --> snk-data-unit
137
170
  snk-simple-crud --> snk-form-config
138
171
  snk-simple-crud --> snk-configurator
139
172
  snk-simple-crud --> snk-grid-config
package/components/snk-crud/subcomponents/snk-detail-view/readme.md CHANGED
@@ -11,6 +11,8 @@
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` |
14
16
  | `dataState` | -- | Representa o estado do dataUnit detail. | `DataState` | `undefined` |
15
17
  | `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit` | `undefined` |
16
18
  | `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string` | `undefined` |
@@ -35,6 +37,26 @@
35
37
 
36
38
  ## Methods
37
39
 
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
+
38
60
  ### `changeViewMode(mode: VIEW_MODE) => Promise<void>`
39
61
 
40
62
  Muda o modo de visualização do componente entre VIEW_MODE.GRID e VIEW_MODE.FORM
@@ -120,8 +142,8 @@ graph TD;
120
142
  snk-form-view --> snk-form-summary
121
143
  snk-attach --> snk-simple-bar
122
144
  snk-attach --> snk-simple-crud
123
- snk-simple-crud --> snk-data-unit
124
145
  snk-simple-crud --> snk-taskbar
146
+ snk-simple-crud --> snk-data-unit
125
147
  snk-simple-crud --> snk-form-config
126
148
  snk-simple-crud --> snk-configurator
127
149
  snk-simple-crud --> snk-grid-config
package/components/snk-data-unit/readme.md CHANGED
@@ -7,31 +7,33 @@
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
- | `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` |
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` |
24
25
 
25
26
 
26
27
  ## Events
27
28
 
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>` |
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>` |
35
37
 
36
38
 
37
39
  ## Methods
@@ -46,6 +48,36 @@ Type: `Promise<DataUnit>`
46
48
 
47
49
 
48
50
 
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
+
49
81
  ### `getSelectedRecordsIDsInfo() => Promise<Array<IRecordID>>`
50
82
 
51
83
  Método que retorna a lista de IDs dos registros selecionados.
package/components/snk-filter-bar/readme.md CHANGED
@@ -7,17 +7,19 @@
7
7
 
8
8
  ## Properties
9
9
 
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` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
12
+ | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
13
+ | `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` |
14
+ | `customFilterBarConfig` | -- | Loader customizado para carregar as configurações | `(configName: string, resourceId: string, options: any) => Promise<SnkFilterItemConfig[]>` | `undefined` |
15
+ | `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` |
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` |
17
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
18
+ | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
19
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
20
+ | `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
21
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
22
+ | `title` | `title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
21
23
 
22
24
 
23
25
  ## Events
package/components/snk-form/readme.md CHANGED
@@ -27,6 +27,16 @@
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
+
30
40
  ### `hideConfig() => Promise<void>`
31
41
 
32
42
  Fecha a janela de configurações do formulário.
@@ -37,6 +47,16 @@ Type: `Promise<void>`
37
47
 
38
48
 
39
49
 
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
+
40
60
  ### `showConfig() => Promise<void>`
41
61
 
42
62
  Exibe a janela de configurações do formulário.
package/components/snk-form-config/readme.md CHANGED
@@ -7,11 +7,12 @@
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
- | `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
+ | `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` |
15
16
 
16
17
 
17
18
  ## Events
package/components/snk-grid/readme.md CHANGED
@@ -10,10 +10,13 @@
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` |
13
15
  | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
16
  | `columnFilterDataSource` | -- | | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
15
17
  | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
16
18
  | `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` |
17
20
  | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
18
21
  | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
19
22
  | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
@@ -42,6 +45,36 @@
42
45
 
43
46
  ## Methods
44
47
 
48
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
49
+
50
+ Registra um editor customizado para campos da grade e formulário
51
+
52
+ #### Returns
53
+
54
+ Type: `Promise<void>`
55
+
56
+
57
+
58
+ ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
59
+
60
+ Registra um formatador de valores para uma coluna da grid.
61
+
62
+ #### Returns
63
+
64
+ Type: `Promise<void>`
65
+
66
+
67
+
68
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
69
+
70
+ Registra um render customizado para colunas da grid.
71
+
72
+ #### Returns
73
+
74
+ Type: `Promise<void>`
75
+
76
+
77
+
45
78
  ### `findColumn() => Promise<void>`
46
79
 
47
80
  Abre o localizador de colunas
@@ -82,6 +115,16 @@ Type: `Promise<void>`
82
115
 
83
116
 
84
117
 
118
+ ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
119
+
120
+ Remove o formatador de valores de uma coluna da grid.
121
+
122
+ #### Returns
123
+
124
+ Type: `Promise<void>`
125
+
126
+
127
+
85
128
  ### `setConfig(config: IGridConfig) => Promise<void>`
86
129
 
87
130
  Atribui o valor da configuração da grade.
package/components/snk-simple-crud/readme.md CHANGED
@@ -10,9 +10,14 @@
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` |
13
15
  | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
14
16
  | `dataState` | -- | | `DataState` | `undefined` |
15
17
  | `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
+ | `entityName` | `entity-name` | Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD | `string` | `undefined` |
16
21
  | `formConfig` | -- | | `IFormConfig` | `undefined` |
17
22
  | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
18
23
  | `gridConfig` | -- | | `IGridConfig` | `undefined` |
@@ -21,6 +26,7 @@
21
26
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
27
  | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
23
28
  | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
29
+ | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
24
30
  | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
25
31
  | `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `undefined` |
26
32
  | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
@@ -42,6 +48,36 @@
42
48
 
43
49
  ## Methods
44
50
 
51
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
52
+
53
+ Registra um editor customizado para campos da grade e formulário.
54
+
55
+ #### Returns
56
+
57
+ Type: `Promise<void>`
58
+
59
+
60
+
61
+ ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
62
+
63
+ Registra um formatador de valores para uma coluna da grid.
64
+
65
+ #### Returns
66
+
67
+ Type: `Promise<void>`
68
+
69
+
70
+
71
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
72
+
73
+ Registra um render customizado para colunas da grid.
74
+
75
+ #### Returns
76
+
77
+ Type: `Promise<void>`
78
+
79
+
80
+
45
81
  ### `closeConfigurator() => Promise<void>`
46
82
 
47
83
  Usado para fechar o configurator do CRUD
@@ -82,6 +118,26 @@ Type: `Promise<void>`
82
118
 
83
119
 
84
120
 
121
+ ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
122
+
123
+ Remove o formatador de valores de uma coluna da grid.
124
+
125
+ #### Returns
126
+
127
+ Type: `Promise<void>`
128
+
129
+
130
+
131
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
132
+
133
+ Altera/adiciona uma propriedade nos metadados do campo.
134
+
135
+ #### Returns
136
+
137
+ Type: `Promise<void>`
138
+
139
+
140
+
85
141
  ### `setMetadata(metadata: UnitMetadata) => Promise<void>`
86
142
 
87
143
 
@@ -121,8 +177,8 @@ Type: `Promise<void>`
121
177
 
122
178
  ### Depends on
123
179
 
124
- - [snk-data-unit](../snk-data-unit)
125
180
  - [snk-taskbar](../snk-taskbar)
181
+ - [snk-data-unit](../snk-data-unit)
126
182
  - [snk-form-config](../snk-form-config)
127
183
  - [snk-configurator](../snk-configurator)
128
184
  - [snk-grid-config](../snk-grid-config)
@@ -133,8 +189,8 @@ Type: `Promise<void>`
133
189
  ### Graph
134
190
  ```mermaid
135
191
  graph TD;
136
- snk-simple-crud --> snk-data-unit
137
192
  snk-simple-crud --> snk-taskbar
193
+ snk-simple-crud --> snk-data-unit
138
194
  snk-simple-crud --> snk-form-config
139
195
  snk-simple-crud --> snk-configurator
140
196
  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-ga-KB-41473.0",
3
+ "version": "0.0.0-hotfix-ga-kb-70929.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [