@dropi/react-native-design-system 0.1.9 → 0.1.10
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 +210 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,3 +1,213 @@
|
|
|
1
|
+
#
|
|
2
|
+
-
|
|
3
|
+
|
|
4
|
+
El **Design System de Dropi** para aplicaciones **React Native**. Este paquete reúne la base visual y funcional de nuestros productos móviles, ofreciendo **tokens de diseño, componentes reutilizables y patrones consistentes** para mantener la coherencia en la experiencia de usuario. Su objetivo es simplificar el desarrollo, acelerar la implementación de interfaces y garantizar que cada proyecto Dropi mantenga una identidad visual sólida y escalable.
|
|
5
|
+
# Tokens
|
|
6
|
+
## Radius
|
|
7
|
+
Tokens de radio de borde utilizados en todos los componentes para mantener una coherencia visual en las esquinas redondeadas.
|
|
8
|
+
|
|
9
|
+
Los tokens `radius` definen los niveles estándar de redondez de esquinas dentro del sistema de diseño.
|
|
10
|
+
Son valores numéricos expresados en píxeles, pensados para ser usados en cualquier componente que soporte propiedades de radio de borde (`borderRadius`).
|
|
11
|
+
Estos tokens aseguran una identidad visual consistente y permiten ajustar globalmente la suavidad de las esquinas con facilidad.
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
| Token | Valor | Descripción |
|
|
15
|
+
| ---------- | ----- | --------------------------------------------------------------------------------- |
|
|
16
|
+
| `none` | `0` | Sin radio de borde (esquinas rectas). |
|
|
17
|
+
| `border-1` | `4` | Redondeo sutil para elementos pequeños como etiquetas o insignias. |
|
|
18
|
+
| `border-2` | `8` | Radio estándar para la mayoría de los componentes. |
|
|
19
|
+
| `border-3` | `12` | Redondeo visible, ideal para tarjetas o modales. |
|
|
20
|
+
| `border-4` | `24` | Esquinas más pronunciadas, usadas en contenedores grandes o interactivos. |
|
|
21
|
+
| `border-5` | `32` | Redondeo máximo estándar, da una apariencia más expresiva. |
|
|
22
|
+
| `circle` | `50` | Radio perfecto para formar círculos (por ejemplo, avatares o botones circulares). |
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Spacing
|
|
27
|
+
Tokens de espaciado que definen los márgenes y rellenos estándar utilizados en todo el sistema de diseño.
|
|
28
|
+
|
|
29
|
+
Los tokens `spacing` controlan la separación visual entre elementos (márgenes, paddings, gaps, etc.). Su objetivo es mantener una **escala modular de espacios** coherente en todas las pantallas, tanto en **teléfonos como en tabletas**.
|
|
30
|
+
El valor de cada token se adapta automáticamente dependiendo del dispositivo:
|
|
31
|
+
si es una tableta (`isTablet = true`), los valores aumentan ligeramente para mantener una proporción visual equilibrada en pantallas más grandes.
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
| Token | Valor base (px) | En tablet (px) | Descripción |
|
|
35
|
+
| --------- | --------------- | -------------- | ------------------------------------------------------------------ |
|
|
36
|
+
| `size-1` | 4 | 12 | Espaciado mínimo, ideal para pequeños detalles visuales. |
|
|
37
|
+
| `size-2` | 8 | 16 | Margen corto entre textos o íconos. |
|
|
38
|
+
| `size-3` | 12 | 20 | Separación común en layouts compactos. |
|
|
39
|
+
| `size-4` | 16 | 24 | Espaciado estándar para la mayoría de los componentes. |
|
|
40
|
+
| `size-5` | 24 | 32 | Espaciado medio, común entre secciones. |
|
|
41
|
+
| `size-6` | 32 | 40 | Espaciado grande, ideal para pantallas amplias o bloques visuales. |
|
|
42
|
+
| `size-7` | 40 | 48 | Separación generosa entre bloques de contenido. |
|
|
43
|
+
| `size-8` | 48 | 56 | Margen grande para layouts aireados. |
|
|
44
|
+
| `size-9` | 56 | 64 | Espaciado extra grande, usado en vistas principales. |
|
|
45
|
+
| `size-10` | 64 | 72 | Máximo espaciado estándar del sistema. |
|
|
46
|
+
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Sizes
|
|
50
|
+
Tokens de tamaño tipográfico utilizados en el sistema de diseño para mantener una jerarquía visual clara y consistente entre dispositivos.
|
|
51
|
+
|
|
52
|
+
Los tokens `sizes` definen una escala modular de tamaños de texto (en píxeles), que se ajusta automáticamente al ancho del dispositivo y a la configuración del usuario (por ejemplo, el escalado de fuente del sistema operativo). De esta forma, el diseño mantiene la **proporción visual correcta** sin sacrificar accesibilidad.
|
|
53
|
+
El cálculo de cada tamaño depende de dos factores:
|
|
54
|
+
* **ancho de la pantalla**`Dimensions.get("window").width`
|
|
55
|
+
* **factor de escala de fuente**`PixelRatio.getFontScale()`
|
|
56
|
+
Gracias a esto, las fuentes se adaptan suavemente en tabletas o pantallas grandes sin distorsionar el diseño original.
|
|
57
|
+
|
|
58
|
+
```
|
|
59
|
+
| Token | Valor base (px) | Descripción |
|
|
60
|
+
| ------- | --------------- | ----------------------------------------------------- |
|
|
61
|
+
| `xxs` | 10 | Texto auxiliar o etiquetas pequeñas. |
|
|
62
|
+
| `xs` | 12 | Subtítulos o texto de apoyo en componentes compactos. |
|
|
63
|
+
| `s` | 14 | Texto secundario o descripciones. |
|
|
64
|
+
| `m` | 16 | Tamaño de texto base, ideal para párrafos. |
|
|
65
|
+
| `l` | 18 | Texto destacado o títulos pequeños. |
|
|
66
|
+
| `xl` | 20 | Encabezados medianos o botones grandes. |
|
|
67
|
+
| `xxl` | 24 | Títulos principales o énfasis visual. |
|
|
68
|
+
| `xxxl` | 28 | Secciones destacadas o headers grandes. |
|
|
69
|
+
| `xxxxl` | 32 | Títulos hero o pantallas de bienvenida. |
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Escalado interno:
|
|
74
|
+
```Typescript
|
|
75
|
+
const BASE_WIDTH = 440;
|
|
76
|
+
const rawScaleFactor = width / BASE_WIDTH;
|
|
77
|
+
const multiplier = rawScaleFactor > 1 ? 1 + (rawScaleFactor - 1) * 0.3 : rawScaleFactor;
|
|
78
|
+
```
|
|
79
|
+
Esto significa que:
|
|
80
|
+
Si la pantalla es más grande que la base, el texto aumenta gradualmente (hasta un 30% adicional).
|
|
81
|
+
Si la pantalla es más pequeña, el tamaño se ajusta proporcionalmente.
|
|
82
|
+
|
|
83
|
+
## Weights
|
|
84
|
+
Tokens de peso tipográfico utilizados para controlar la jerarquía visual y el énfasis dentro de los textos del sistema.
|
|
85
|
+
|
|
86
|
+
Los tokens `weights` establecen los distintos **niveles de grosor** de las fuentes usados en todos los componentes del sistema. Permiten mantener **consistencia tipográfica** en botones, títulos, subtítulos y párrafos, evitando el uso arbitrario de valores numéricos. Estos valores siguen la escala estándar de CSS para `fontWeight`, lo que garantiza compatibilidad con cualquier fuente que soporte pesos variables.
|
|
87
|
+
|
|
88
|
+
```
|
|
89
|
+
| Token | Valor | Descripción |
|
|
90
|
+
| ---------- | ------- | ----------------------------------------------------------- |
|
|
91
|
+
| `light` | `'300'` | Ideal para textos secundarios o información complementaria. |
|
|
92
|
+
| `regular` | `'400'` | Peso base para la mayoría de los textos. |
|
|
93
|
+
| `medium` | `'500'` | Ligeramente más grueso, usado en botones o subtítulos. |
|
|
94
|
+
| `semibold` | `'600'` | Para destacar encabezados o valores clave. |
|
|
95
|
+
| `bold` | `'700'` | Peso más alto, usado en títulos o llamadas a la acción. |
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
## Colors
|
|
99
|
+
Los tokens de color definen la **paleta cromática oficial de Dropi** para interfaces móviles. Están diseñados para ofrecer **consistencia visual**, **legibilidad** y **accesibilidad** tanto en modo claro como en modo oscuro.
|
|
100
|
+
|
|
101
|
+
Cada color está organizado por **familias cromáticas** (Primary, Secondary, Gray, Success, Error, Info, Warning) y subdividido en **niveles tonales** del `50` al `900`.
|
|
102
|
+
Esto permite crear jerarquías visuales precisas —por ejemplo, usar tonos `500` para elementos principales y `100`/`900` para fondos o bordes.
|
|
103
|
+
Cada token incluye dos variantes:
|
|
104
|
+
* `light`
|
|
105
|
+
* `dark`
|
|
106
|
+
De esta forma, el sistema puede alternar entre temas sin perder coherencia cromática ni contraste visual.
|
|
107
|
+
|
|
108
|
+
```
|
|
109
|
+
| Familia | Propósito principal |
|
|
110
|
+
| ------------- | ----------------------------------------------------------------------------------------------- |
|
|
111
|
+
| **Primary** | Color de marca principal. Se usa en botones primarios, íconos destacados y elementos de acción. |
|
|
112
|
+
| **Secondary** | Color de acento o refuerzo visual para elementos secundarios. |
|
|
113
|
+
| **Gray** | Escala neutra para fondos, textos y bordes. Define la estructura visual base. |
|
|
114
|
+
| **Success** | Representa estados exitosos, confirmaciones o acciones completadas. |
|
|
115
|
+
| **Error** | Indica errores, validaciones fallidas o acciones críticas. |
|
|
116
|
+
| **Info** | Se usa para mostrar información contextual o mensajes neutrales. |
|
|
117
|
+
| **Warning** | Señala advertencias, riesgos o acciones pendientes. |
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
# Átomos
|
|
121
|
+
# Textos
|
|
122
|
+
-
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
```Typescript
|
|
126
|
+
import { Body } from '@dropi/react-native-design-system';
|
|
127
|
+
```
|
|
128
|
+
### ⚙️ Props:
|
|
129
|
+
|
|
130
|
+
```
|
|
131
|
+
| Prop | Tipo | Descripción |
|
|
132
|
+
| --------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
|
|
133
|
+
| `type` | `'xs-regular' \| 'xs-medium' \| 's-regular' \| 's-medium' \| 'm-regular' \| 'm-medium' \| 'l-regular' \| 'l-medium'` | Define el tamaño y el peso del texto. |
|
|
134
|
+
| `style` | `TextStyle` | (Opcional) Estilos adicionales que se aplican al texto. |
|
|
135
|
+
| `...rest` | `TextProps` | Todas las props nativas de `Text` disponibles en React Native. |
|
|
136
|
+
|
|
137
|
+
```
|
|
138
|
+
### 🧩 Ejemplo de uso:
|
|
139
|
+
```Typescript
|
|
140
|
+
<Body type="m-regular"> Este es un texto de ejemplo utilizando el componente body </Body>
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
## Caption
|
|
144
|
+
El componente `Caption` representa textos pequeños de apoyo, utilizados principalmente para mostrar **etiquetas, subtítulos, o descripciones breves** dentro de la interfaz.
|
|
145
|
+
Forma parte de la familia tipográfica del sistema y mantiene proporciones ajustadas para espacios reducidos, con un _line-height_ ligeramente más compacto para optimizar la densidad visual.
|
|
146
|
+
|
|
147
|
+
### 📦 Importación:
|
|
148
|
+
```Typescript
|
|
149
|
+
import { Caption } from '@dropi/react-native-design-system';
|
|
150
|
+
```
|
|
151
|
+
### ⚙️ Props:
|
|
152
|
+
```
|
|
153
|
+
| Prop | Tipo | Descripción |
|
|
154
|
+
| --------- | -------------------------------------- | --------------------------------------------------------------- |
|
|
155
|
+
| `type` | `'s' \| 'm' \| 's-light' \| 'm-light'` | Define el tamaño y el peso del texto. |
|
|
156
|
+
| `style` | `TextStyle` | (Opcional) Estilos adicionales para personalizar la apariencia. |
|
|
157
|
+
| `...rest` | `TextProps` | Todas las props nativas disponibles en `Text` de React Native. |
|
|
158
|
+
```
|
|
159
|
+
### 🧩 Ejemplo de uso:
|
|
160
|
+
```
|
|
161
|
+
<Caption type="m">Última actualización</Caption>
|
|
162
|
+
|
|
163
|
+
<Caption type="s-light" style={{ color: '#999' }}>2 horas atrás</Caption>
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
## Heading
|
|
167
|
+
El componente `Heading` representa los **encabezados tipográficos** del sistema, usados para jerarquizar títulos, secciones y bloques de contenido.
|
|
168
|
+
Cada nivel (`h1` a `h5`) conserva proporciones equilibradas entre tamaño, peso y altura de línea, asegurando legibilidad sin romper la escala visual general de la aplicación.
|
|
169
|
+
|
|
170
|
+
### 📦 Importación:
|
|
171
|
+
```Typescript
|
|
172
|
+
import { Heading } from '@dropi/react-native-design-system';
|
|
173
|
+
```
|
|
174
|
+
### ⚙️ Props:
|
|
175
|
+
```
|
|
176
|
+
| Prop | Tipo | Descripción |
|
|
177
|
+
| --------- | -------------------------------------- | ------------------------------------------------------------- |
|
|
178
|
+
| `type` | `'h1' \| 'h2' \| 'h3' \| 'h4' \| 'h5'` | Define el nivel jerárquico del título. |
|
|
179
|
+
| `style` | `TextStyle` | (Opcional) Permite agregar estilos adicionales al encabezado. |
|
|
180
|
+
| `...rest` | `TextProps` | Cualquier prop nativa del componente `Text` de React Native. |
|
|
181
|
+
```
|
|
182
|
+
### 🧩 Ejemplo de uso:
|
|
183
|
+
```
|
|
184
|
+
<Heading type="h1">Bienvenido a la experiencia Dropi</Heading>
|
|
185
|
+
|
|
186
|
+
<Heading type="h4" style={{ color: '#666' }}>Configuración avanzada</Heading>
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
## Label
|
|
190
|
+
El componente `Label` se utiliza para mostrar **textos cortos de énfasis o identificación**, como títulos de campos, categorías, o etiquetas de estado.
|
|
191
|
+
Su diseño mantiene un tamaño reducido con alto contraste tipográfico (peso `bold`), lo que facilita su lectura incluso en elementos pequeños o componentes interactivos.
|
|
192
|
+
### 📦 Importación:
|
|
193
|
+
```Typescript
|
|
194
|
+
import { Label } from '@dropi/react-native-design-system';
|
|
195
|
+
```
|
|
196
|
+
### ⚙️ Props:
|
|
197
|
+
```
|
|
198
|
+
| Prop | Tipo | Descripción |
|
|
199
|
+
| --------- | ------------------- | ------------------------------------------------------------ |
|
|
200
|
+
| `type` | `'s' \| 'm' \| 'l'` | Define el tamaño de la etiqueta. |
|
|
201
|
+
| `style` | `TextStyle` | (Opcional) Estilos adicionales para personalización. |
|
|
202
|
+
| `...rest` | `TextProps` | Cualquier prop nativa del componente `Text` de React Native. |
|
|
203
|
+
```
|
|
204
|
+
### 🧩 Ejemplo de usu:
|
|
205
|
+
```Typescript
|
|
206
|
+
<Label type="m">Dirección</Label>
|
|
207
|
+
|
|
208
|
+
<Label type="s" style={{ color: '#999' }}>En proceso</Label>
|
|
209
|
+
```
|
|
210
|
+
|
|
1
211
|
|
|
2
212
|
# Botones
|
|
3
213
|
### Default Button:
|