@sankhyalabs/sankhyablocks-docs 8.15.1 → 8.16.0-dev.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (10) hide show
  1. package/components/snk-application/readme.md +7 -7
  2. package/components/snk-crud/readme.md +52 -0
  3. package/components/snk-crud/subcomponents/readme.md +30 -0
  4. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +22 -0
  5. package/components/snk-data-unit/readme.md +38 -7
  6. package/components/snk-filter-bar/readme.md +1 -0
  7. package/components/snk-form/readme.md +20 -0
  8. package/components/snk-grid/readme.md +42 -0
  9. package/components/snk-simple-crud/readme.md +54 -0
  10. 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-crud/readme.md CHANGED
@@ -10,6 +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` |
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` |
15
17
  | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
@@ -39,6 +41,36 @@
39
41
 
40
42
  ## Methods
41
43
 
44
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
45
+
46
+ Registra um editor customizado para campos da grade e formulário.
47
+
48
+ #### Returns
49
+
50
+ Type: `Promise<void>`
51
+
52
+
53
+
54
+ ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
55
+
56
+ Registra um formatador de valores para uma coluna da grid.
57
+
58
+ #### Returns
59
+
60
+ Type: `Promise<void>`
61
+
62
+
63
+
64
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
65
+
66
+ Registra um render customizado para colunas da grid.
67
+
68
+ #### Returns
69
+
70
+ Type: `Promise<void>`
71
+
72
+
73
+
42
74
  ### `closeConfigurator() => Promise<void>`
43
75
 
44
76
  Usado para fechar o configurator do CRUD
@@ -89,6 +121,26 @@ Type: `Promise<void>`
89
121
 
90
122
 
91
123
 
124
+ ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
125
+
126
+ Remove o formatador de valores de uma coluna da grid.
127
+
128
+ #### Returns
129
+
130
+ Type: `Promise<void>`
131
+
132
+
133
+
134
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
135
+
136
+ Altera/adiciona uma propriedade nos metadados do campo.
137
+
138
+ #### Returns
139
+
140
+ Type: `Promise<void>`
141
+
142
+
143
+
92
144
 
93
145
  ## Dependencies
94
146
 
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -37,6 +37,26 @@
37
37
 
38
38
  ## Methods
39
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
+
40
60
  ### `findField() => Promise<void>`
41
61
 
42
62
  Abre o localizador de campos
@@ -47,6 +67,16 @@ Type: `Promise<void>`
47
67
 
48
68
 
49
69
 
70
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
71
+
72
+ Altera/adiciona uma propriedade nos metadados do campo.
73
+
74
+ #### Returns
75
+
76
+ Type: `Promise<void>`
77
+
78
+
79
+
50
80
  ### `setFocus() => Promise<void>`
51
81
 
52
82
  Atribui o foco para o componente.
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
package/components/snk-data-unit/readme.md CHANGED
@@ -25,13 +25,14 @@
25
25
 
26
26
  ## Events
27
27
 
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>` |
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
+ | `dataUnitFieldsHidded` | Emitido quando há campos no DataUnit que devem ser ocultados. | `CustomEvent<void>` |
33
+ | `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
34
+ | `insertionMode` | Emitido quando um registro é adicionado ou copiado. | `CustomEvent<void>` |
35
+ | `messagesBuilderUpdated` | Emitido quando o DataUnit está pronto. | `CustomEvent<SnkMessageBuilder>` |
35
36
 
36
37
 
37
38
  ## Methods
@@ -46,6 +47,36 @@ Type: `Promise<DataUnit>`
46
47
 
47
48
 
48
49
 
50
+ ### `getFieldsWithRmPrecision() => Promise<string[]>`
51
+
52
+ Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precision).
53
+
54
+ #### Returns
55
+
56
+ Type: `Promise<string[]>`
57
+
58
+
59
+
60
+ ### `getFieldsWithRmp() => Promise<string[]>`
61
+
62
+ Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
63
+
64
+ #### Returns
65
+
66
+ Type: `Promise<string[]>`
67
+
68
+
69
+
70
+ ### `getRowMetadata(record?: Record | string) => Promise<RowMetadata>`
71
+
72
+ Busca os metadados da linha selecionada.
73
+
74
+ #### Returns
75
+
76
+ Type: `Promise<RowMetadata>`
77
+
78
+
79
+
49
80
  ### `getSelectedRecordsIDsInfo() => Promise<Array<IRecordID>>`
50
81
 
51
82
  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,12 @@
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
+ | `entityName` | `entity-name` | Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD | `string` | `undefined` |
16
19
  | `formConfig` | -- | | `IFormConfig` | `undefined` |
17
20
  | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
18
21
  | `gridConfig` | -- | | `IGridConfig` | `undefined` |
@@ -21,6 +24,7 @@
21
24
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
25
  | `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
23
26
  | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
27
+ | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
24
28
  | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
25
29
  | `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `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` |
@@ -42,6 +46,36 @@
42
46
 
43
47
  ## Methods
44
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
+
45
79
  ### `closeConfigurator() => Promise<void>`
46
80
 
47
81
  Usado para fechar o configurator do CRUD
@@ -82,6 +116,26 @@ Type: `Promise<void>`
82
116
 
83
117
 
84
118
 
119
+ ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
120
+
121
+ Remove o formatador de valores de uma coluna da grid.
122
+
123
+ #### Returns
124
+
125
+ Type: `Promise<void>`
126
+
127
+
128
+
129
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
130
+
131
+ Altera/adiciona uma propriedade nos metadados do campo.
132
+
133
+ #### Returns
134
+
135
+ Type: `Promise<void>`
136
+
137
+
138
+
85
139
  ### `setMetadata(metadata: UnitMetadata) => Promise<void>`
86
140
 
87
141
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "8.15.1",
3
+ "version": "8.16.0-dev.2",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [