@sankhyalabs/sankhyablocks-docs 0.0.0-bugfix-dev-KB-47941.0 → 0.0.0-bugfix-dev-59880.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 (9) hide show
  1. package/components/snk-crud/readme.md +21 -0
  2. package/components/snk-crud/subcomponents/readme.md +20 -0
  3. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +22 -0
  4. package/components/snk-data-unit/readme.md +8 -7
  5. package/components/snk-filter-bar/readme.md +1 -0
  6. package/components/snk-form/readme.md +10 -0
  7. package/components/snk-grid/readme.md +21 -0
  8. package/components/snk-simple-crud/readme.md +21 -0
  9. package/package.json +1 -1
package/components/snk-crud/readme.md CHANGED
@@ -10,6 +10,7 @@
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
+ | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
13
14
  | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `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` |
15
16
  | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
@@ -39,6 +40,16 @@
39
40
 
40
41
  ## Methods
41
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
+
42
53
  ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
43
54
 
44
55
  Registra um formatador de valores para uma coluna da grid.
@@ -49,6 +60,16 @@ Type: `Promise<void>`
49
60
 
50
61
 
51
62
 
63
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
64
+
65
+ Registra um render customizado para colunas da grid.
66
+
67
+ #### Returns
68
+
69
+ Type: `Promise<void>`
70
+
71
+
72
+
52
73
  ### `closeConfigurator() => Promise<void>`
53
74
 
54
75
  Usado para fechar o configurator do CRUD
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
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
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.
package/components/snk-grid/readme.md CHANGED
@@ -10,6 +10,7 @@
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
+ | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
13
14
  | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
15
  | `columnFilterDataSource` | -- | | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
15
16
  | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
@@ -42,6 +43,16 @@
42
43
 
43
44
  ## Methods
44
45
 
46
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
47
+
48
+ Registra um editor customizado para campos da grade e formulário
49
+
50
+ #### Returns
51
+
52
+ Type: `Promise<void>`
53
+
54
+
55
+
45
56
  ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
46
57
 
47
58
  Registra um formatador de valores para uma coluna da grid.
@@ -52,6 +63,16 @@ Type: `Promise<void>`
52
63
 
53
64
 
54
65
 
66
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
67
+
68
+ Registra um render customizado para colunas da grid.
69
+
70
+ #### Returns
71
+
72
+ Type: `Promise<void>`
73
+
74
+
75
+
55
76
  ### `findColumn() => Promise<void>`
56
77
 
57
78
  Abre o localizador de colunas
package/components/snk-simple-crud/readme.md CHANGED
@@ -10,6 +10,7 @@
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
+ | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
13
14
  | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
14
15
  | `dataState` | -- | | `DataState` | `undefined` |
15
16
  | `dataUnit` | -- | | `DataUnit` | `undefined` |
@@ -44,6 +45,16 @@
44
45
 
45
46
  ## Methods
46
47
 
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
+
47
58
  ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
48
59
 
49
60
  Registra um formatador de valores para uma coluna da grid.
@@ -54,6 +65,16 @@ Type: `Promise<void>`
54
65
 
55
66
 
56
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
+
57
78
  ### `closeConfigurator() => Promise<void>`
58
79
 
59
80
  Usado para fechar o configurator do CRUD
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "0.0.0-bugfix-dev-KB-47941.0",
3
+ "version": "0.0.0-bugfix-dev-59880.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [