@sankhyalabs/sankhyablocks-docs 8.0.2 → 8.1.0-dev.10

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-application/readme.md +10 -0
  2. package/components/snk-crud/readme.md +7 -5
  3. package/components/snk-crud/subcomponents/readme.md +6 -4
  4. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +6 -4
  5. package/components/snk-data-unit/readme.md +13 -12
  6. package/components/snk-form/readme.md +5 -4
  7. package/components/snk-grid/readme.md +15 -11
  8. package/components/snk-simple-crud/readme.md +7 -5
  9. package/package.json +1 -1
package/components/snk-application/readme.md CHANGED
@@ -53,6 +53,16 @@ Type: `Promise<boolean>`
53
53
 
54
54
 
55
55
 
56
+ ### `callServiceBroker(serviceName: string, payload: string | Object, options?: Options) => Promise<any>`
57
+
58
+ Realiza a chamada ao Service Broker conforme o nome do serviço.
59
+
60
+ #### Returns
61
+
62
+ Type: `Promise<any>`
63
+
64
+
65
+
56
66
  ### `closeModal() => Promise<void>`
57
67
 
58
68
  Fecha o Modal e limpa o conteúdo.
package/components/snk-crud/readme.md CHANGED
@@ -19,15 +19,17 @@
19
19
  | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
20
20
  | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
21
21
  | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
22
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
22
23
 
23
24
 
24
25
  ## Events
25
26
 
26
- | Event | Description | Type |
27
- | -------------------- | ---------------------------------------------------------------------------- | --------------------- |
28
- | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
29
- | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
30
- | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
27
+ | Event | Description | Type |
28
+ | -------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
29
+ | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
30
+ | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
31
+ | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
32
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
31
33
 
32
34
 
33
35
  ## Methods
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -11,6 +11,7 @@
11
11
  | ------------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | ----------- |
12
12
  | `_guideBuilders` | -- | | `Map<string, GuideBuilder>` | `new Map()` |
13
13
  | `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
14
+ | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
15
  | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
15
16
  | `dataState` | -- | Representa o estado do dataUnit master. | `DataState` | `undefined` |
16
17
  | `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
@@ -25,10 +26,11 @@
25
26
 
26
27
  ## Events
27
28
 
28
- | Event | Description | Type |
29
- | ------------- | ------------------------------------------------- | --------------------- |
30
- | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
31
- | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
29
+ | Event | Description | Type |
30
+ | ---------------- | ------------------------------------------------------------------------------- | ---------------------------- |
31
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
32
+ | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
33
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
32
34
 
33
35
 
34
36
  ## Methods
package/components/snk-crud/subcomponents/snk-detail-view/readme.md CHANGED
@@ -10,6 +10,7 @@
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ------------------- | ---------------- | ----------------------------------------------------------- | ---------------------- | ----------- |
12
12
  | `branchGuide` | -- | | `IGuideItem` | `undefined` |
13
+ | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
13
14
  | `dataState` | -- | Representa o estado do dataUnit detail. | `DataState` | `undefined` |
14
15
  | `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit` | `undefined` |
15
16
  | `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string` | `undefined` |
@@ -23,10 +24,11 @@
23
24
 
24
25
  ## Events
25
26
 
26
- | Event | Description | Type |
27
- | ----------------------- | ---------------------------------------------------------------- | --------------------------- |
28
- | `snkDetailGuidesChange` | Emitido quando há necessidade de atualizar a estrutura de guias. | `CustomEvent<GuideBuilder>` |
29
- | `snkSwitchGuide` | Emitido quando há necessidade de comutar entre grid e form. | `CustomEvent<string>` |
27
+ | Event | Description | Type |
28
+ | ----------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
29
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
30
+ | `snkDetailGuidesChange` | Emitido quando há necessidade de atualizar a estrutura de guias. | `CustomEvent<GuideBuilder>` |
31
+ | `snkSwitchGuide` | Emitido quando há necessidade de comutar entre grid e form. | `CustomEvent<string>` |
30
32
 
31
33
 
32
34
  ## Methods
package/components/snk-data-unit/readme.md CHANGED
@@ -7,18 +7,19 @@
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
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
20
- | `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
21
- | `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
+ | `useCancelConfirm` | `use-cancel-confirm` | Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição. | `boolean` | `true` |
22
23
 
23
24
 
24
25
  ## Events
package/components/snk-form/readme.md CHANGED
@@ -16,10 +16,11 @@
16
16
 
17
17
  ## Events
18
18
 
19
- | Event | Description | Type |
20
- | ------------- | ------------------------------------------------- | --------------------- |
21
- | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
22
- | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
19
+ | Event | Description | Type |
20
+ | ---------------- | ------------------------------------------------------------------------------- | ---------------------------- |
21
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
22
+ | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
23
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
23
24
 
24
25
 
25
26
  ## Methods
package/components/snk-grid/readme.md CHANGED
@@ -7,17 +7,21 @@
7
7
 
8
8
  ## Properties
9
9
 
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
- | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
14
- | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
15
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
16
- | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
17
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `PresentationMode.PRIMARY` |
18
- | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
19
- | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
20
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `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
+ | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
+ | `columnFilterDataSource` | -- | | `SnkMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
15
+ | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
16
+ | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
17
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
18
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
19
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `PresentationMode.PRIMARY` |
20
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
21
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
22
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
23
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
24
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
21
25
 
22
26
 
23
27
  ## Events
package/components/snk-simple-crud/readme.md CHANGED
@@ -18,15 +18,17 @@
18
18
  | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
19
19
  | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
20
20
  | `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
21
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
21
22
 
22
23
 
23
24
  ## Events
24
25
 
25
- | Event | Description | Type |
26
- | ----------------- | --------------------------------------------------------- | ------------------------ |
27
- | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
28
- | `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
29
- | `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
26
+ | Event | Description | Type |
27
+ | ----------------- | ------------------------------------------------------------------------------- | ---------------------------- |
28
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
29
+ | `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
30
+ | `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
31
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
30
32
 
31
33
 
32
34
  ## Methods
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "8.0.2",
3
+ "version": "8.1.0-dev.10",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [