@sankhyalabs/sankhyablocks-docs 0.0.0-bugfix-dev-kb-67792.0 → 0.0.0-bugfix-dev-kb-67792.2

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 (11) 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 +62 -7
  4. package/components/snk-crud/subcomponents/readme.md +32 -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 +1 -0
  8. package/components/snk-form/readme.md +20 -0
  9. package/components/snk-grid/readme.md +42 -0
  10. package/components/snk-simple-crud/readme.md +57 -2
  11. 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,8 +10,11 @@
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` |
15
18
  | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
16
19
  | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
17
20
  | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
@@ -21,6 +24,7 @@
21
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` |
22
25
  | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
23
26
  | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
27
+ | `setCustomFormTitle` | -- | Define uma função para configurar um título cusotmizado no modo formulário. | `() => string` | `undefined` |
24
28
  | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
25
29
  | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
26
30
  | `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 +33,47 @@
29
33
 
30
34
  ## Events
31
35
 
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[]>` |
36
+ | Event | Description | Type |
37
+ | -------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
38
+ | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
39
+ | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
40
+ | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
41
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
42
+ | `viewModeChanged` | | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
38
43
 
39
44
 
40
45
  ## Methods
41
46
 
47
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
48
+
49
+ Registra um editor customizado para campos da grade e formulário.
50
+
51
+ #### Returns
52
+
53
+ Type: `Promise<void>`
54
+
55
+
56
+
57
+ ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
58
+
59
+ Registra um formatador de valores para uma coluna da grid.
60
+
61
+ #### Returns
62
+
63
+ Type: `Promise<void>`
64
+
65
+
66
+
67
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
68
+
69
+ Registra um render customizado para colunas da grid.
70
+
71
+ #### Returns
72
+
73
+ Type: `Promise<void>`
74
+
75
+
76
+
42
77
  ### `closeConfigurator() => Promise<void>`
43
78
 
44
79
  Usado para fechar o configurator do CRUD
@@ -89,6 +124,26 @@ Type: `Promise<void>`
89
124
 
90
125
 
91
126
 
127
+ ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
128
+
129
+ Remove o formatador de valores de uma coluna da grid.
130
+
131
+ #### Returns
132
+
133
+ Type: `Promise<void>`
134
+
135
+
136
+
137
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
138
+
139
+ Altera/adiciona uma propriedade nos metadados do campo.
140
+
141
+ #### Returns
142
+
143
+ Type: `Promise<void>`
144
+
145
+
146
+
92
147
 
93
148
  ## Dependencies
94
149
 
@@ -155,8 +210,8 @@ graph TD;
155
210
  snk-detail-view --> taskbar-actions-button
156
211
  snk-attach --> snk-simple-bar
157
212
  snk-attach --> snk-simple-crud
158
- snk-simple-crud --> snk-data-unit
159
213
  snk-simple-crud --> snk-taskbar
214
+ snk-simple-crud --> snk-data-unit
160
215
  snk-simple-crud --> snk-form-config
161
216
  snk-simple-crud --> snk-configurator
162
217
  snk-simple-crud --> snk-grid-config
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -17,6 +17,7 @@
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
18
  | `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
19
19
  | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
20
+ | `getCustomTitle` | -- | Fornece uma função para obter um título customizado do formulário. | `() => string` | `undefined` |
20
21
  | `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
21
22
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
23
  | `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 +38,26 @@
37
38
 
38
39
  ## Methods
39
40
 
41
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
42
+
43
+ Registra um editor customizado para campos da grade e formulário
44
+
45
+ #### Returns
46
+
47
+ Type: `Promise<void>`
48
+
49
+
50
+
51
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
52
+
53
+ Registra um render customizado para colunas da grid.
54
+
55
+ #### Returns
56
+
57
+ Type: `Promise<void>`
58
+
59
+
60
+
40
61
  ### `findField() => Promise<void>`
41
62
 
42
63
  Abre o localizador de campos
@@ -47,6 +68,16 @@ Type: `Promise<void>`
47
68
 
48
69
 
49
70
 
71
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
72
+
73
+ Altera/adiciona uma propriedade nos metadados do campo.
74
+
75
+ #### Returns
76
+
77
+ Type: `Promise<void>`
78
+
79
+
80
+
50
81
  ### `setFocus() => Promise<void>`
51
82
 
52
83
  Atribui o foco para o componente.
@@ -132,8 +163,8 @@ graph TD;
132
163
  snk-grid-config --> snk-select-box
133
164
  snk-attach --> snk-simple-bar
134
165
  snk-attach --> snk-simple-crud
135
- snk-simple-crud --> snk-data-unit
136
166
  snk-simple-crud --> snk-taskbar
167
+ snk-simple-crud --> snk-data-unit
137
168
  snk-simple-crud --> snk-form-config
138
169
  snk-simple-crud --> snk-configurator
139
170
  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
@@ -9,6 +9,7 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | --------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ----------- |
12
+ | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
12
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` |
13
14
  | `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
15
  | `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` |
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-grid/readme.md CHANGED
@@ -10,6 +10,8 @@
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` |
@@ -42,6 +44,36 @@
42
44
 
