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