@sankhyalabs/sankhyablocks-docs 0.0.0-hotfix-ga-kb-106384.0 → 0.0.0-hotfix-ga-kb-106386.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 (5) hide show
  1. package/components/snk-application/readme.md +3 -3
  2. package/components/snk-data-unit/readme.md +6 -6
  3. package/components/snk-filter-bar/readme.md +26 -26
  4. package/components/snk-taskbar/readme.md +22 -22
  5. package/package.json +1 -1
package/components/snk-application/readme.md CHANGED
@@ -148,7 +148,7 @@ Type: `Promise<boolean>`
148
148
 
149
149
 
150
150
 
151
- ### `executePreparedSearch(mode: string, argument: string, options: IPreparedSearchOptions) => Promise<Array<IOption> | IOption>`
151
+ ### `executePreparedSearch(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>`
152
152
 
153
153
  Obtém as opções em componentes de pesquisa com base em opções preparadas.
154
154
  Ex.: snk-config-options
@@ -159,7 +159,7 @@ Type: `Promise<IOption | IOption[]>`
159
159
 
160
160
  Uma lista de opções ou uma única opção.
161
161
 
162
- ### `executePreparedSearchPlus(mode: string, argument: string, options: IPreparedSearchOptions) => Promise<Array<IOption> | IOption>`
162
+ ### `executePreparedSearchPlus(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>`
163
163
 
164
164
  Realiza a pesquisa de registros
165
165
  Ex.: snk-config-options
@@ -168,7 +168,7 @@ Ex.: snk-config-options
168
168
 
169
169
  Type: `Promise<IOption | IOption[]>`
170
170
 
171
-
171
+ Uma lista de opções ou uma única opção.
172
172
 
173
173
  ### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: ISearchCtxOptions) => Promise<Array<IOption> | IOption>`
174
174
 
package/components/snk-data-unit/readme.md CHANGED
@@ -33,7 +33,7 @@
33
33
  | `dataUnitFieldsHidded` | Emitido quando há campos no DataUnit que devem ser ocultados. | `CustomEvent<void>` |
34
34
  | `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
35
35
  | `insertionMode` | Emitido quando um registro é adicionado ou copiado. | `CustomEvent<void>` |
36
- | `messagesBuilderUpdated` | Emitido quando o DataUnit está pronto. | `CustomEvent<SnkMessageBuilder>` |
36
+ | `messagesBuilderUpdated` | Emitido quando o messagesBuilder é atualizado. | `CustomEvent<SnkMessageBuilder>` |
37
37
 
38
38
 
39
39
  ## Methods
@@ -46,7 +46,7 @@ Obtém o dataUnit.
46
46
 
47
47
  Type: `Promise<DataUnit>`
48
48
 
49
-
49
+ Uma promessa que resolve com a instância do DataUnit.
50
50
 
51
51
  ### `getFieldsWithRmPrecision() => Promise<string[]>`
52
52
 
@@ -56,7 +56,7 @@ Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precisi
56
56
 
57
57
  Type: `Promise<string[]>`
58
58
 
59
-
59
+ Uma promessa que resolve com um array de nomes de campos.
60
60
 
61
61
  ### `getFieldsWithRmp() => Promise<string[]>`
62
62
 
@@ -66,7 +66,7 @@ Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
66
66
 
67
67
  Type: `Promise<string[]>`
68
68
 
69
-
69
+ Uma promessa que resolve com um array de nomes de campos.
70
70
 
71
71
  ### `getRowMetadata(record?: Record | string) => Promise<RowMetadata>`
72
72
 
@@ -76,7 +76,7 @@ Busca os metadados da linha selecionada.
76
76
 
77
77
  Type: `Promise<RowMetadata>`
78
78
 
79
-
79
+ Uma promessa que resolve com os metadados da linha.
80
80
 
81
81
  ### `getSelectedRecordsIDsInfo() => Promise<Array<IRecordID>>`
82
82
 
@@ -86,7 +86,7 @@ Método que retorna a lista de IDs dos registros selecionados.
86
86
 
87
87
  Type: `Promise<IRecordID[]>`
88
88
 
89
- Retorna a lista de IDs dos registros selecionados.
89
+ Retorna uma promessa que resolve com a lista de IDs dos registros selecionados.
90
90
 
91
91
 
92
92
  ## Dependencies
package/components/snk-filter-bar/readme.md CHANGED
@@ -7,21 +7,21 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------------------ | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
12
- | `afterApplyConfig` | -- | Função chamada depois de aplicar os filtros. | `() => void` | `undefined` |
13
- | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
14
- | `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` |
15
- | `customFilterBarConfig` | -- | Loader customizado para carregar as configurações | `(configName: string, resourceId: string, options: any) => Promise<SnkFilterItemConfig[]>` | `undefined` |
16
- | `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` |
17
- | `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` |
18
- | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento | `boolean` | `false` |
19
- | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
20
- | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
21
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
- | `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
23
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
24
- | `title` | `title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------------------ | ---------------------------------- | ----------- | ------------------------------------------------------------------------------------------ | ----------- |
12
+ | `afterApplyConfig` | -- | | `() => void` | `undefined` |
13
+ | `autoLoad` | `auto-load` | | `boolean` | `undefined` |
14
+ | `configName` | `config-name` | | `string` | `undefined` |
15
+ | `customFilterBarConfig` | -- | | `(configName: string, resourceId: string, options: any) => Promise<SnkFilterItemConfig[]>` | `undefined` |
16
+ | `dataUnit` | -- | | `DataUnit` | `undefined` |
17
+ | `disablePersonalizedFilter` | `disable-personalized-filter` | | `boolean` | `undefined` |
18
+ | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | | `boolean` | `false` |
19
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | | `string` | `undefined` |
20
+ | `filterConfig` | -- | | `SnkFilterItemConfig[]` | `undefined` |
21
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
22
+ | `mode` | `mode` | | `"button" \| "hidden" \| "regular"` | `"regular"` |
23
+ | `resourceID` | `resource-i-d` | | `string` | `undefined` |
24
+ | `title` | `title` | | `string` | `undefined` |
25
25
 
26
26
 
27
27
  ## Events
@@ -35,47 +35,47 @@
35
35
 
36
36
  ### `addFilterItem(filterItem: SnkFilterItemConfig) => Promise<void>`
37
37
 
38
- Adiciona um item de filtro.
38
+
39
39
 
40
40
  #### Returns
41
41
 
42
42
  Type: `Promise<void>`
43
43
 
44
-
44
+ Retorna uma Promise que resolve quando o item for adicionado.
45
45
 
46
46
  ### `getFilterItem(id: string) => Promise<SnkFilterItemConfig | undefined>`
47
47
 
48
- Retorna um item de filtro pelo ID.
48
+
49
49
 
50
50
  #### Returns
51
51
 
52
52
  Type: `Promise<SnkFilterItemConfig>`
53
53
 
54
-
54
+ O item de filtro correspondente ou undefined se não for encontrado.
55
55
 
56
56
  ### `reload() => Promise<void>`
57
57
 
58
- Faz o recarregamento da filterbar buscando o state no servidor.
58
+
59
59
 
60
60
  #### Returns
61
61
 
62
62
  Type: `Promise<void>`
63
63
 
64
-
64
+ Retorna uma Promise que resolve quando o recarregamento for concluído.
65
65
 
66
66
  ### `removeFilterItem(filterID: string) => Promise<SnkFilterItemConfig | undefined>`
67
67
 
68
- Remove um item de filtro.
68
+
69
69
 
70
70
  #### Returns
71
71
 
72
72
  Type: `Promise<SnkFilterItemConfig>`
73
73
 
74
- - Retorna o item de filtro removido, ou undefined caso não encontrado.
74
+ Retorna o item de filtro removido, ou undefined caso não seja encontrado.
75
75
 
76
76
  ### `showFilterModal() => Promise<void>`
77
77
 
78
- Abre o modal de filtros
78
+
79
79
 
80
80
  #### Returns
81
81
 
@@ -85,13 +85,13 @@ Type: `Promise<void>`
85
85
 
86
86
  ### `updateFilterItem(newFilterItem: SnkFilterItemConfig) => Promise<void>`
87
87
 
88
- Atualiza um item do filtro.
88
+
89
89
 
90
90
  #### Returns
91
91
 
92
92
  Type: `Promise<void>`
93
93
 
94
-
94
+ Retorna uma Promise que resolve quando a atualização for concluída.
95
95
 
96
96
 
97
97
  ## Dependencies
package/components/snk-taskbar/readme.md CHANGED
@@ -7,32 +7,32 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | --------------------- | --------------------- | ----------- | ------------------------------------------------------------------------------------------- | --------------------------- |
12
- | `actionsList` | -- | | `Action[]` | `undefined` |
13
- | `actionsSettingsList` | -- | | `Action[]` | `undefined` |
14
- | `alignRigth` | `align-rigth` | | `boolean` | `false` |
15
- | `buttons` | `buttons` | | `string` | `undefined` |
16
- | `configName` | `config-name` | | `string` | `undefined` |
17
- | `customButtons` | -- | | `Map<string, CustomButton>` | `undefined` |
18
- | `customContainerId` | `custom-container-id` | | `string` | `undefined` |
19
- | `customSlotId` | `custom-slot-id` | | `string` | `"TASKBAR_CUSTOM_ELEMENTS"` |
20
- | `dataUnit` | -- | | `DataUnit` | `undefined` |
21
- | `disabledButtons` | -- | | `string[]` | `undefined` |
22
- | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
23
- | `overflowStrategy` | `overflow-strategy` | | `"hiddenItems" \| "none"` | `'hiddenItems'` |
24
- | `presentationMode` | `presentation-mode` | | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
25
- | `primaryButton` | `primary-button` | | `string` | `undefined` |
26
- | `resourceID` | `resource-i-d` | | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- | --------------------------- |
12
+ | `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
13
+ | `actionsSettingsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
14
+ | `alignRigth` | `align-rigth` | Usado para determinar O alinhamento dos items na taskbar. | `boolean` | `false` |
15
+ | `buttons` | `buttons` | Lista separada por virgula, contendo todos os elementos a serem criados. | `string` | `undefined` |
16
+ | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
17
+ | `customButtons` | -- | Mapa com definição de botões personalizados. A chave do mapa deve ser passada na lista "buttons" no lugar onde o botão irá aparecer. | `Map<string, CustomButton>` | `undefined` |
18
+ | `customContainerId` | `custom-container-id` | Usado para determinar o identificador do container na DOM que é responsavel por guardar os elementos personalizados que não podem ser passados por slot. Exemplo: Elementos customizados na Taskbar da aba de detalhes. | `string` | `undefined` |
19
+ | `customSlotId` | `custom-slot-id` | Usado para determinar o identificador do slot que recebe elementos personalizados. | `string` | `"TASKBAR_CUSTOM_ELEMENTS"` |
20
+ | `dataUnit` | -- | Instância do DataUnit. | `DataUnit` | `undefined` |
21
+ | `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados. | `string[]` | `undefined` |
22
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
23
+ | `overflowStrategy` | `overflow-strategy` | Define como será o comportamento da taskbar quando ocorrer overflow | `"hiddenItems" \| "none"` | `'hiddenItems'` |
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` |
25
+ | `primaryButton` | `primary-button` | Determina qual botão deve ter aparência primária. | `string` | `undefined` |
26
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
27
27
 
28
28
 
29
29
  ## Events
30
30
 
31
- | Event | Description | Type |
32
- | --------------------- | ----------- | --------------------- |
33
- | `actionClick` | | `CustomEvent<string>` |
34
- | `taskbarSaveLocker` | | `CustomEvent<void>` |
35
- | `taskbarSaveUnlocker` | | `CustomEvent<void>` |
31
+ | Event | Description | Type |
32
+ | --------------------- | ------------------------------------------------------------ | --------------------- |
33
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
34
+ | `taskbarSaveLocker` | Emitido sempre que um save é iniciado pela taskbar. | `CustomEvent<void>` |
35
+ | `taskbarSaveUnlocker` | Emitido sempre que o ocorre alguma action que libera o save. | `CustomEvent<void>` |
36
36
 
37
37
 
38
38
  ## Dependencies
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "0.0.0-hotfix-ga-kb-106384.0",
3
+ "version": "0.0.0-hotfix-ga-kb-106386.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [