@sankhyalabs/sankhyablocks-docs 0.0.0-feat-dev-KB-66081.0 → 0.0.0-feat-dev-KB-74201.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 (7) hide show
  1. package/components/snk-crud/readme.md +1 -0
  2. package/components/snk-crud/subcomponents/readme.md +1 -0
  3. package/components/snk-form-config/readme.md +6 -5
  4. package/package.json +1 -1
  5. package/components/snk-distinct-search/readme.md +0 -110
  6. package/components/snk-distinct-search/subcomponents/input-distinct-search/readme.md +0 -99
  7. package/components/snk-distinct-search/subcomponents/search-modal/readme.md +0 -121
package/components/snk-crud/readme.md CHANGED
@@ -20,6 +20,7 @@
20
20
  | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
21
21
  | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
22
22
  | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
23
+ | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
23
24
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
24
25
  | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
25
26
  | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -19,6 +19,7 @@
19
19
  | `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
20
20
  | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
21
21
  | `getCustomTitle` | -- | Fornece uma função para obter um título customizado do formulário. | `() => string` | `undefined` |
22
+ | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
22
23
  | `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
23
24
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
24
25
  | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `undefined` |
package/components/snk-form-config/readme.md CHANGED
@@ -7,11 +7,12 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | --------- | -------------------------------------------------------------------------------------- | ---------------------- | ----------- |
12
- | `configManager` | -- | Campos de configuração de formulário. | `SnkFormConfigManager` | `undefined` |
13
- | `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
14
- | `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
+ | `configManager` | -- | Campos de configuração de formulário. | `SnkFormConfigManager` | `undefined` |
13
+ | `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
14
+ | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
15
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
15
16
 
16
17
 
17
18
  ## Events
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "0.0.0-feat-dev-KB-66081.0",
3
+ "version": "0.0.0-feat-dev-KB-74201.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [
package/components/snk-distinct-search/readme.md DELETED
@@ -1,110 +0,0 @@
1
- # snk-distinct-search
2
-
3
-
4
-
5
- <!-- Auto Generated Below -->
6
-
7
-
8
- ## Properties
9
-
10
- | Property | Attribute | Description | Type | Default |
11
- | -------------- | ---------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
12
- | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `false` |
13
- | `configSearch` | -- | Dados para busca ao serviço. | `IConfigSearch` | `undefined` |
14
- | `debounceTime` | `debounce-time` | Tempo em milissegundos para debouncing das chamadas de busca de sugestões. | `number` | `300` |
15
- | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
16
- | `label` | `label` | Label apresentada no input. | `string` | `""` |
17
- | `maxItems` | `max-items` | Número máximo de itens na lista. | `number` | `100` |
18
- | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `'regular'` |
19
- | `restrict` | `restrict` | Expressão que define os caracteres permitidos na entrada. | `string` | `undefined` |
20
- | `value` | `value` | Valor inicial do campo. | `string` | `""` |
21
-
22
-
23
- ## Events
24
-
25
- | Event | Description | Type |
26
- | ------------- | -------------------------------------------------- | ----------------------------- |
27
- | `changeValue` | Emitido quando há uma alteração no valor do campo. | `CustomEvent<IDistinctValue>` |
28
-
29
-
30
- ## Methods
31
-
32
- ### `clearInput() => Promise<void>`
33
-
34
- Método para limpa o campo de entrada de pesquisa
35
-
36
- #### Returns
37
-
38
- Type: `Promise<void>`
39
-
40
-
41
-
42
- ### `closeModal() => Promise<void>`
43
-
44
- Método para fechar o modal
45
-
46
- #### Returns
47
-
48
- Type: `Promise<void>`
49
-
50
-
51
-
52
- ### `isInvalid() => Promise<boolean>`
53
-
54
- Retorna se o conteúdo é inválido.
55
-
56
- #### Returns
57
-
58
- Type: `Promise<boolean>`
59
-
60
-
61
-
62
- ### `openModal() => Promise<void>`
63
-
64
- Método para abrir o modal
65
-
66
- #### Returns
67
-
68
- Type: `Promise<void>`
69
-
70
-
71
-
72
- ### `setBlur() => Promise<void>`
73
-
74
- Remove o foco do campo
75
-
76
- #### Returns
77
-
78
- Type: `Promise<void>`
79
-
80
-
81
-
82
- ### `setFocus() => Promise<void>`
83
-
84
- Aplica o foco do campo
85
-
86
- #### Returns
87
-
88
- Type: `Promise<void>`
89
-
90
-
91
-
92
-
93
- ## Dependencies
94
-
95
- ### Depends on
96
-
97
- - [input-distinct-search](./subcomponents/input-distinct-search)
98
- - [search-modal](./subcomponents/search-modal)
99
-
100
- ### Graph
101
- ```mermaid
102
- graph TD;
103
- snk-distinct-search --> input-distinct-search
104
- snk-distinct-search --> search-modal
105
- style snk-distinct-search fill:#f9f,stroke:#333,stroke-width:4px
106
- ```
107
-
108
- ----------------------------------------------
109
-
110
-
package/components/snk-distinct-search/subcomponents/input-distinct-search/readme.md DELETED
@@ -1,99 +0,0 @@
1
- # input-distinct-search
2
-
3
-
4
-
5
- <!-- Auto Generated Below -->
6
-
7
-
8
- ## Properties
9
-
10
- | Property | Attribute | Description | Type | Default |
11
- | --------------- | ---------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
12
- | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `false` |
13
- | `debounceTime` | `debounce-time` | Tempo em milissegundos para debouncing das chamadas de busca de sugestões. | `number` | `300` |
14
- | `distinctItems` | -- | Lista completa de items distintos. | `string[]` | `[]` |
15
- | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
16
- | `label` | `label` | Label apresentada no input. | `string` | `""` |
17
- | `maxItems` | `max-items` | Número máximo de itens na lista. | `number` | `100` |
18
- | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `'regular'` |
19
- | `restrict` | `restrict` | Expressão que define os caracteres permitidos na entrada. | `string` | `undefined` |
20
- | `value` | `value` | Valor inicial do campo. | `string` | `""` |
21
-
22
-
23
- ## Events
24
-
25
- | Event | Description | Type |
26
- | ------------- | -------------------------------------------------- | ----------------------------- |
27
- | `changeValue` | Emitido quando há uma alteração no valor do campo. | `CustomEvent<IDistinctValue>` |
28
- | `iconClick` | Emitido quando o icone de pesquisa é clicado. | `CustomEvent<void>` |
29
-
30
-
31
- ## Methods
32
-
33
- ### `clearInput() => Promise<void>`
34
-
35
- Método para limpa o campo de entrada de pesquisa
36
-
37
- #### Returns
38
-
39
- Type: `Promise<void>`
40
-
41
-
42
-
43
- ### `isInvalid() => Promise<boolean>`
44
-
45
- Retorna se o conteúdo é inválido.
46
-
47
- #### Returns
48
-
49
- Type: `Promise<boolean>`
50
-
51
-
52
-
53
- ### `selectValue(value: string, isNewItem?: boolean) => Promise<void>`
54
-
55
- Seleciona um item
56
-
57
- #### Returns
58
-
59
- Type: `Promise<void>`
60
-
61
-
62
-
63
- ### `setBlur() => Promise<void>`
64
-
65
- Remove o foco do campo
66
-
67
- #### Returns
68
-
69
- Type: `Promise<void>`
70
-
71
-
72
-
73
- ### `setFocus() => Promise<void>`
74
-
75
- Aplica o foco do campo
76
-
77
- #### Returns
78
-
79
- Type: `Promise<void>`
80
-
81
-
82
-
83
-
84
- ## Dependencies
85
-
86
- ### Used by
87
-
88
- - [snk-distinct-search](../..)
89
-
90
- ### Graph
91
- ```mermaid
92
- graph TD;
93
- snk-distinct-search --> input-distinct-search
94
- style input-distinct-search fill:#f9f,stroke:#333,stroke-width:4px
95
- ```
96
-
97
- ----------------------------------------------
98
-
99
-
package/components/snk-distinct-search/subcomponents/search-modal/readme.md DELETED
@@ -1,121 +0,0 @@
1
- # search-modal
2
-
3
-
4
-
5
- <!-- Auto Generated Below -->
6
-
7
-
8
- ## Properties
9
-
10
- | Property | Attribute | Description | Type | Default |
11
- | -------------- | ---------------- | --------------------------------------------------------------------------------- | ----------------------- | ------------- |
12
- | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `false` |
13
- | `debounceTime` | `debounce-time` | Tempo em milissegundos para debouncing das chamadas de busca de sugestões. | `number` | `300` |
14
- | `emptyMessage` | `empty-message` | Recebe a mensagem de vazio ou personalizada | `HTMLElement \| string` | `undefined` |
15
- | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
16
- | `label` | `label` | Texto exibido como placeholder no campo de pesquisa. | `string` | `'Pesquisar'` |
17
- | `listItens` | -- | Lista de itens exibidas conforme o usuário digita. | `string[]` | `[]` |
18
- | `maxItens` | `max-itens` | Limita a quantidade de registros apresentados na tela | `number` | `100` |
19
- | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `'regular'` |
20
- | `opened` | `opened` | Define se o ez-popover está aberto. | `boolean` | `false` |
21
- | `restrict` | `restrict` | Expressão que define os caracteres permitidos na entrada. | `string` | `undefined` |
22
- | `value` | `value` | Define o valor do campo. | `string` | `undefined` |
23
-
24
-
25
- ## Events
26
-
27
- | Event | Description | Type |
28
- | ------------- | -------------------------------------------------- | ----------------------------- |
29
- | `changeValue` | Emitido quando há uma alteração no valor do campo. | `CustomEvent<IDistinctValue>` |
30
- | `popupClose` | Emitido ao fechar o popup | `CustomEvent<boolean>` |
31
-
32
-
33
- ## Methods
34
-
35
- ### `addNewItem() => Promise<void>`
36
-
37
- Método para adicionar a nova palavra e chamar o método closeModal() para fechar o modal
38
-
39
- #### Returns
40
-
41
- Type: `Promise<void>`
42
-
43
-
44
-
45
- ### `clearInput() => Promise<void>`
46
-
47
- Método para limpa o campo de entrada de pesquisa
48
-
49
- #### Returns
50
-
51
- Type: `Promise<void>`
52
-
53
-
54
-
55
- ### `closeModal() => Promise<void>`
56
-
57
- Método para fechar o modal
58
-
59
- #### Returns
60
-
61
- Type: `Promise<void>`
62
-
63
-
64
-
65
- ### `isInvalid() => Promise<void>`
66
-
67
- Retorna se o conteúdo é inválido.
68
-
69
- #### Returns
70
-
71
- Type: `Promise<void>`
72
-
73
-
74
-
75
- ### `openModal() => Promise<void>`
76
-
77
- Método para abrir o modal
78
-
79
- #### Returns
80
-
81
- Type: `Promise<void>`
82
-
83
-
84
-
85
- ### `setBlur() => Promise<void>`
86
-
87
- Remove o foco do campo
88
-
89
- #### Returns
90
-
91
- Type: `Promise<void>`
92
-
93
-
94
-
95
- ### `setFocus() => Promise<void>`
96
-
97
- Aplica o foco do campo
98
-
99
- #### Returns
100
-
101
- Type: `Promise<void>`
102
-
103
-
104
-
105
-
106
- ## Dependencies
107
-
108
- ### Used by
109
-
110
- - [snk-distinct-search](../..)
111
-
112
- ### Graph
113
- ```mermaid
114
- graph TD;
115
- snk-distinct-search --> search-modal
116
- style search-modal fill:#f9f,stroke:#333,stroke-width:4px
117
- ```
118
-
119
- ----------------------------------------------
120
-
121
-