@sankhyalabs/ezui-docs 0.0.0-feat-dev-KB-82131.0 → 0.0.0-feat-dev-KB-84302.2

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/ez-form/readme.md +7 -13
  2. package/components/ez-grid/readme.md +0 -4
  3. package/components/ez-popover/readme.md +0 -2
  4. package/components/ez-search/readme.md +0 -4
  5. package/components/ez-search-plus/readme.md +26 -26
  6. package/components/ez-skeleton/readme.md +12 -8
  7. package/components/ez-split-button/readme.md +11 -33
  8. package/package.json +1 -1
package/components/ez-form/readme.md CHANGED
@@ -7,15 +7,13 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
12
- | `config` | -- | Configuração do formulário. | `IFormConfig` | `undefined` |
13
- | `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` |
14
- | `elementFocusSearchField` | -- | Define uma ancoragem | `HTMLElement` | `undefined` |
15
- | `fieldToFocus` | `field-to-focus` | Determina o campo que deve ficar em evidência. | `string` | `undefined` |
16
- | `onlyStaticFields` | `only-static-fields` | Define se os campos que serão apresentados são todos estáticos. Quando verdadeira, ocorrerá no DataBinder o bind dos campos com o DataUnit. | `boolean` | `false` |
17
- | `recordsValidator` | -- | Define um validador responsável pela integridade dos registros. | `IRecordValidator` | `undefined` |
18
- | `useSearchField` | `use-search-field` | Define se o formulario deve exibir um buscador de coluna com uso do Ctrl+F | `boolean` | `true` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------ | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
12
+ | `config` | -- | Configuração do formulário. | `IFormConfig` | `undefined` |
13
+ | `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` |
14
+ | `fieldToFocus` | `field-to-focus` | Determina o campo que deve ficar em evidência. | `string` | `undefined` |
15
+ | `onlyStaticFields` | `only-static-fields` | Define se os campos que serão apresentados são todos estáticos. Quando verdadeira, ocorrerá no DataBinder o bind dos campos com o DataUnit. | `boolean` | `false` |
16
+ | `recordsValidator` | -- | Define um validador responsável pela integridade dos registros. | `IRecordValidator` | `undefined` |
19
17
 
20
18
 
21
19
  ## Events
@@ -66,17 +64,13 @@ Type: `Promise<void>`
66
64
  ### Depends on
67
65
 
68
66
  - [ez-tabselector](../ez-tabselector)
69
- - [ez-popover](../ez-popover)
70
67
  - [ez-form-view](../ez-form-view)
71
- - [ez-search](../ez-search)
72
68
 
73
69
  ### Graph
74
70
  ```mermaid
75
71
  graph TD;
76
72
  ez-form --> ez-tabselector
77
- ez-form --> ez-popover
78
73
  ez-form --> ez-form-view
79
- ez-form --> ez-search
80
74
  ez-tabselector --> ez-icon
81
75
  ez-form-view --> ez-custom-form-input
82
76
  ez-form-view --> ez-collapsible-box
package/components/ez-grid/readme.md CHANGED
@@ -28,9 +28,7 @@
28
28
  | `serverUrl` | `server-url` | Endereço do servidor para obtenção dos dados. | `string` | `undefined` |
29
29
  | `statusResolver` | -- | Define um `IStatusResolver` responsável pelo estado da coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` |
30
30
  | `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de chechbox deve ser suprimida | `boolean` | `false` |
31
- | `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir o scroll horizontal. | `boolean` | `false` |
32
31
  | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
33
- | `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de coluna com uso do Ctrl+F | `boolean` | `true` |
34
32
 
35
33
 
36
34
  ## Events
@@ -245,7 +243,6 @@ Type: `Promise<void>`
245
243
  - [ez-icon](../ez-icon)
246
244
  - [ez-button](../ez-button)
247
245
  - [filter-column](subcomponents)
248
- - [ez-search](../ez-search)
249
246
 
250
247
  ### Graph
251
248
  ```mermaid
@@ -254,7 +251,6 @@ graph TD;
254
251
  ez-grid --> ez-icon
255
252
  ez-grid --> ez-button
256
253
  ez-grid --> filter-column
257
- ez-grid --> ez-search
258
254
  ez-button --> ez-icon
259
255
  filter-column --> ez-popover-plus
260
256
  filter-column --> ez-button
package/components/ez-popover/readme.md CHANGED
@@ -70,13 +70,11 @@ Type: `Promise<void>`
70
70
 
71
71
  ### Used by
72
72
 
73
- - [ez-form](../ez-form)
74
73
  - [ez-grid](../ez-grid)
75
74
 
76
75
  ### Graph
77
76
  ```mermaid
78
77
  graph TD;
79
- ez-form --> ez-popover
80
78
  ez-grid --> ez-popover
81
79
  style ez-popover fill:#f9f,stroke:#333,stroke-width:4px
82
80
  ```
package/components/ez-search/readme.md CHANGED
@@ -97,9 +97,7 @@ Type: `Promise<void>`
97
97
 
98
98
  ### Used by
99
99
 
100
- - [ez-form](../ez-form)
101
100
  - [ez-form-view](../ez-form-view)
102
- - [ez-grid](../ez-grid)
103
101
  - [ez-multi-selection-list](../ez-multi-selection-list)
104
102
 
105
103
  ### Depends on
@@ -120,9 +118,7 @@ graph TD;
120
118
  ez-text-input --> ez-icon
121
119
  ez-popover-plus --> ez-popover-core
122
120
  search-list --> ez-card-item
123
- ez-form --> ez-search
124
121
  ez-form-view --> ez-search
125
- ez-grid --> ez-search
126
122
  ez-multi-selection-list --> ez-search
127
123
  style ez-search fill:#f9f,stroke:#333,stroke-width:4px
128
124
  ```
package/components/ez-search-plus/readme.md CHANGED
@@ -7,32 +7,32 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ---------------------------- | -------------------------------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
12
- | `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
13
- | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
14
- | `codLabel` | `cod-label` | Texto a ser apresentado no input de código. | `string` | `undefined` |
15
- | `contextProperties` | `context-properties` | Propriedades de contexto da aplicação. | `any` | `undefined` |
16
- | `disableCodeInput` | `disable-code-input` | Se true o campo de código ficara desabilitado. | `boolean` | `false` |
17
- | `disableDescriptionInput` | `disable-description-input` | Se true o campo de de apresentação ficara desabilitado. | `boolean` | `false` |
18
- | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
19
- | `ensureClearButtonVisible` | `ensure-clear-button-visible` | Garante que o botão de limpar pesquisa está sempre visível | `boolean` | `false` |
20
- | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
21
- | `hideDescriptionInput` | `hide-description-input` | Se true o campo de de apresentação não será exibido. | `boolean` | `false` |
22
- | `hideErrorOnFocusOut` | `hide-error-on-focus-out` | Propriedade depreciada na nova versão do componente de pesquisa. | `boolean` | `true` |
23
- | `ignoreLimitCharsToSearch` | `ignore-limit-chars-to-search` | Propriedade depreciada na nova versão do componente de pesquisa. | `boolean` | `false` |
24
- | `isTextSearch` | `is-text-search` | Propriedade depreciada na nova versão do componente de pesquisa. | `boolean` | `false` |
25
- | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
26
- | `listOptionsPosition` | -- | Propriedade depreciada na nova versão do componente de pesquisa. | `IEzCheckBoxListPosition` | `undefined` |
27
- | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
28
- | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument, ctxProperties?: any) => ISearchOption \| IOption \| (ISearchOption \| IOption)[] \| Promise<ISearchOption \| IOption \| (ISearchOption \| IOption)[]>` | `undefined` |
29
- | `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` |
30
- | `showSelectedValue` | `show-selected-value` | Propriedade depreciada na nova versão do componente de pesquisa. | `boolean` | `true` |
31
- | `stopPropagateEnterKeyEvent` | `stop-propagate-enter-key-event` | Se true, interrompe a propagação do evento de KeyDown da tecla enter | `boolean` | `false` |
32
- | `suppressEmptyOption` | `suppress-empty-option` | Propriedade depreciada na nova versão do componente de pesquisa. | `boolean` | `false` |
33
- | `suppressPreLoad` | `suppress-pre-load` | Propriedade depreciada na nova versão do componente de pesquisa. | `boolean` | `true` |
34
- | `suppressSearch` | `suppress-search` | Propriedade depreciada na nova versão do componente de pesquisa. | `boolean` | `false` |
35
- | `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
12
+ | `autoFocus` | `auto-focus` | Se true o campo de texto receberá o foco ao ser renderizado. | `boolean` | `false` |
13
+ | `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
14
+ | `codLabel` | `cod-label` | Texto a ser apresentado no input de código. | `string` | `undefined` |
15
+ | `contextProperties` | `context-properties` | Propriedades de contexto da aplicação. | `any` | `undefined` |
16
+ | `disableCodeInput` | `disable-code-input` | Se true o campo de código ficara desabilitado. | `boolean` | `false` |
17
+ | `disableDescriptionInput` | `disable-description-input` | Se true o campo de de apresentação ficara desabilitado. | `boolean` | `false` |
18
+ | `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
19
+ | `ensureClearButtonVisible` | `ensure-clear-button-visible` | Garante que o botão de limpar pesquisa está sempre visível | `boolean` | `false` |
20
+ | `errorMessage` | `error-message` | Define uma mensagem de orientação ao usuário, colocando o campo em modo inválido. | `string` | `undefined` |
21
+ | `hideDescriptionInput` | `hide-description-input` | Se true o campo de de apresentação não será exibido. | `boolean` | `false` |
22
+ | `hideErrorOnFocusOut` | `hide-error-on-focus-out` | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `boolean` | `true` |
23
+ | `ignoreLimitCharsToSearch` | `ignore-limit-chars-to-search` | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `boolean` | `false` |
24
+ | `isTextSearch` | `is-text-search` | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `boolean` | `false` |
25
+ | `label` | `label` | Texto a ser apresentado como título do campo. | `string` | `undefined` |
26
+ | `listOptionsPosition` | -- | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `IEzCheckBoxListPosition` | `undefined` |
27
+ | `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
28
+ | `optionLoader` | -- | Carrega as opções dinamicamente. | `(argument: ISearchArgument, ctxProperties?: any) => ISearchOption \| IOption \| (ISearchOption \| IOption)[] \| Promise<ISearchOption \| IOption \| (ISearchOption \| IOption)[]>` | `undefined` |
29
+ | `showOptionValue` | `show-option-value` | Se false cada opção na lista deve exibir somente o `label`. | `boolean` | `true` |
30
+ | `showSelectedValue` | `show-selected-value` | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `boolean` | `true` |
31
+ | `stopPropagateEnterKeyEvent` | `stop-propagate-enter-key-event` | Se true, interrompe a propagação do evento de KeyDown da tecla enter | `boolean` | `false` |
32
+ | `suppressEmptyOption` | `suppress-empty-option` | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `boolean` | `false` |
33
+ | `suppressPreLoad` | `suppress-pre-load` | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `boolean` | `true` |
34
+ | `suppressSearch` | `suppress-search` | <span style="color:red">**[DEPRECATED]**</span> Propriedade depreciada na nova versão do componente de pesquisa.<br/><br/> | `boolean` | `false` |
35
+ | `value` | `value` | Define o valor do campo. | `IOption \| string` | `undefined` |
36
36
 
37
37
 
38
38
  ## Events
package/components/ez-skeleton/readme.md CHANGED
@@ -7,14 +7,18 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | -------------- | --------------- | ------------------------------------------------- | ----------------------------------------------------- | ------------ |
12
- | `animation` | `animation` | Animation type | `"false" \| "progress" \| "progress-dark" \| "pulse"` | `'progress'` |
13
- | `count` | `count` | Number of rows of current skeleton type | `number` | `1` |
14
- | `height` | `height` | Height of the skeleton ex. 100px, 100%, auto etc. | `string` | `null` |
15
- | `marginBottom` | `margin-bottom` | MarginBottom of the skeleton ex. 10px, 0 etc. | `string` | `null` |
16
- | `variant` | `variant` | Variant of the skeleton - circle or row | `"circle" \| "rect" \| "text"` | `'text'` |
17
- | `width` | `width` | Width of the skeleton ex. 100px, 100%, auto etc. | `string` | `null` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------- | --------------- | ---------------------------------------------------------------------------- | ---------------------------------- | -------------------------- |
12
+ | `animation` | `animation` | Animation type | `"false" \| "progress" \| "pulse"` | `DEFAULT_VALUES.ANIMATION` |
13
+ | `count` | `count` | Number of rows of current skeleton type | `number` | `DEFAULT_VALUES.COUNT` |
14
+ | `height` | `height` | Height of the skeleton ex. 100px, 100%, auto etc. | `string` | `null` |
15
+ | `marginBottom` | `margin-bottom` | MarginBottom of the skeleton ex. 10px, 0 etc. | `string` | `null` |
16
+ | `marginLeft` | `margin-left` | MarginLeft of the skeleton ex. 10px, 0 etc. | `string` | `null` |
17
+ | `marginRight` | `margin-right` | MarginRight of the skeleton ex. 10px, 0 etc. | `string` | `null` |
18
+ | `marginTop` | `margin-top` | MarginTop of the skeleton ex. 10px, 0 etc. | `string` | `null` |
19
+ | `template` | `template` | The template to be used for the skeleton. Can be an HTMLElement or a string. | `HTMLElement \| string` | `undefined` |
20
+ | `variant` | `variant` | Variant of the skeleton - circle or row | `"circle" \| "rect" \| "text"` | `DEFAULT_VALUES.VARIANT` |
21
+ | `width` | `width` | Width of the skeleton ex. 100px, 100%, auto etc. | `string` | `null` |
18
22
 
19
23
 
20
24
  ## Dependencies
package/components/ez-split-button/readme.md CHANGED
@@ -7,19 +7,17 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | --------------- |
12
- | `enabled` | `enabled` | Se false o usuário não pode interagir com o botão. | `boolean` | `true` |
13
- | `iconName` | `icon-name` | Define o ícone a ser usado da biblioteca de ícones: [ez-icons](https://gilded-nasturtium-6b64dd.netlify.app/docs/components/layout-doc/icons/) | `string` | `undefined` |
14
- | `image` | `image` | Define o caminho usado nos modos `icon-only` e `icon-left` para imagens não contempladas na biblioteca de ícones. | `string` | `undefined` |
15
- | `itemBuilder` | -- | Função builder que possibilita alterar como o item da lista vai ser apresentado. Observação: No react ele se transforma em VNode e não como HTMLElement. | `(item: IDropdownItem, level: number) => string \| HTMLElement` | `undefined` |
16
- | `items` | -- | Define o conteúdo do dropdown. | `IDropdownItem[]` | `undefined` |
17
- | `label` | `label` | Texto a ser apresentado como label do botão. | `string` | `undefined` |
18
- | `leftTitle` | `left-title` | Texto a ser apresentado como title do botão principal | `string` | `undefined` |
19
- | `mode` | `mode` | Define o modo de uso do botão. | `"default" \| "icon-left" \| "icon-only"` | `'default'` |
20
- | `rightTitle` | `right-title` | Texto a ser apresentado como title do botão dropdown | `string` | `'Mais opções'` |
21
- | `show` | `show` | | `boolean` | `false` |
22
- | `size` | `size` | Define o tamanho do ez-split-button. | `"large" \| "medium" \| "small"` | `'medium'` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------ | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | --------------- |
12
+ | `enabled` | `enabled` | Se false o usuário não pode interagir com o botão. | `boolean` | `true` |
13
+ | `iconName` | `icon-name` | Define o ícone a ser usado da biblioteca de ícones: [ez-icons](https://gilded-nasturtium-6b64dd.netlify.app/docs/components/layout-doc/icons/) | `string` | `undefined` |
14
+ | `image` | `image` | Define o caminho usado nos modos `icon-only` e `icon-left` para imagens não contempladas na biblioteca de ícones. | `string` | `undefined` |
15
+ | `items` | -- | Define o conteúdo do dropdown. | `IDropdownItem[]` | `undefined` |
16
+ | `label` | `label` | Texto a ser apresentado como label do botão. | `string` | `undefined` |
17
+ | `leftTitle` | `left-title` | Texto a ser apresentado como title do botão principal | `string` | `undefined` |
18
+ | `mode` | `mode` | Define o modo de uso do botão. | `"default" \| "icon-left" \| "icon-only"` | `'default'` |
19
+ | `rightTitle` | `right-title` | Texto a ser apresentado como title do botão dropdown | `string` | `'Mais opções'` |
20
+ | `size` | `size` | Define o tamanho do ez-split-button. | `"large" \| "medium" \| "small"` | `'medium'` |
23
21
 
24
22
 
25
23
  ## Events
@@ -33,16 +31,6 @@
33
31
 
34
32
  ## Methods
35
33
 
36
- ### `isOpenedDropdown() => Promise<boolean>`
37
-
38
- Informa se a lista de ações está aberta.
39
-
40
- #### Returns
41
-
42
- Type: `Promise<boolean>`
43
-
44
-
45
-
46
34
  ### `setBlur() => Promise<void>`
47
35
 
48
36
  Remove o foco de ambos os botões.
@@ -73,16 +61,6 @@ Type: `Promise<void>`
73
61
 
74
62
 
75
63
 
76
- ### `toggleDropdown() => Promise<void>`
77
-
78
- Abre ou Fecha o dropdown do Split Button.
79
-
80
- #### Returns
81
-
82
- Type: `Promise<void>`
83
-
84
-
85
-
86
64
 
87
65
  ## Dependencies
88
66
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/ezui-docs",
3
- "version": "0.0.0-feat-dev-KB-82131.0",
3
+ "version": "0.0.0-feat-dev-KB-84302.2",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [