@dropi/ui 0.1.53 → 0.1.54
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/hydrate/index.js +86 -94
- package/hydrate/index.mjs +86 -94
- package/package.json +1 -1
- package/readme.md +85 -11
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -3,8 +3,10 @@
|
|
|
3
3
|
Librería de Web Components del Design System de Dropi, construida con **Stencil.js v4**.
|
|
4
4
|
Genera componentes de alto rendimiento para **Angular**, **React** y **Next.js** desde una única base de código.
|
|
5
5
|
|
|
6
|
-
- **Paquete npm:** [@dropi/ui](https://www.npmjs.com/package/@dropi/ui) (v0.1.
|
|
7
|
-
- **React wrappers:** [@dropi/ui-react](https://www.npmjs.com/package/@dropi/ui-react) (v0.1.
|
|
6
|
+
- **Paquete npm:** [@dropi/ui](https://www.npmjs.com/package/@dropi/ui) (v0.1.53)
|
|
7
|
+
- **React wrappers:** [@dropi/ui-react](https://www.npmjs.com/package/@dropi/ui-react) (v0.1.15)
|
|
8
|
+
- **Angular wrappers:** [@dropi/ui-angular](https://www.npmjs.com/package/@dropi/ui-angular) (v0.1.4)
|
|
9
|
+
- **Storybook:** [ui.dropi.co](https://ui.dropi.co)
|
|
8
10
|
|
|
9
11
|
> [!NOTE]
|
|
10
12
|
> Esta es una librería de uso interno y para partners autorizados. La documentación detallada del código fuente reside en nuestro repositorio privado de Bitbucket.
|
|
@@ -28,19 +30,91 @@ Este comando detectará tu framework e instalará automáticamente las dependenc
|
|
|
28
30
|
Si prefieres realizar la configuración paso a paso, consulta la [Guía de Integración Detallada](DROPI_UI_SETUP.md) o sigue estos pasos:
|
|
29
31
|
|
|
30
32
|
### 1. Paquetes
|
|
31
|
-
| Framework | Paquete a instalar |
|
|
32
|
-
|---|---|
|
|
33
|
-
| Angular | `npm install @dropi/ui @dropi/ui-angular` |
|
|
34
|
-
| React | `npm install @dropi/ui @dropi/ui-react` |
|
|
35
|
-
| Next.js SSR | `npm install @dropi/ui @dropi/ui-react && npm install --save-dev @stencil/ssr --legacy-peer-deps` |
|
|
36
33
|
|
|
37
|
-
|
|
38
|
-
|
|
34
|
+
**React / Vite**
|
|
35
|
+
```bash
|
|
36
|
+
yarn add @dropi/ui @dropi/ui-react dropi-lib-icons @stencil/react-output-target @lottiefiles/lottie-player
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
**Angular**
|
|
40
|
+
```bash
|
|
41
|
+
yarn add @dropi/ui @dropi/ui-angular dropi-lib-icons @lottiefiles/lottie-player
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
**Next.js SSR**
|
|
45
|
+
```bash
|
|
46
|
+
yarn add @dropi/ui @dropi/ui-react dropi-lib-icons @stencil/react-output-target @lottiefiles/lottie-player
|
|
47
|
+
yarn add -D @stencil/ssr --legacy-peer-deps
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
> [!IMPORTANT]
|
|
51
|
+
> `@stencil/react-output-target` es una **peer dependency** requerida. Siempre instálala junto con `@dropi/ui-react`.
|
|
52
|
+
|
|
53
|
+
### 2. Configurar CSS y Lottie en el punto de entrada
|
|
54
|
+
|
|
55
|
+
**React / Vite — `src/main.tsx`**
|
|
56
|
+
```tsx
|
|
57
|
+
import { defineCustomElements } from '@lottiefiles/lottie-player/dist/lottie-player';
|
|
58
|
+
import '@dropi/ui/dist/dropi-ui/dropi-ui.css';
|
|
59
|
+
|
|
60
|
+
defineCustomElements();
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
**Angular — `src/main.ts`**
|
|
64
|
+
```ts
|
|
65
|
+
import { defineCustomElements } from '@lottiefiles/lottie-player/dist/lottie-player';
|
|
66
|
+
import '@dropi/ui/dist/dropi-ui/dropi-ui.css';
|
|
67
|
+
|
|
68
|
+
defineCustomElements();
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
> [!NOTE]
|
|
72
|
+
> Si usas Angular con `angular.json`, también puedes agregar el CSS en la sección `styles`:
|
|
73
|
+
> ```json
|
|
74
|
+
> "styles": ["node_modules/@dropi/ui/dist/dropi-ui/dropi-ui.css"]
|
|
75
|
+
> ```
|
|
76
|
+
|
|
77
|
+
### 3. Estilos e Iconos
|
|
78
|
+
- **CSS**: Importar `@dropi/ui/dist/dropi-ui/dropi-ui.css` (ver paso 2).
|
|
39
79
|
- **CSS Resets**: Añade este reset para evitar saltos de layout en los iconos:
|
|
40
80
|
`dropi-icon:not(.hydrated) { width: 20px; height: 20px; display: inline-flex; }`
|
|
41
|
-
- **Registro**: No hace falta llamar `defineCustomElements()
|
|
81
|
+
- **Registro**: No hace falta llamar `defineCustomElements()` de `@dropi/ui` (solo el de lottie-player).
|
|
42
82
|
- **SSR (Next.js)**: Configurar `next.config.ts` e importar siempre desde `/next`.
|
|
43
|
-
- **Iconos**: El sprite SVG debe estar en `public/assets/icons/symbol/svg/sprite.css.svg`.
|
|
83
|
+
- **Iconos SVG**: El sprite SVG debe estar en `public/assets/icons/symbol/svg/sprite.css.svg`.
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## 📦 Peer Dependencies
|
|
88
|
+
|
|
89
|
+
Estas son las dependencias que el proyecto consumidor **debe tener instaladas**. Los paquetes de dropi-ui las declaran como `peerDependencies` y no las instalan automáticamente.
|
|
90
|
+
|
|
91
|
+
### Comunes (todos los frameworks)
|
|
92
|
+
|
|
93
|
+
| Paquete | Versión mínima | Para qué se usa |
|
|
94
|
+
|---|---|---|
|
|
95
|
+
| `@dropi/ui` | `>=0.1.53` | Web components base (Stencil) |
|
|
96
|
+
| `dropi-lib-icons` | `>=1.3.4` | Sprite SVG de íconos del sistema |
|
|
97
|
+
| `@lottiefiles/lottie-player` | `>=2.0.0` | Animaciones en `dropi-toast`, `dropi-alert-modal`, `dropi-lottie-loader` |
|
|
98
|
+
|
|
99
|
+
### Solo React / Next.js
|
|
100
|
+
|
|
101
|
+
| Paquete | Versión mínima | Para qué se usa |
|
|
102
|
+
|---|---|---|
|
|
103
|
+
| `react` | `>=17` | Framework React |
|
|
104
|
+
| `react-dom` | `>=17` | Renderizado React |
|
|
105
|
+
| `@dropi/ui-react` | `>=0.1.15` | Wrappers React para todos los componentes |
|
|
106
|
+
| `@stencil/react-output-target` | `>=1.5.0` | Requerido por `@dropi/ui-react` para el output de Stencil |
|
|
107
|
+
|
|
108
|
+
### Solo Angular
|
|
109
|
+
|
|
110
|
+
| Paquete | Versión mínima | Para qué se usa |
|
|
111
|
+
|---|---|---|
|
|
112
|
+
| `@angular/core` | `>=15` | Framework Angular |
|
|
113
|
+
| `@angular/common` | `>=15` | Módulos comunes de Angular |
|
|
114
|
+
| `@dropi/ui-angular` | `>=0.1.4` | Wrappers Angular para todos los componentes |
|
|
115
|
+
|
|
116
|
+
> [!TIP]
|
|
117
|
+
> Si ves el error `Cannot find module '@stencil/react-output-target'` asegúrate de que esté instalado aunque no lo uses directamente — es requerido en tiempo de compilación por `@dropi/ui-react`.
|
|
44
118
|
|
|
45
119
|
---
|
|
46
120
|
|