@sankhyalabs/sankhyablocks-docs 8.3.1 → 8.4.0-dev.1

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 (17) hide show
  1. package/components/snk-application/readme.md +4 -14
  2. package/components/snk-configurator/readme.md +1 -0
  3. package/components/snk-crud/readme.md +6 -5
  4. package/components/snk-crud/subcomponents/readme.md +21 -19
  5. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +20 -17
  6. package/components/snk-data-unit/readme.md +1 -0
  7. package/components/snk-entity-list/readme.md +3 -4
  8. package/components/snk-filter-bar/filter-modal/readme.md +1 -1
  9. package/components/snk-filter-bar/filter-modal/subcomponents/readme.md +5 -4
  10. package/components/snk-filter-bar/readme.md +7 -6
  11. package/components/snk-form/readme.md +11 -9
  12. package/components/snk-grid/readme.md +19 -14
  13. package/components/snk-grid/subcomponents/snk-grid-config/readme.md +1 -0
  14. package/components/snk-personalized-filter/readme.md +7 -6
  15. package/components/snk-simple-crud/readme.md +6 -5
  16. package/components/snk-taskbar/readme.md +4 -46
  17. package/package.json +1 -1
package/components/snk-application/readme.md CHANGED
@@ -93,7 +93,7 @@ Type: `Promise<boolean>`
93
93
 
94
94
 
95
95
 
96
- ### `createDataunit(entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string) => Promise<DataUnit>`
96
+ ### `createDataunit(entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>`
97
97
 
98
98
  Cria o DataUnit a partir do nome da entidade. É possível armazená-lo no cache
99
99
  passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado.
@@ -148,7 +148,7 @@ Type: `Promise<any[]>`
148
148
 
149
149
 
150
150
 
151
- ### `getAllAccess() => Promise<any>`
151
+ ### `getAllAccess(resourceID?: string) => Promise<any>`
152
152
 
153
153
  Obtém todos os acessos do usuário logado.
154
154
 
@@ -218,7 +218,7 @@ Type: `Promise<DataFetcher>`
218
218
 
219
219
  DataFetcher do application
220
220
 
221
- ### `getDataUnit(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string) => Promise<DataUnit>`
221
+ ### `getDataUnit(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>`
222
222
 
223
223
  Obtem um DataUnit do cache ou cria um caso ainda não tenha sido criado.
224
224
 
@@ -288,7 +288,7 @@ Type: `Promise<string>`
288
288
 
289
289
 
290
290
 
291
- ### `hasAccess(access: AutorizationType) => Promise<boolean>`
291
+ ### `hasAccess(access: AutorizationType, resourceID?: string) => Promise<boolean>`
292
292
 
293
293
  Obtém `true` caso o usuário logado tem permissão pra determinada ação.
294
294
 
@@ -358,16 +358,6 @@ Type: `Promise<boolean>`
358
358
 
359
359
 
360
360
 
361
- ### `loadGridConfig(name: string) => Promise<IGridConfig>`
362
-
363
- Obtém a configuração de grade.
364
-
365
- #### Returns
366
-
367
- Type: `Promise<IGridConfig>`
368
-
369
-
370
-
371
361
  ### `loadTotals(name: string, resourceID: string, filters: Array<Filter>) => Promise<Map<string, number>>`
372
362
 
373
363
  Obtém os totalizadores da grade.
package/components/snk-configurator/readme.md CHANGED
@@ -11,6 +11,7 @@
11
11
  | ------------------- | --------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ---------------- |
12
12
  | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
13
13
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
14
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
14
15
  | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação | `boolean` | `false` |
15
16
  | `viewMode` | `view-mode` | Define qual modo de visualização está ativo. | `VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID` | `VIEW_MODE.GRID` |
16
17
 
package/components/snk-crud/readme.md CHANGED
@@ -24,11 +24,12 @@
24
24
 
25
25
  ## Events
26
26
 
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>` |
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[]>` |
32
33
 
33
34
 
34
35
  ## Methods
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -7,29 +7,31 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | ----------- |
12
- | `_guideBuilders` | -- | | `Map<string, GuideBuilder>` | `new Map()` |
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` |
15
- | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
16
- | `dataState` | -- | Representa o estado do dataUnit master. | `DataState` | `undefined` |
17
- | `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
18
- | `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
19
- | `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
20
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
21
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `undefined` |
22
- | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
23
- | `selectedGuide` | -- | Guia selecionada. | `IGuideItem` | `undefined` |
24
- | `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` | -- | Ações a serem colocadas 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
+ | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
15
+ | `dataState` | -- | Representa o estado do dataUnit master. | `DataState` | `undefined` |
16
+ | `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
17
+ | `detailTaskbarCustomContainerId` | `detail-taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. | `string` | `undefined` |
18
+ | `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
19
+ | `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
20
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
21
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `undefined` |
22
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
23
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
24
+ | `selectedGuide` | -- | Guia selecionada. | `IGuideItem` | `undefined` |
25
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
25
26
 
26
27
 
27
28
  ## Events
28
29
 
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>` |
30
+ | Event | Description | Type |
31
+ | ---------------- | ------------------------------------------------------------------------------- | ---------------------------- |
32
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
33
+ | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
34
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
33
35
 
34
36
 
35
37
  ## Methods
package/components/snk-crud/subcomponents/snk-detail-view/readme.md CHANGED
@@ -7,27 +7,30 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------- | ---------------- | ----------------------------------------------------------- | ---------------------- | ----------- |
12
- | `branchGuide` | -- | | `IGuideItem` | `undefined` |
13
- | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
- | `dataState` | -- | Representa o estado do dataUnit detail. | `DataState` | `undefined` |
15
- | `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit` | `undefined` |
16
- | `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string` | `undefined` |
17
- | `entityName` | `entity-name` | Nome da entidade detail. | `string` | `undefined` |
18
- | `formConfigManager` | -- | Gerenciador de configuração do formulário. | `SnkFormConfigManager` | `undefined` |
19
- | `guideItemPath` | -- | Caminho do identificador da guia vinculada. | `IGuideItem[]` | `undefined` |
20
- | `label` | `label` | Descrição amigável do cadastro detalhe. | `string` | `undefined` |
21
- | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
22
- | `selectedForm` | `selected-form` | Representa o formulário selecionado. | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------------------- | ----------------------------- | ------------------------------------------------------------------------- | ---------------------- | ----------- |
12
+ | `branchGuide` | -- | | `IGuideItem` | `undefined` |
13
+ | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
+ | `dataState` | -- | Representa o estado do dataUnit detail. | `DataState` | `undefined` |
15
+ | `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit` | `undefined` |
16
+ | `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string` | `undefined` |
17
+ | `entityName` | `entity-name` | Nome da entidade detail. | `string` | `undefined` |
18
+ | `formConfigManager` | -- | Gerenciador de configuração do formulário. | `SnkFormConfigManager` | `undefined` |
19
+ | `guideItemPath` | -- | Caminho do identificador da guia vinculada. | `IGuideItem[]` | `undefined` |
20
+ | `label` | `label` | Descrição amigável do cadastro detalhe. | `string` | `undefined` |
21
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
22
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
23
+ | `selectedForm` | `selected-form` | Representa o formulário selecionado. | `string` | `undefined` |
24
+ | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
23
25
 
24
26
 
25
27
  ## Events
26
28
 
27
- | Event | Description | Type |
28
- | ----------------------- | ---------------------------------------------------------------- | --------------------------- |
29
- | `snkDetailGuidesChange` | Emitido quando há necessidade de atualizar a estrutura de guias. | `CustomEvent<GuideBuilder>` |
30
- | `snkSwitchGuide` | Emitido quando há necessidade de comutar entre grid e form. | `CustomEvent<string>` |
29
+ | Event | Description | Type |
30
+ | ----------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
31
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
32
+ | `snkDetailGuidesChange` | Emitido quando há necessidade de atualizar a estrutura de guias. | `CustomEvent<GuideBuilder>` |
33
+ | `snkSwitchGuide` | Emitido quando há necessidade de comutar entre grid e form. | `CustomEvent<string>` |
31
34
 
32
35
 
33
36
  ## Methods
package/components/snk-data-unit/readme.md CHANGED
@@ -19,6 +19,7 @@
19
19
  | `ignoreSaveMessage` | `ignore-save-message` | Responsável por evitar a mensagem de sucesso ao salvar. | `boolean` | `undefined` |
20
20
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
21
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` |
22
23
  | `useCancelConfirm` | `use-cancel-confirm` | Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição. | `boolean` | `true` |
23
24
 
24
25
 
package/components/snk-entity-list/readme.md CHANGED
@@ -16,10 +16,9 @@
16
16
 
17
17
  ## Events
18
18
 
19
- | Event | Description | Type |
20
- | -------------- | -------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
21
- | `saveConfig` | Evento emitido ao realizar alguma ação que altera os dados do config.value permitindo salvar estas informações | `CustomEvent<SnkFilterItemConfig>` |
22
- | `valueChanged` | Emite um evento customizado ao realizar alteração nos valores do componente | `CustomEvent<CustomEvent<any>>` |
19
+ | Event | Description | Type |
20
+ | -------------- | --------------------------------------------------------------------------- | ------------------------------- |
21
+ | `valueChanged` | Emite um evento customizado ao realizar alteração nos valores do componente | `CustomEvent<CustomEvent<any>>` |
23
22
 
24
23
 
25
24
  ## Methods
package/components/snk-filter-bar/filter-modal/readme.md CHANGED
@@ -12,7 +12,7 @@
12
12
  | `addPersonalizedFilter` | -- | Ação executada ao adicionar um filtro personalizado | `() => void` | `undefined` |
13
13
  | `applyFilters` | -- | Ação executada ao aplicar os filtros | `(updatedFilterConfig: SnkFilterItemConfig[]) => void` | `undefined` |
14
14
  | `closeModal` | -- | Ação disparada ao fechar o modal | `() => void` | `undefined` |
15
- | `configName` | `config-name` | Nome da config para buscar no resourceId | `string` | `undefined` |
15
+ | `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
16
16
  | `editPersonalizedFilter` | -- | Ação executada ao editart um filtro personalizado | `(id: string) => void` | `undefined` |
17
17
  | `filters` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
18
18
  | `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
package/components/snk-filter-bar/filter-modal/subcomponents/readme.md CHANGED
@@ -7,10 +7,11 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------ | ------------- | ---------------------------------------- | --------------------- | ----------- |
12
- | `configName` | `config-name` | Nome da config para buscar no resourceId | `string` | `undefined` |
13
- | `filterItem` | -- | | `SnkFilterItemConfig` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------ | -------------- | ---------------------------------------------------------------------------- | --------------------- | ----------- |
12
+ | `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
13
+ | `filterItem` | -- | | `SnkFilterItemConfig` | `undefined` |
14
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
14
15
 
15
16
 
16
17
  ## Events
package/components/snk-filter-bar/readme.md CHANGED
@@ -7,12 +7,13 @@
7
7
 
8
8
  ## Properties
9
9
 
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
- | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
15
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `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
+ | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
15
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
16
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
16
17
 
17
18
 
18
19
  ## Methods
package/components/snk-form/readme.md CHANGED
@@ -7,19 +7,21 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------ | ------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
13
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
14
- | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------ | -------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
+ | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
13
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
14
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
15
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
15
16
 
16
17
 
17
18
  ## Events
18
19
 
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>` |
20
+ | Event | Description | Type |
21
+ | ---------------- | ------------------------------------------------------------------------------- | ---------------------------- |
22
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
23
+ | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
24
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
23
25
 
24
26
 
25
27
  ## Methods
package/components/snk-grid/readme.md CHANGED
@@ -7,20 +7,25 @@
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
- | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
- | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
15
- | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
16
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
- | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
18
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `PresentationMode.PRIMARY` |
19
- | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
20
- | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
21
- | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
22
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
23
- | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
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
+ | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
17
+ | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
18
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
19
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
20
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `PresentationMode.PRIMARY` |
21
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
22
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
23
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
24
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
25
+ | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
26
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
27
+ | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
28
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
24
29
 
25
30
 
26
31
  ## Events
package/components/snk-grid/subcomponents/snk-grid-config/readme.md CHANGED
@@ -13,6 +13,7 @@
13
13
  | `columns` | -- | Colunas da grade. | `EzGridColumn[]` | `undefined` |
14
14
  | `config` | -- | Configurações da grade. | `IGridConfig` | `undefined` |
15
15
  | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
16
+ | `resourceID` | `resource-i-d` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
16
17
  | `selectedIndex` | `selected-index` | Aba selecionada das configurações da grade. | `number` | `0` |
17
18
 
18
19
 
package/components/snk-personalized-filter/readme.md CHANGED
@@ -7,12 +7,13 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | ------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `configName` | `config-name` | Nome da config para buscar no resourceId | `string` | `undefined` |
13
- | `entityUri` | `entity-uri` | Responsável por receber a URI da entidade. | `string` | `undefined` |
14
- | `filterId` | `filter-id` | Id do filtro que será carregado. | `string` | `undefined` |
15
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | -------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
+ | `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
13
+ | `entityUri` | `entity-uri` | Responsável por receber a URI da entidade. | `string` | `undefined` |
14
+ | `filterId` | `filter-id` | Id do filtro que será carregado. | `string` | `undefined` |
15
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
16
+ | `resourceID` | `resource-i-d` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
16
17
 
17
18
 
18
19
  ## Events
package/components/snk-simple-crud/readme.md CHANGED
@@ -23,11 +23,12 @@
23
23
 
24
24
  ## Events
25
25
 
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>` |
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[]>` |
31
32
 
32
33
 
33
34
  ## Methods
package/components/snk-taskbar/readme.md CHANGED
@@ -1,4 +1,4 @@
1
- # snk-taskbar
1
+ # snk-taskbar-custom-elements
2
2
 
3
3
 
4
4
 
@@ -7,53 +7,11 @@
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
- | `buttons` | `buttons` | Lista separada por virgula, contendo todos os elementos a serem criados. | `string` | `undefined` |
14
- | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
15
- | `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` |
16
- | `dataUnit` | -- | Instância do DataUnit. | `DataUnit` | `undefined` |
17
- | `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados. | `string[]` | `undefined` |
18
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
19
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY` | `PresentationMode.PRIMARY` |
20
- | `primaryButton` | `primary-button` | Determina qual botão deve ter aparência primária. | `string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------- | --------- | ------------------------------------------------------------------------ | -------- | --------------------------- |
12
+ | `slot` | `slot` | Nome do slot da Taskbar onde os elementos customizados deverão aparecer. | `string` | `'TASKBAR_CUSTOM_ELEMENTS'` |
21
13
 
22
14
 
23
- ## Events
24
-
25
- | Event | Description | Type |
26
- | ------------- | ------------------------------------------------- | --------------------- |
27
- | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
28
-
29
-
30
- ## Dependencies
31
-
32
- ### Used by
33
-
34
- - [snk-detail-view](../snk-crud/subcomponents/snk-detail-view)
35
- - [snk-grid](../snk-grid)
36
- - [snk-guides-viewer](../snk-crud/subcomponents)
37
- - [snk-simple-crud](../snk-simple-crud)
38
-
39
- ### Depends on
40
-
41
- - [snk-data-exporter](../snk-data-exporter)
42
- - [snk-actions-button](../snk-actions-button)
43
-
44
- ### Graph
45
- ```mermaid
46
- graph TD;
47
- snk-taskbar --> snk-data-exporter
48
- snk-taskbar --> snk-actions-button
49
- snk-data-exporter --> snk-exporter-email-sender
50
- snk-detail-view --> snk-taskbar
51
- snk-grid --> snk-taskbar
52
- snk-guides-viewer --> snk-taskbar
53
- snk-simple-crud --> snk-taskbar
54
- style snk-taskbar fill:#f9f,stroke:#333,stroke-width:4px
55
- ```
56
-
57
15
  ----------------------------------------------
58
16
 
59
17
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "8.3.1",
3
+ "version": "8.4.0-dev.1",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [