@sankhyalabs/ezui-docs 4.2.1 → 4.4.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.
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# ez-badge
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------ |
|
|
12
|
+
| `iconLeft` | `icon-left` | Define o ícone a ser usado no lado esquerdo do badge: [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html) | `string` | `undefined` |
|
|
13
|
+
| `iconRight` | `icon-right` | Define o ícone a ser usado no lado direito do badge: [ez-icons](https://sankhyalabs-storybook.herokuapp.com/themes/default/icons/fonts/index.html) | `string` | `undefined` |
|
|
14
|
+
| `label` | `label` | Define o conteúdo textual ou numérico do componente. | `string` | `undefined` |
|
|
15
|
+
| `position` | -- | Define a posição do ícone em relação ao elemento filho. | `IPosition` | `{ horizontal: "right", vertical: "top" }` |
|
|
16
|
+
| `size` | `size` | Define o tamanho de acordo com o tipo utilizado pelo componente. | `"extra-large" \| "extra-small" \| "large" \| "medium" \| "small" \| "small-medium"` | `"small"` |
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## Dependencies
|
|
20
|
+
|
|
21
|
+
### Depends on
|
|
22
|
+
|
|
23
|
+
- [ez-icon](../ez-icon)
|
|
24
|
+
|
|
25
|
+
### Graph
|
|
26
|
+
```mermaid
|
|
27
|
+
graph TD;
|
|
28
|
+
ez-badge --> ez-icon
|
|
29
|
+
style ez-badge fill:#f9f,stroke:#333,stroke-width:4px
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
----------------------------------------------
|
|
33
|
+
|
|
34
|
+
|
|
@@ -7,15 +7,16 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute
|
|
11
|
-
| -------------- |
|
|
12
|
-
| `asyncSearch` | `async-search`
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
15
|
-
| `
|
|
16
|
-
| `
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| -------------- | ---------------- | --------------------------------------------------------------------------------- | --------------------- | ----------- |
|
|
12
|
+
| `asyncSearch` | `async-search` | Define se o campo irá funcionar de forma assíncrona. | `boolean` | `false` |
|
|
13
|
+
| `canShowError` | `can-show-error` | Se false deixa de exibir a mensagem de erro dentro do campo. | `boolean` | `true` |
|
|
14
|
+
| `enabled` | `enabled` | Se false o usuário não pode interagir com o campo. | `boolean` | `true` |
|
|
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 a ser apresentado como título do campo. | `string` | `undefined` |
|
|
17
|
+
| `mode` | `mode` | Define o tamanho do campo. | `"regular" \| "slim"` | `"regular"` |
|
|
18
|
+
| `restrict` | `restrict` | Restringe o que o usuário pode digitar. | `string` | `undefined` |
|
|
19
|
+
| `value` | `value` | Define o valor do campo. | `string` | `undefined` |
|
|
19
20
|
|
|
20
21
|
|
|
21
22
|
## Events
|
|
@@ -20,6 +20,7 @@
|
|
|
20
20
|
|
|
21
21
|
- [ez-actions-button](../ez-actions-button)
|
|
22
22
|
- [ez-alert](../ez-alert)
|
|
23
|
+
- [ez-badge](../ez-badge)
|
|
23
24
|
- [ez-breadcrumb](../ez-breadcrumb)
|
|
24
25
|
- [ez-button](../ez-button)
|
|
25
26
|
- [ez-chip](../ez-chip)
|
|
@@ -40,6 +41,7 @@
|
|
|
40
41
|
graph TD;
|
|
41
42
|
ez-actions-button --> ez-icon
|
|
42
43
|
ez-alert --> ez-icon
|
|
44
|
+
ez-badge --> ez-icon
|
|
43
45
|
ez-breadcrumb --> ez-icon
|
|
44
46
|
ez-button --> ez-icon
|
|
45
47
|
ez-chip --> ez-icon
|
|
@@ -19,9 +19,10 @@
|
|
|
19
19
|
|
|
20
20
|
## Events
|
|
21
21
|
|
|
22
|
-
| Event
|
|
23
|
-
|
|
|
24
|
-
| `ezChange`
|
|
22
|
+
| Event | Description | Type |
|
|
23
|
+
| -------------- | ------------------------------------------------------- | ---------------------------------------- |
|
|
24
|
+
| `ezChange` | Emitido quando acontece a alteração de estado da lista. | `CustomEvent<(ListItem \| ListGroup)[]>` |
|
|
25
|
+
| `ezSelectItem` | Emitido sempre que um item da lista for selecionado. | `CustomEvent<ListItem>` |
|
|
25
26
|
|
|
26
27
|
|
|
27
28
|
## Methods
|