@sankhyalabs/sankhyablocks-docs 10.1.0-dev.9 → 10.1.0-rc.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 (8) hide show
  1. package/components/snk-application/readme.md +0 -12
  2. package/components/snk-crud/readme.md +0 -2
  3. package/components/snk-crud/subcomponents/readme.md +6 -8
  4. package/components/snk-form-config/readme.md +0 -1
  5. package/components/snk-grid/readme.md +39 -40
  6. package/components/snk-pesquisa/readme.md +0 -14
  7. package/components/snk-taskbar/readme.md +0 -1
  8. package/package.json +1 -1
package/components/snk-application/readme.md CHANGED
@@ -184,18 +184,6 @@ Uma lista de opções ou uma única opção.
184
184
 
185
185
  ---
186
186
 
187
- ### `executePreparedSearchWithFullResponse(argument: string, options: any) => Promise<any>`
188
-
189
- Obtém as opções em componentes de pesquisa além dos metadados como showMore e entityPk.
190
-
191
- #### Returns
192
-
193
- Type: `Promise<any>`
194
-
195
- Uma lista de opções ou uma única opção.
196
-
197
- ---
198
-
199
187
  ### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: ISearchCtxOptions) => Promise<Array<IOption> | IOption>`
200
188
 
201
189
  Obtém as opções em componentes de pesquisa.
package/components/snk-crud/readme.md CHANGED
@@ -13,7 +13,6 @@
13
13
  | `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
14
14
  | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
15
15
  | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
16
- | `customGuidesConfig` | -- | Fornece as informações das guias personalizadas. | `CustomGuideItem[]` | `[]` |
17
16
  | `disableNumberingConfig` | `disable-numbering-config` | Define se a configuração de numeração será desabilitada. | `boolean` | `false` |
18
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` |
19
18
  | `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
@@ -35,7 +34,6 @@
35
34
  | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
36
35
  | `setCustomFormTitle` | -- | Define uma função para configurar um título cusotmizado no modo formulário. | `() => string` | `undefined` |
37
36
  | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
38
- | `showEntitySearch` | `show-entity-search` | Define se o campo de busca de entidades será exibido na barra superior. | `boolean` | `true` |
39
37
  | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
40
38
  | `strategyExporter` | `strategy-exporter` | Modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
41
39
  | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -12,7 +12,6 @@
12
12
  | `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
13
13
  | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
14
14
  | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
15
- | `customGuidesConfig` | -- | Fornece as informações das guias personalizadas. | `CustomGuideItem[]` | `[]` |
16
15
  | `dataState` | -- | Representa o estado do dataUnit master. | `DataState` | `undefined` |
17
16
  | `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
18
17
  | `detailTaskbarCustomContainerId` | `detail-taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. | `string` | `undefined` |
@@ -32,13 +31,12 @@
32
31
 
33
32
  ## Events
34
33
 
35
- | Event | Description | Type |
36
- | ----------------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
37
- | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
38
- | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
39
- | `formConfigVisibilityChanged` | Emitido quando a visibilidade do configurador do formulário é alterada. | `CustomEvent<boolean>` |
40
- | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
41
- | `snkMasterFormConfigChange` | Emitido quando a configuração do formulário master é definida. | `CustomEvent<IFormConfig>` |
34
+ | Event | Description | Type |
35
+ | --------------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
36
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
37
+ | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
38
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
39
+ | `snkMasterFormConfigChange` | Emitido quando a configuração do formulário master é definida. | `CustomEvent<IFormConfig>` |
42
40
 
43
41
 
44
42
  ## Methods
package/components/snk-form-config/readme.md CHANGED
@@ -10,7 +10,6 @@
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | -------------------------- | ------------------------------ | -------------------------------------------------------------------------------------- | ---------------------- | ----------- |
12
12
  | `configManager` | -- | Campos de configuração de formulário. | `SnkFormConfigManager` | `undefined` |
13
- | `customGuidesConfig` | -- | Informações das guias personalizadas. | `CustomGuideItem[]` | `[]` |
14
13
  | `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
15
14
  | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
16
15
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
package/components/snk-grid/readme.md CHANGED
@@ -7,46 +7,45 @@
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 `snk-taskbar`. | `Action[]` | `undefined` |
13
- | `autoFocus` | `auto-focus` | Define se a grade receberá o foco automaticamente ao ser carregada. | `boolean` | `true` |
14
- | `autoLoad` | `auto-load` | Define se os dados serão carregados automaticamente na inicialização do componente. | `boolean` | `undefined` |
15
- | `canEdit` | `can-edit` | Define se a edição de dados na grade está habilitada. | `boolean` | `true` |
16
- | `columnFilterDataSource` | -- | Define o data source para o filtro de colunas. | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
17
- | `compact` | `compact` | Define se a grade deve ser exibida em modo compacto. | `boolean` | `undefined` |
18
- | `configName` | `config-name` | Nome usado para salvar e recuperar a configuração da grade. | `string` | `undefined` |
19
- | `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na barra de filtros (chip de filtros) e no modal lateral de filtros (contêiner de filtros personalizados). | `boolean` | `undefined` |
20
- | `enableGridInsert` | `enable-grid-insert` | Habilita a inserção de registros diretamente na grade. | `boolean` | `false` |
21
- | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação. | `boolean` | `false` |
22
- | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar. | `boolean` | `false` |
23
- | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legada da barra de filtros. | `string` | `undefined` |
24
- | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros. | `string` | `undefined` |
25
- | `filterCustomConfig` | -- | | `SnkFilterItemConfig[]` | `undefined` |
26
- | `filterCustomConfigInterceptor` | -- | | `(config: SnkFilterItemConfig[]) => SnkFilterItemConfig[]` | `undefined` |
27
- | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
28
- | `gridHeaderDynamicSearchSlotId` | `grid-header-dynamic-search-slot-id` | Define o nome do slot para a aba de pesquisa no cabeçalho da grade. | `string` | `'GRID_HEADER_DYNAMIC_SEARCH'` |
29
- | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legada da grade. | `string` | `undefined` |
30
- | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe de outra tela. | `boolean` | `undefined` |
31
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
32
- | `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultaneamente. | `boolean` | `true` |
33
- | `multipleSelection` | `multiple-selection` | Determina se a seleção de múltiplas linhas é permitida. | `boolean` | `undefined` |
34
- | `outlineMode` | `outline-mode` | Altera a aparência das bordas e sombras do componente. Se `false`, aplica o padrão de sombras (ideal para o elemento principal do layout). Se `true`, aplica um contorno (ideal para quando o componente está dentro de outro, como um painel ou pop-up). | `boolean` | `false` |
35
- | `paginationCounterMode` | `pagination-counter-mode` | Define o modo de exibição do contador de paginação. | `"auto" \| "hidden" \| "show"` | `'auto'` |
36
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do `snk-taskbar`. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
37
- | `recordsValidator` | -- | Validador responsável por verificar a integridade dos dados de um registro. | `IRecordValidator` | `undefined` |
38
- | `resourceID` | `resource-i-d` | Identificador de recursos, como configurações e permissões de acesso. | `string` | `undefined` |
39
- | `selectionToastConfig` | -- | Configuração do toast de seleção da grade. | `ISelectionToastConfig` | `undefined` |
40
- | `statusResolver` | -- | Define a configuração de cores para a coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` |
41
- | `strategyExporter` | `strategy-exporter` | Define o modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
42
- | `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de checkbox deve ser suprimida. | `boolean` | `undefined` |
43
- | `suppressFilterColumn` | `suppress-filter-column` | Informa se a grade deve suprimir o filtro de coluna. | `boolean` | `false` |
44
- | `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir a barra de rolagem horizontal. | `boolean` | `false` |
45
- | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do contêiner de elementos customizados da `Taskbar`. | `string` | `undefined` |
46
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. Permite determinar botões específicos ou gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
47
- | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Define o nome do slot para elementos customizados na `Taskbar` principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
48
- | `useEnterLikeTab` | `use-enter-like-tab` | Quando `true`, a tecla ENTER navega entre as células como a tecla TAB. | `boolean` | `false` |
49
- | `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`. | `boolean` | `true` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | --------------------------------------- |
12
+ | `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do `snk-taskbar`. | `Action[]` | `undefined` |
13
+ | `autoFocus` | `auto-focus` | Define se a grade receberá o foco automaticamente ao ser carregada. | `boolean` | `true` |
14
+ | `autoLoad` | `auto-load` | Define se os dados serão carregados automaticamente na inicialização do componente. | `boolean` | `undefined` |
15
+ | `canEdit` | `can-edit` | Define se a edição de dados na grade está habilitada. | `boolean` | `true` |
16
+ | `columnFilterDataSource` | -- | Define o data source para o filtro de colunas. | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
17
+ | `compact` | `compact` | Define se a grade deve ser exibida em modo compacto. | `boolean` | `undefined` |
18
+ | `configName` | `config-name` | Nome usado para salvar e recuperar a configuração da grade. | `string` | `undefined` |
19
+ | `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na barra de filtros (chip de filtros) e no modal lateral de filtros (contêiner de filtros personalizados). | `boolean` | `undefined` |
20
+ | `enableGridInsert` | `enable-grid-insert` | Habilita a inserção de registros diretamente na grade. | `boolean` | `false` |
21
+ | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação. | `boolean` | `false` |
22
+ | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar. | `boolean` | `false` |
23
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legada da barra de filtros. | `string` | `undefined` |
24
+ | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros. | `string` | `undefined` |
25
+ | `filterCustomConfig` | -- | | `SnkFilterItemConfig[]` | `undefined` |
26
+ | `filterCustomConfigInterceptor` | -- | | `(config: SnkFilterItemConfig[]) => SnkFilterItemConfig[]` | `undefined` |
27
+ | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
28
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legada da grade. | `string` | `undefined` |
29
+ | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe de outra tela. | `boolean` | `undefined` |
30
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
31
+ | `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultaneamente. | `boolean` | `true` |
32
+ | `multipleSelection` | `multiple-selection` | Determina se a seleção de múltiplas linhas é permitida. | `boolean` | `undefined` |
33
+ | `outlineMode` | `outline-mode` | Altera a aparência das bordas e sombras do componente. Se `false`, aplica o padrão de sombras (ideal para o elemento principal do layout). Se `true`, aplica um contorno (ideal para quando o componente está dentro de outro, como um painel ou pop-up). | `boolean` | `false` |
34
+ | `paginationCounterMode` | `pagination-counter-mode` | Define o modo de exibição do contador de paginação. | `"auto" \| "hidden" \| "show"` | `'auto'` |
35
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do `snk-taskbar`. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
36
+ | `recordsValidator` | -- | Validador responsável por verificar a integridade dos dados de um registro. | `IRecordValidator` | `undefined` |
37
+ | `resourceID` | `resource-i-d` | Identificador de recursos, como configurações e permissões de acesso. | `string` | `undefined` |
38
+ | `selectionToastConfig` | -- | Configuração do toast de seleção da grade. | `ISelectionToastConfig` | `undefined` |
39
+ | `statusResolver` | -- | Define a configuração de cores para a coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` |
40
+ | `strategyExporter` | `strategy-exporter` | Define o modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
41
+ | `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de checkbox deve ser suprimida. | `boolean` | `undefined` |
42
+ | `suppressFilterColumn` | `suppress-filter-column` | Informa se a grade deve suprimir o filtro de coluna. | `boolean` | `false` |
43
+ | `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir a barra de rolagem horizontal. | `boolean` | `false` |
44
+ | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do contêiner de elementos customizados da `Taskbar`. | `string` | `undefined` |
45
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. Permite determinar botões específicos ou gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
46
+ | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Define o nome do slot para elementos customizados na `Taskbar` principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
47
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando `true`, a tecla ENTER navega entre as células como a tecla TAB. | `boolean` | `false` |
48
+ | `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`. | `boolean` | `true` |
50
49
 
51
50
 
52
51
  ## Events
package/components/snk-pesquisa/readme.md CHANGED
@@ -18,20 +18,6 @@
18
18
  | `treeLoader` | -- | Função responsável por carregar a árvore hierárquica do componente. Opcional. Caso não seja fornecida, o modo árvore não estará disponível. | `(text: string) => Promise<any>` | `undefined` |
19
19
 
20
20
 
21
- ## Methods
22
-
23
- ### `executeSearch(text: string) => Promise<void>`
24
-
25
- * Executa uma pesquisa programaticamente.
26
- Útil para cenários onde a pesquisa precisa ser disparada sem interação do usuário.
27
-
28
- #### Returns
29
-
30
- Type: `Promise<void>`
31
-
32
-
33
-
34
-
35
21
  ## Dependencies
36
22
 
37
23
  ### Used by
package/components/snk-taskbar/readme.md CHANGED
@@ -11,7 +11,6 @@
11
11
  | --------------------- | --------------------- | ----------- | ------------------------------------------------------------------------------------------- | --------------------------- |
12
12
  | `actionsList` | -- | | `Action[]` | `undefined` |
13
13
  | `actionsSettingsList` | -- | | `Action[]` | `undefined` |
14
- | `additionalSlotId` | `additional-slot-id` | | `string` | `"TASKBAR_ADDITIONAL_SLOT"` |
15
14
  | `alignRigth` | `align-rigth` | | `boolean` | `false` |
16
15
  | `buttons` | `buttons` | | `string` | `undefined` |
17
16
  | `configName` | `config-name` | | `string` | `undefined` |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "10.1.0-dev.9",
3
+ "version": "10.1.0-rc.10",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [