Skip to content

Commit 5ec10c9

Browse files
committed
Add page for UI kit
1 parent 3a505ca commit 5ec10c9

4 files changed

Lines changed: 72 additions & 3 deletions

File tree

docs.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -685,6 +685,13 @@
685685
]
686686
}
687687
]
688+
},
689+
{
690+
"tab": "Kit de UI",
691+
"icon": "shapes",
692+
"pages": [
693+
"es/uikit/overview"
694+
]
688695
}
689696
],
690697
"navbar": {

es/uikit/overview.mdx

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: Kit de UI de Gamificación
3+
mode: wide
4+
---
5+
6+
<Frame>
7+
<img
8+
height="200"
9+
width="100%"
10+
noZoom
11+
src="../../assets/uikit/hero.png"
12+
/>
13+
</Frame>
14+
15+
El Kit de UI de Gamificación de Trophy es una biblioteca de componentes construida sobre [shadcn/ui](https://ui.shadcn.com) que te ayuda a crear experiencias de gamificación más rápido. Proporciona componentes prediseñados para rachas, logros, clasificaciones, puntos y más.
16+
17+
El Kit de UI está diseñado para funcionar con cualquier plataforma de gamificación, pero todas las props y formas de datos están diseñadas intencionalmente para trabajar sin problemas con Trophy.
18+
19+
## Requisitos Previos {#prerequisites}
20+
21+
- **React 18+** — Los componentes son React del lado del cliente.
22+
- **Tailwind v4+** — El estilo utiliza clases de utilidad de Tailwind. Configura Tailwind para que esas clases se compilen, y agrega los [tokens de tema semántico](https://ui.trophy.so/docs/styles) que Trophy espera (o mapéalos a tu sistema de diseño).
23+
- **Estructura de shadcn/ui** — Mantén un proyecto que ya siga la configuración de [shadcn/ui](https://ui.shadcn.com/docs/installation) (`components.json`, alias y diseño opcional `src/`).
24+
25+
## Comenzar {#getting-started}
26+
27+
Los componentes están disponibles a través del CLI de shadcn:
28+
29+
```bash
30+
npx shadcn@latest add https://ui.trophy.so/<component>
31+
```
32+
33+
Por ejemplo, para instalar el componente Insignia de Racha:
34+
35+
```bash
36+
npx shadcn@latest add https://ui.trophy.so/streak-badge
37+
```
38+
39+
Una vez que un componente está instalado, puedes importarlo y usarlo como cualquier otro componente de React. Los archivos se agregan a tu proyecto (el mismo modelo de [código abierto](https://ui.shadcn.com/docs) que shadcn/ui), por lo que puedes ajustar el marcado y alinear los estilos con tu sistema de diseño.
40+
41+
Por ejemplo, después de instalar el componente [Insignia de Racha](https://ui.trophy.so/streak-badge), puedes componerlo en una página como la siguiente:
42+
43+
```tsx
44+
"use client"
45+
46+
import { StreakBadge } from "@/components/ui/streak-badge"
47+
48+
export default function Page() {
49+
const streak = 7
50+
51+
return (
52+
<div className="flex items-center justify-center p-8">
53+
<StreakBadge length={streak} />
54+
</div>
55+
)
56+
}
57+
```
58+
59+
La ruta de importación predeterminada es `@/components/ui/<component>`. Si tu `components.json` usa otro directorio o alias, actualiza la importación para que coincida.
60+
61+
Para props, variantes y formas de datos, usa la sección API de cada componente en su página de documentación—consulta [Todos los componentes](https://ui.trophy.so/docs/components) para ver la lista completa.

i18n.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@
3333
"webhooks/events/achievements/*.mdx",
3434
"webhooks/events/leaderboards/*.mdx",
3535
"webhooks/events/points/*.mdx",
36-
"webhooks/events/streaks/*.mdx"
36+
"webhooks/events/streaks/*.mdx",
37+
"uikit/*.mdx"
3738
],
3839
"exclude": [
3940
"snippets/*.mdx",

uikit/overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: UI Kit
3-
mode: center
2+
title: Gamification UI Kit
3+
mode: wide
44
---
55

66
<Frame>

0 commit comments

Comments
 (0)