@zeedhi/zd-user-info-vue 1.3.4 → 3.0.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.
package/README.md CHANGED
@@ -1,161 +1,111 @@
1
- # ZdUserInfo
1
+ # Componente Field Group para Zeedhi
2
2
 
3
- Componente de UserInfo construído com o Zeedhi Next
4
-
5
- ## Instalação
6
-
7
- O ZdUserInfo é composto pelos pacotes `@zeedhi/zd-user-info-common` e `@zeedhi/zd-user-info-vue`.
8
- Utilize o comando abaixo para instalar ambos automaticamente:
9
-
10
- ```sh
11
- npm install @zeedhi/zd-user-info
12
- ```
13
-
14
- Ou instale os pacotes separadamente:
15
-
16
- ```sh
17
- npm install @zeedhi/zd-user-info-vue @zeedhi/zd-user-info-common
18
- ```
3
+ <p align="center">
4
+ <a href="#instalação">Instalação</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
5
+ <a href="#uso-básico">Uso Básico</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
6
+ <a href="#propriedades">Propriedades</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
7
+ </p>
19
8
 
20
- ### Dependências Adicionais
9
+ O component zd-user-info é um card capas de agrupar campos
21
10
 
22
- Por padrão, o ZdUserInfo fará uso do componente <a href="http://gitlab.teknisa.com/zeedhi/avatar" target="_blank">ZdAvatar</a> para renderizar o activator do Dropdown. Caso queira utilizar o activator padrão, instale também o ZdAvatar, mas caso não queira será necessário sobrescrever a propriedade activator (ver exemplos)
11
+ <p align="center">
12
+ <img alt="zd-user-info" src="./img/user-info.png" width="100%">
13
+ </p>
23
14
 
24
- ## Registro do Componente
15
+ ## Instalação
25
16
 
26
- Para registrá-lo, adicione o seguinte código ao inicializar a aplicação (por exemplo no arquivo `zeedhi.ts`)
17
+ Para instalar o pacote basta rodar o seguinte comando:\
18
+ `npm i @zeedhi/zd-user-info`\
19
+ Com isso, dois pacotes serão instalados: o @zeedhi/zd-user-info-common e o @zeedhi/zd-user-info-vue.\
20
+ Após a instalação, é necessário que você importe o pacote @zeedhi/zd-user-info-vue dentro de seu arquivo de configuração `zeedhi.ts`
27
21
 
28
- ```ts
29
- import Vue from 'vue';
30
- import { ZdUserInfo } from '@zeedhi/zd-user-info';
31
- // import { ZdUserInfo } from '@zeedhi/zd-user-info-vue'; caso tenha instalado os pacotes separadamente
22
+ ```shell
23
+ import { ZdFieldGroup } from '@zeedhi/zd-user-info-vue';
32
24
 
33
- Vue.component('ZdUserInfo', ZdUserInfo);
25
+ Vue.component('ZdFieldGroup', ZdFieldGroup);
34
26
  ```
35
27
 
28
+ Já o pacote @zeedhi/zd-user-info-common deve ser importado no arquivo controller do componente.
29
+
36
30
  ## Uso Básico
37
31
 
38
- Para utilizá-lo em um Metadata, basta definir a propriedade `component` como `"ZdUserInfo"`. Para definir o nome do usuário, defina a propriedade `user`, e para definir a imagem do usuário defina a propriedade `userImage`:
32
+ Para usar, defina a propriedade component como 'ZdFieldGroup'.
39
33
 
40
34
  ```json
41
35
  {
42
- "name": "card",
43
- "component": "ZdCard",
44
- "cssClass": "zd-display-flex zd-justify-end",
45
- "children": [
46
- {
47
- "name": "user-info",
48
- "component": "ZdUserInfo",
49
- "user": "Jane Doe",
50
- "userImage": "https://picsum.photos/id/1005/100/100.jpg",
51
- "minWidth": "200px"
52
- }
53
- ]
36
+ "name": "user-info-example",
37
+ "component": "ZdFieldGroup"
54
38
  }
55
39
  ```
56
40
 
57
- <p align="center" justify="center">
58
- <img src="./img/basic-usage-1.png" alt="Basic Usage"/>
59
- </p>
60
- <p align="center" justify="center">
61
- <img src="./img/basic-usage-2.png" alt="Basic Usage"/>
62
- </p>
63
-
64
-
65
41
  ## Propriedades
66
42
 
67
- | **Nome** | **Tipo** | **Padrão** | **Descrição** |
68
- |---------------------|----------------------|------------------------------------------------------------------------|-----------------------------------------------------------------------------------|
69
- | activator | IComponentRender | O activator padrão é um ZdAvatar com um Tooltip | Define o componente usado para ativar o menu |
70
- | avatarProps | IDictionary | \{\} | Props que serão passadas ao componente ZdAvatar |
71
- | bottomSlot | IComponentRender\[\] | \[\] | Define os componentes que serão renderizados na parte inferior do menu |
72
- | centerSlot | IComponentRender\[\] | O centerSlot padrão é um List com duas opções: alterar perfil e logout | Define os componentes que serão renderizados no centro do menu |
73
- | closeOnClick | boolean | true | Define se o menu irá fechar ao clicar fora do activator |
74
- | closeOnContentClick | boolean | true | Define se o menu deve fechar ao clicar em seu conteúdo |
75
- | fixed | boolean | false | Aplica position fixed ao menu |
76
- | headerSlot | IComponentRender[] | [] | Componentes que serão renderizados no cabeçalho do menu |
77
- | height | number \| string | 'auto' | Altura do menu |
78
- | imageProps | IDictionary | \{\} | Props que serão passadas ao componente ZdImage \(renderizado dentro do ZdAvatar\) |
79
- | offsetX | boolean | false | Desloca o menu pelo eixo x |
80
- | offsetY | boolean | true | Desloca o menu pelo eixo y |
81
- | openOnClick | boolean | true | Define se o menu deve abrir ao clicar no activator |
82
- | openOnHover | boolean | false | Define se o menu deve abrir ao passar o cursor sobre o activator |
83
- | maxHeight | number \| string | undefined | Altura máxima do menu |
84
- | maxWidth | number \| string | undefined | Largura máxima do menu |
85
- | minHeight | number \| string | undefined | Altura mínima do menu |
86
- | minWidth | number \| string | undefined | Largura mínima do menu |
87
- | topSlot | IComponentRender\[\] | \[\] | Componentes que serão renderizados na parte superior do menu |
88
- | user | string | '' | Nome do usuário |
89
- | userImage | string | '' | Imagem que será renderizada dentro do ZdAvatar |
90
- | value | boolean | false | Exibe ou esconde o menu |
91
-
92
-
93
- ## Eventos
94
-
95
- | **Nome** | **Parâmetros** | **Descrição** |
96
- |-----------------|----------------------------------------------|-----------------------------------------------|
97
- | onProfileChange | \{ component, element, event \}: IEventParam | Disparado ao clicar no item de alterar perfil |
98
- | onLogoutClick | \{ component, element, event \}: IEventParam | Disparado ao clicar no item de sair |
99
-
100
- ## Exemplos
101
-
102
- ### avatarProps e imageProps
103
-
104
- É possível sobrescrever as propriedades dos componentes ZdAvatar e ZdImage que são renderizados. No exemplo abaixo a propriedade `imageProps` é utilizada para melhorar a resolução da imagem, enquanto a propriedade `avatarProps` é utilizada para aumentar o tamanho do ZdAvatar:
105
-
106
- ```json
107
- {
108
- "name": "card",
109
- "component": "ZdCard",
110
- "cssClass": "zd-display-flex zd-justify-end",
111
- "children": [
112
- {
113
- "name": "user-info",
114
- "component": "ZdUserInfo",
115
- "user": "Jane Doe",
116
- "userImage": "https://picsum.photos/id/1005/200/200.jpg",
117
- "minWidth": "200px",
118
- "avatarProps": {
119
- "size": 62
120
- },
121
- "imageProps": {
122
- "height": "100px"
123
- }
124
- }
125
- ]
126
- }
127
- ```
128
-
129
- <p align="center" justify="center">
130
- <img src="./img/example-1.png" alt="Basic Usage"/>
131
- </p>
132
-
133
- ### Sobrescrevendo o activator
134
-
135
- Caso não queira utilizar o activator padrão do componente, basta sobrescrever a propriedade `activator`:
136
-
137
- ```json
138
- {
139
- "name": "card",
140
- "component": "ZdCard",
141
- "cssClass": "zd-display-flex zd-justify-end",
142
- "children": [
143
- {
144
- "name": "user-info",
145
- "component": "ZdUserInfo",
146
- "user": "Jane Doe",
147
- "minWidth": "200px",
148
- "activator": {
149
- "name": "user-button",
150
- "component": "ZdButton",
151
- "icon": true,
152
- "iconName": "mdi-account"
153
- }
154
- }
155
- ]
156
- }
157
- ```
158
-
159
- <p align="center" justify="center">
160
- <img src="./img/example-2.png" alt="Basic Usage"/>
161
- </p>
43
+ <table>
44
+ <thead>
45
+ <tr>
46
+ <th>Nome</th>
47
+ <th>Tipo</th>
48
+ <th>Default</th>
49
+ <th>Descrição</th>
50
+ </tr>
51
+ </thead>
52
+ <tbody>
53
+ <tr>
54
+ <td>disableActionRotate</td>
55
+ <td>boolean | string</td>
56
+ <td>true</td>
57
+ <td>Desativa a animação de rotação de ação ao expandir ou recolher o cartão recolhido</td>
58
+ </tr>
59
+ <tr>
60
+ <td>expandButton</td>
61
+ <td>IButton</td>
62
+ <td>undefined</td>
63
+ <td>Se definido, substitui o ícone de expansão pelo botão definido</td>
64
+ </tr>
65
+ <tr>
66
+ <td>expanded</td>
67
+ <td>boolean | string</td>
68
+ <td>false</td>
69
+ <td>Define se o componente está aberto ou fecahdo</td>
70
+ </tr>
71
+ <tr>
72
+ <td>header</td>
73
+ <td>IComponent[]</td>
74
+ <td>[]</td>
75
+ <td>Componentes a serem exibidos no cabeçalho</td>
76
+ </tr>
77
+ <tr>
78
+ <td>hideAction</td>
79
+ <td>boolean | string</td>
80
+ <td>false</td>
81
+ <td>Oculta o ícone de expansão</td>
82
+ </tr>
83
+ <tr>
84
+ <td>iconColor</td>
85
+ <td>string</td>
86
+ <td>var(--v-primary-base)</td>
87
+ <td>Define a cor do icone de expansão</td>
88
+ </tr>
89
+ <tr>
90
+ <td>iconName</td>
91
+ <td>string</td>
92
+ <td>expand</td>
93
+ <td>Define o icone de expansão</p>
94
+ </td>
95
+ </tr>
96
+ <tr>
97
+ <td>lazyLoad</td>
98
+ <td>boolean</td>
99
+ <td>boolean | string</td>
100
+ <td>O conteúdo será carregado somente quando o cartão recolhido for aberto</td>
101
+ </tr>
102
+ <tr>
103
+ <td>readonly</td>
104
+ <td>boolean | string</td>
105
+ <td>false</td>
106
+ <td>Torna o cartão recolhido somente leitura. Faz a mesma coisa que o suporte desativado, mas não altera os estilos</td>
107
+ </tr>
108
+ </tbody>
109
+ </table>
110
+
111
+ <hr>