43
45
  ## Methods
44
46
 
47
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
48
+
49
+ Registra um editor customizado para campos da grade e formulário
50
+
51
+ #### Returns
52
+
53
+ Type: `Promise<void>`
54
+
55
+
56
+
57
+ ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
58
+
59
+ Registra um formatador de valores para uma coluna da grid.
60
+
61
+ #### Returns
62
+
63
+ Type: `Promise<void>`
64
+
65
+
66
+
67
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
68
+
69
+ Registra um render customizado para colunas da grid.
70
+
71
+ #### Returns
72
+
73
+ Type: `Promise<void>`
74
+
75
+
76
+
45
77
  ### `findColumn() => Promise<void>`
46
78
 
47
79
  Abre o localizador de colunas
@@ -82,6 +114,16 @@ Type: `Promise<void>`
82
114
 
83
115
 
84
116
 
117
+ ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
118
+
119
+ Remove o formatador de valores de uma coluna da grid.
120
+
121
+ #### Returns
122
+
123
+ Type: `Promise<void>`
124
+
125
+
126
+
85
127
  ### `setConfig(config: IGridConfig) => Promise<void>`
86
128
 
87
129
  Atribui o valor da configuração da grade.
package/components/snk-simple-crud/readme.md CHANGED
@@ -10,9 +10,13 @@
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
+ | `entityName` | `entity-name` | Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD | `string` | `undefined` |
16
20
  | `formConfig` | -- | | `IFormConfig` | `undefined` |
17
21
  | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
18
22
  | `gridConfig` | -- | | `IGridConfig` | `undefined` |
@@ -21,6 +25,7 @@
21
25
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
26
  | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
23
27
  | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
28
+ | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
24
29
  | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
25
30
  | `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `undefined` |
26
31
  | `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 +47,36 @@
42
47
 
43
48
  ## Methods
44
49
 
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
+
45
80
  ### `closeConfigurator() => Promise<void>`
46
81
 
47
82
  Usado para fechar o configurator do CRUD
@@ -82,6 +117,26 @@ Type: `Promise<void>`
82
117
 
83
118
 
84
119
 
120
+ ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
121
+
122
+ Remove o formatador de valores de uma coluna da grid.
123
+
124
+ #### Returns
125
+
126
+ Type: `Promise<void>`
127
+
128
+
129
+
130
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
131
+
132
+ Altera/adiciona uma propriedade nos metadados do campo.
133
+
134
+ #### Returns
135
+
136
+ Type: `Promise<void>`
137
+
138
+
139
+
85
140
  ### `setMetadata(metadata: UnitMetadata) => Promise<void>`
86
141
 
87
142
 
@@ -121,8 +176,8 @@ Type: `Promise<void>`
121
176
 
122
177
  ### Depends on
123
178
 
124
- - [snk-data-unit](../snk-data-unit)
125
179
  - [snk-taskbar](../snk-taskbar)
180
+ - [snk-data-unit](../snk-data-unit)
126
181
  - [snk-form-config](../snk-form-config)
127
182
  - [snk-configurator](../snk-configurator)
128
183
  - [snk-grid-config](../snk-grid-config)
@@ -133,8 +188,8 @@ Type: `Promise<void>`
133
188
  ### Graph
134
189
  ```mermaid
135
190
  graph TD;
136
- snk-simple-crud --> snk-data-unit
137
191
  snk-simple-crud --> snk-taskbar
192
+ snk-simple-crud --> snk-data-unit
138
193
  snk-simple-crud --> snk-form-config
139
194
  snk-simple-crud --> snk-configurator
140
195
  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-bugfix-dev-kb-67792.0",
3
+ "version": "0.0.0-bugfix-dev-kb-67792.2",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [