@sankhyalabs/sankhyablocks-docs 0.0.0-feat-dev-KB-40478.1 → 0.0.0-feat-dev-KB-35648.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 (4) hide show
  1. package/components/snk-filter-bar/filter-modal/readme.md +12 -11
  2. package/components/snk-filter-bar/readme.md +8 -7
  3. package/components/snk-taskbar/readme.md +2 -0
  4. package/package.json +1 -1
package/components/snk-filter-bar/filter-modal/readme.md CHANGED
@@ -7,17 +7,18 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------------------------- | ------------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------- | ----------- |
12
- | `addPersonalizedFilter` | -- | Ação executada ao adicionar um filtro personalizado | `() => void` | `undefined` |
13
- | `applyFilters` | -- | Ação executada ao aplicar os filtros | `(updatedFilterConfig: SnkFilterItemConfig[]) => void` | `undefined` |
14
- | `closeModal` | -- | Ação disparada ao fechar o modal | `() => void` | `undefined` |
15
- | `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
16
- | `deletePersonalizedFilter` | -- | Ação executada ao deletar um filtro personalizado | `(filter: IPersonalizedFilter, configName: string) => void` | `undefined` |
17
- | `editPersonalizedFilter` | -- | Ação executada ao editar um filtro personalizado | `(id: string) => void` | `undefined` |
18
- | `filters` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
19
- | `filtersToDelete` | -- | Guarda filtros a serem deletados no Apply do modal | `IPersonalizedFilter[]` | `[]` |
20
- | `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- | ----------- |
12
+ | `addPersonalizedFilter` | -- | Ação executada ao adicionar um filtro personalizado | `() => void` | `undefined` |
13
+ | `applyFilters` | -- | Ação executada ao aplicar os filtros | `(updatedFilterConfig: SnkFilterItemConfig[]) => void` | `undefined` |
14
+ | `closeModal` | -- | Ação disparada ao fechar o modal | `() => void` | `undefined` |
15
+ | `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
16
+ | `deletePersonalizedFilter` | -- | Ação executada ao deletar um filtro personalizado | `(filter: IPersonalizedFilter, configName: string) => void` | `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
+ | `editPersonalizedFilter` | -- | Ação executada ao editar um filtro personalizado | `(id: string) => void` | `undefined` |
19
+ | `filters` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
20
+ | `filtersToDelete` | -- | Guarda filtros a serem deletados no Apply do modal | `IPersonalizedFilter[]` | `[]` |
21
+ | `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
21
22
 
22
23
 
23
24
  ## Dependencies
package/components/snk-filter-bar/readme.md CHANGED
@@ -7,13 +7,14 @@
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` |
16
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `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
+ | `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
+ | `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
16
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
17
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
17
18
 
18
19
 
19
20
  ## Events
package/components/snk-taskbar/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
+ | `alignRigth` | `align-rigth` | Usado para determinar O alinhamento dos items na taskbar. | `boolean` | `false` |
13
14
  | `buttons` | `buttons` | Lista separada por virgula, contendo todos os elementos a serem criados. | `string` | `undefined` |
14
15
  | `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
15
16
  | `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,6 +19,7 @@
18
19
  | `dataUnit` | -- | Instância do DataUnit. | `DataUnit` | `undefined` |
19
20
  | `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados. | `string[]` | `undefined` |
20
21
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
22
+ | `overflowStrategy` | `overflow-strategy` | Define como será o comportamento da taskbar quando ocorrer overflow | `"hiddenItems" \| "none"` | `'hiddenItems'` |
21
23
  | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
22
24
  | `primaryButton` | `primary-button` | Determina qual botão deve ter aparência primária. | `string` | `undefined` |
23
25
  | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "0.0.0-feat-dev-KB-40478.1",
3
+ "version": "0.0.0-feat-dev-KB-35648.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [