@cupcodev/ui 1.0.2 → 1.0.7

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,99 +1,150 @@
1
- ## @cupcodev/ui
2
-
3
- Design system Cupcode pronto para uso (componentes React + estilos + presets Tailwind).
4
-
5
- ### Instalação
6
-
7
- ```bash
8
- npm install @cupcodev/ui
9
- ```
10
-
11
- Além do pacote, instale as peer dependencies listadas em `peerDependencies` (React 18, Tailwind 3, Radix UI, etc.). Um comando típico:
12
-
13
- ```bash
14
- npm install react react-dom tailwindcss class-variance-authority tailwind-merge lucide-react next-themes react-router-dom \
15
- cmdk embla-carousel-react input-otp react-day-picker react-resizable-panels recharts sonner vaul \
16
- @radix-ui/react-accordion @radix-ui/react-alert-dialog @radix-ui/react-aspect-ratio @radix-ui/react-avatar \
17
- @radix-ui/react-checkbox @radix-ui/react-collapsible @radix-ui/react-context-menu @radix-ui/react-dialog \
18
- @radix-ui/react-dropdown-menu @radix-ui/react-hover-card @radix-ui/react-label @radix-ui/react-menubar \
19
- @radix-ui/react-navigation-menu @radix-ui/react-popover @radix-ui/react-progress @radix-ui/react-radio-group \
20
- @radix-ui/react-scroll-area @radix-ui/react-select @radix-ui/react-separator @radix-ui/react-slider \
21
- @radix-ui/react-slot @radix-ui/react-switch @radix-ui/react-tabs @radix-ui/react-toast @radix-ui/react-toggle \
22
- @radix-ui/react-toggle-group @radix-ui/react-tooltip tailwindcss-animate @tailwindcss/typography
1
+ ## @cupcodev/ui
2
+
3
+ Design system Cupcode pronto para uso (componentes React + estilos + preset Tailwind).
4
+
5
+ ### Instalação
6
+
7
+ ```bash
8
+ npm install @cupcodev/ui
9
+ ```
10
+
11
+ Além do pacote, instale as peer dependencies listadas em `peerDependencies` (React 18, Tailwind 3, Radix UI, etc.). Um comando típico:
12
+
13
+ ```bash
14
+ npm install react react-dom tailwindcss class-variance-authority tailwind-merge lucide-react \
15
+ cmdk date-fns embla-carousel-react input-otp react-day-picker react-resizable-panels recharts sonner vaul \
16
+ @radix-ui/react-accordion @radix-ui/react-alert-dialog @radix-ui/react-aspect-ratio @radix-ui/react-avatar \
17
+ @radix-ui/react-checkbox @radix-ui/react-collapsible @radix-ui/react-context-menu @radix-ui/react-dialog \
18
+ @radix-ui/react-dropdown-menu @radix-ui/react-hover-card @radix-ui/react-label @radix-ui/react-menubar \
19
+ @radix-ui/react-navigation-menu @radix-ui/react-popover @radix-ui/react-progress @radix-ui/react-radio-group \
20
+ @radix-ui/react-scroll-area @radix-ui/react-select @radix-ui/react-separator @radix-ui/react-slider \
21
+ @radix-ui/react-slot @radix-ui/react-switch @radix-ui/react-tabs @radix-ui/react-toast @radix-ui/react-toggle \
22
+ @radix-ui/react-toggle-group @radix-ui/react-tooltip tailwindcss-animate @tailwindcss/typography
23
+ ```
24
+
25
+ Compatibilidade de runtime: Node.js `>=18.18.0`.
26
+ Compatibilidade de estilo: Tailwind CSS v3 (`tailwindcss@^3.4.x`).
27
+ Gerenciador oficial: `npm` (lockfile único: `package-lock.json`).
28
+
29
+ ### Tailwind (obrigatorio para `styles.css`)
30
+
31
+ Use o preset disponibilizado pelo pacote:
32
+
33
+ ```js
34
+ // tailwind.config.js
35
+ module.exports = {
36
+ presets: [require("@cupcodev/ui/tailwind-preset.cjs")],
37
+ content: [
38
+ "./src/**/*.{ts,tsx}",
39
+ "./node_modules/@cupcodev/ui/dist/**/*.{js,jsx}",
40
+ ],
41
+ };
42
+ ```
43
+
44
+ E importe os estilos completos:
45
+
46
+ ```ts
47
+ import "@cupcodev/ui/styles.css";
23
48
  ```
24
49
 
25
- ### Tailwind
26
-
27
- Use o preset disponibilizado pelo pacote:
28
-
29
- ```js
30
- // tailwind.config.js
31
- module.exports = {
32
- presets: [require("@cupcodev/ui/tailwind-preset.cjs")],
33
- content: [
34
- "./src/**/*.{ts,tsx}", // ajuste para o seu projeto
35
- "./node_modules/@cupcodev/ui/dist/**/*.{js,jsx}", // necessário para as classes dos componentes
36
- ],
37
- };
38
- ```
39
-
40
- E importe os estilos globais (tokens + reset):
50
+ Se voce quiser apenas variaveis + base minima (sem classes utilitarias/glass/dock), use:
41
51
 
42
52
  ```ts
43
- import "@cupcodev/ui/styles/global.css";
53
+ import "@cupcodev/ui/styles/base.css";
44
54
  ```
45
55
 
46
- ### Uso básico
47
-
48
- ```tsx
49
- import { Button } from "@cupcodev/ui";
50
-
51
- export default function Example() {
52
- return <Button variant="default">Oi Cupcode</Button>;
53
- }
54
- ```
55
-
56
- Todos os componentes Cupcode e shadcn/ui base são reexportados de `@cupcodev/ui`. Exemplo:
57
-
58
- ```ts
59
- import { NavbarCupcode, ThemeToggle, Card } from "@cupcodev/ui";
60
- ```
61
-
62
- Para importações segmentadas, há submódulos como `@cupcodev/ui/charts`, que expõe apenas os componentes de gráficos/carrossel.
63
-
64
- ### Tema / Dark mode
65
-
66
- O `ThemeToggle` depende de [next-themes](https://github.com/pacocoursey/next-themes). Adicione o provider na raiz do app:
67
-
68
- ```tsx
69
- import { ThemeProvider } from "next-themes";
70
-
71
- export function App() {
72
- return (
73
- <ThemeProvider attribute="class" defaultTheme="system" enableSystem>
74
- {/* sua aplicação */}
75
- </ThemeProvider>
76
- );
77
- }
78
-
79
- No Next.js (app router), coloque o provider em `layout.tsx`; em Vite/CRA, envolva a raiz.
80
-
81
- ### Peers
82
-
83
- | Pacote | Versão mínima | Uso no DS |
84
- | --- | --- | --- |
85
- | `react`, `react-dom` | ^18.3.1 | base dos componentes |
86
- | `tailwindcss` | ^3.4.17 | util classes + preset |
87
- | `class-variance-authority`, `tailwind-merge` | ^0.7.1 / ^2.6.0 | variantes e merge de classes |
88
- | `lucide-react` | ^0.462.0 | ícones |
89
- | `next-themes` | ^0.3.0 | controle de tema (ThemeToggle) |
90
- | `@radix-ui/*` | conforme `package.json` | primitives dos componentes shadcn |
91
- | `cmdk`, `embla-carousel-react`, `react-day-picker`, `input-otp`, `react-resizable-panels`, `recharts`, `sonner`, `vaul` | conforme `package.json` | componentes específicos (command palette, carousel, calendário, OTP, panels, charts, toasts, drawers) |
92
- | `tailwindcss-animate`, `@tailwindcss/typography` | ^1.0.7 / ^0.5.16 | plugins usados pelo preset |
93
-
94
- Consulte `peerDependencies` para a lista completa ao instalar.
95
- ```
96
-
97
- ### Tipos e superfícies
98
-
99
- Os componentes são exportados via `export { Component }` (ex.: `export { default as DockWrapper }`). Importe sempre de `@cupcodev/ui` para garantir que os tipos e estilos correspondentes estejam alinhados.
56
+ Importante:
57
+ - `styles.css` pressupoe Tailwind + preset configurados no app consumidor.
58
+ - `styles/global.css` nao deve ser usado isoladamente, porque nao inclui os tokens.
59
+ - `styles/base.css` e o entrypoint seguro para tema/tokens quando voce nao quer carregar o pacote visual completo.
60
+
61
+ ### Uso básico
62
+
63
+ ```tsx
64
+ import { Button } from "@cupcodev/ui";
65
+
66
+ export default function Example() {
67
+ return <Button variant="default">Oi Cupcode</Button>;
68
+ }
69
+ ```
70
+
71
+ Todos os componentes Cupcode e shadcn/ui base são reexportados de `@cupcodev/ui`.
72
+
73
+ ### MainNavbar sem router obrigatório
74
+
75
+ `MainNavbar` não depende de `react-router-dom`. Para integração SPA, passe `pathname` e `onNavigate`:
76
+
77
+ ```tsx
78
+ import { MainNavbar } from "@cupcodev/ui";
79
+ import { useLocation, useNavigate } from "react-router-dom";
80
+
81
+ export function Header() {
82
+ const location = useLocation();
83
+ const navigate = useNavigate();
84
+
85
+ return (
86
+ <MainNavbar
87
+ pathname={location.pathname}
88
+ onNavigate={(href) => navigate(href)}
89
+ />
90
+ );
91
+ }
92
+ ```
93
+
94
+ ### ThemeToggle sem next-themes obrigatório
95
+
96
+ `ThemeToggle` alterna a classe `dark` no `document.documentElement` quando usado de forma não-controlada:
97
+
98
+ ```tsx
99
+ import { ThemeToggle } from "@cupcodev/ui";
100
+
101
+ export function HeaderActions() {
102
+ return <ThemeToggle />;
103
+ }
104
+ ```
105
+
106
+ Modo controlado (opcional):
107
+
108
+ ```tsx
109
+ <ThemeToggle theme={theme} onThemeChange={setTheme} />
110
+ ```
111
+
112
+ ### Qualidade e CI
113
+
114
+ Validações automatizadas disponíveis no projeto:
115
+
116
+ ```bash
117
+ npm run lint
118
+ npm run typecheck
119
+ npm run build:lib
120
+ npm run build:site
121
+ npm run test:consumer
122
+ ```
123
+
124
+ - `lint` roda com `--max-warnings=0` (qualquer warning quebra o gate).
125
+ - `typecheck`: valida tipos com `tsc -b` usando as configs estritas do projeto.
126
+ - `build:lib`: gera o pacote publicável (`dist`) via `tsup` sem sourcemaps.
127
+ - `build:site`: gera somente o site/docs via Vite.
128
+ - `test:consumer`: cria um projeto externo temporário, instala o tarball de `@cupcodev/ui` e valida `typecheck + build`.
129
+ - `prepublishOnly` executa `check:release` (`lint + typecheck + build:lib`) antes de qualquer publicação.
130
+ - Pipeline CI em `.github/workflows/ci.yml` roda `check:release`, `build:site` e `test:consumer` em todo push/PR.
131
+
132
+ App de consumo real versionado: `examples/vite-consumer`.
133
+
134
+ ### Peers
135
+
136
+ | Pacote | Versão mínima | Uso no DS |
137
+ | --- | --- | --- |
138
+ | `react`, `react-dom` | ^18.3.1 | base dos componentes |
139
+ | `tailwindcss` | ^3.4.17 | util classes + preset |
140
+ | `class-variance-authority`, `tailwind-merge` | ^0.7.1 / ^2.6.0 | variantes e merge de classes |
141
+ | `lucide-react` | ^0.462.0 | ícones |
142
+ | `@radix-ui/*` | conforme `package.json` | primitives dos componentes shadcn |
143
+ | `cmdk`, `date-fns`, `embla-carousel-react`, `react-day-picker`, `input-otp`, `react-resizable-panels`, `recharts`, `sonner`, `vaul` | conforme `package.json` | componentes específicos |
144
+ | `tailwindcss-animate`, `@tailwindcss/typography` | ^1.0.7 / ^0.5.16 | plugins usados pelo preset |
145
+
146
+ Consulte `peerDependencies` para a lista completa ao instalar.
147
+
148
+ ### Tipos e superfícies
149
+
150
+ Importe de `@cupcodev/ui` para manter tipos e estilos alinhados. Para gráficos, use também o submódulo `@cupcodev/ui/charts`.
@@ -9,10 +9,10 @@ import * as class_variance_authority_types from 'class-variance-authority/types'
9
9
  import { VariantProps } from 'class-variance-authority';
10
10
  import useEmblaCarousel, { UseEmblaCarouselType } from 'embla-carousel-react';
11
11
 
12
- declare const buttonVariants: (props?: {
13
- variant?: "link" | "default" | "secondary" | "outline" | "destructive" | "ghost";
14
- size?: "default" | "sm" | "lg" | "icon";
15
- } & class_variance_authority_types.ClassProp) => string;
12
+ declare const buttonVariants: (props?: ({
13
+ variant?: "link" | "secondary" | "outline" | "default" | "destructive" | "ghost" | null | undefined;
14
+ size?: "sm" | "lg" | "default" | "icon" | null | undefined;
15
+ } & class_variance_authority_types.ClassProp) | undefined) => string;
16
16
  interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement>, VariantProps<typeof buttonVariants> {
17
17
  asChild?: boolean;
18
18
  }
@@ -57,7 +57,7 @@ declare const ChartContainer: React.ForwardRefExoticComponent<Omit<React.ClassAt
57
57
  declare const ChartStyle: ({ id, config }: {
58
58
  id: string;
59
59
  config: ChartConfig;
60
- }) => react_jsx_runtime.JSX.Element;
60
+ }) => react_jsx_runtime.JSX.Element | null;
61
61
  declare const ChartTooltip: typeof RechartsPrimitive.Tooltip;
62
62
  declare const ChartTooltipContent: React.ForwardRefExoticComponent<Omit<RechartsPrimitive.DefaultTooltipContentProps<recharts_types_component_DefaultTooltipContent.ValueType, recharts_types_component_DefaultTooltipContent.NameType> & {
63
63
  accessibilityLayer?: boolean;
@@ -66,14 +66,14 @@ declare const ChartTooltipContent: React.ForwardRefExoticComponent<Omit<Recharts
66
66
  allowEscapeViewBox?: recharts_types_util_types.AllowInDimension;
67
67
  animationDuration?: recharts_types_util_types.AnimationDuration;
68
68
  animationEasing?: recharts_types_util_types.AnimationTiming;
69
- content?: recharts_types_component_Tooltip.ContentType<recharts_types_component_DefaultTooltipContent.ValueType, recharts_types_component_DefaultTooltipContent.NameType>;
69
+ content?: recharts_types_component_Tooltip.ContentType<recharts_types_component_DefaultTooltipContent.ValueType, recharts_types_component_DefaultTooltipContent.NameType> | undefined;
70
70
  coordinate?: Partial<recharts_types_util_types.Coordinate>;
71
71
  cursor?: boolean | React.ReactElement | React.SVGProps<SVGElement>;
72
72
  filterNull?: boolean;
73
73
  defaultIndex?: number;
74
74
  isAnimationActive?: boolean;
75
75
  offset?: number;
76
- payloadUniqBy?: recharts_types_util_payload_getUniqPayload.UniqueOption<recharts_types_component_DefaultTooltipContent.Payload<recharts_types_component_DefaultTooltipContent.ValueType, recharts_types_component_DefaultTooltipContent.NameType>>;
76
+ payloadUniqBy?: recharts_types_util_payload_getUniqPayload.UniqueOption<recharts_types_component_DefaultTooltipContent.Payload<recharts_types_component_DefaultTooltipContent.ValueType, recharts_types_component_DefaultTooltipContent.NameType>> | undefined;
77
77
  position?: Partial<recharts_types_util_types.Coordinate>;
78
78
  reverseDirection?: recharts_types_util_types.AllowInDimension;
79
79
  shared?: boolean;
@@ -89,7 +89,7 @@ declare const ChartTooltipContent: React.ForwardRefExoticComponent<Omit<Recharts
89
89
  labelKey?: string;
90
90
  }, "ref"> & React.RefAttributes<HTMLDivElement>>;
91
91
  declare const ChartLegend: typeof RechartsPrimitive.Legend;
92
- declare const ChartLegendContent: React.ForwardRefExoticComponent<Omit<React.ClassAttributes<HTMLDivElement> & React.HTMLAttributes<HTMLDivElement> & Pick<RechartsPrimitive.LegendProps, "verticalAlign" | "payload"> & {
92
+ declare const ChartLegendContent: React.ForwardRefExoticComponent<Omit<React.ClassAttributes<HTMLDivElement> & React.HTMLAttributes<HTMLDivElement> & Pick<RechartsPrimitive.LegendProps, "payload" | "verticalAlign"> & {
93
93
  hideIcon?: boolean;
94
94
  nameKey?: string;
95
95
  }, "ref"> & React.RefAttributes<HTMLDivElement>>;
@@ -9,10 +9,10 @@ import * as class_variance_authority_types from 'class-variance-authority/types'
9
9
  import { VariantProps } from 'class-variance-authority';
10
10
  import useEmblaCarousel, { UseEmblaCarouselType } from 'embla-carousel-react';
11
11
 
12
- declare const buttonVariants: (props?: {
13
- variant?: "link" | "default" | "secondary" | "outline" | "destructive" | "ghost";
14
- size?: "default" | "sm" | "lg" | "icon";
15
- } & class_variance_authority_types.ClassProp) => string;
12
+ declare const buttonVariants: (props?: ({
13
+ variant?: "link" | "secondary" | "outline" | "default" | "destructive" | "ghost" | null | undefined;
14
+ size?: "sm" | "lg" | "default" | "icon" | null | undefined;
15
+ } & class_variance_authority_types.ClassProp) | undefined) => string;
16
16
  interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement>, VariantProps<typeof buttonVariants> {
17
17
  asChild?: boolean;
18
18
  }
@@ -57,7 +57,7 @@ declare const ChartContainer: React.ForwardRefExoticComponent<Omit<React.ClassAt
57
57
  declare const ChartStyle: ({ id, config }: {
58
58
  id: string;
59
59
  config: ChartConfig;
60
- }) => react_jsx_runtime.JSX.Element;
60
+ }) => react_jsx_runtime.JSX.Element | null;
61
61
  declare const ChartTooltip: typeof RechartsPrimitive.Tooltip;
62
62
  declare const ChartTooltipContent: React.ForwardRefExoticComponent<Omit<RechartsPrimitive.DefaultTooltipContentProps<recharts_types_component_DefaultTooltipContent.ValueType, recharts_types_component_DefaultTooltipContent.NameType> & {
63
63
  accessibilityLayer?: boolean;
@@ -66,14 +66,14 @@ declare const ChartTooltipContent: React.ForwardRefExoticComponent<Omit<Recharts
66
66
  allowEscapeViewBox?: recharts_types_util_types.AllowInDimension;
67
67
  animationDuration?: recharts_types_util_types.AnimationDuration;
68
68
  animationEasing?: recharts_types_util_types.AnimationTiming;
69
- content?: recharts_types_component_Tooltip.ContentType<recharts_types_component_DefaultTooltipContent.ValueType, recharts_types_component_DefaultTooltipContent.NameType>;
69
+ content?: recharts_types_component_Tooltip.ContentType<recharts_types_component_DefaultTooltipContent.ValueType, recharts_types_component_DefaultTooltipContent.NameType> | undefined;
70
70
  coordinate?: Partial<recharts_types_util_types.Coordinate>;
71
71
  cursor?: boolean | React.ReactElement | React.SVGProps<SVGElement>;
72
72
  filterNull?: boolean;
73
73
  defaultIndex?: number;
74
74
  isAnimationActive?: boolean;
75
75
  offset?: number;
76
- payloadUniqBy?: recharts_types_util_payload_getUniqPayload.UniqueOption<recharts_types_component_DefaultTooltipContent.Payload<recharts_types_component_DefaultTooltipContent.ValueType, recharts_types_component_DefaultTooltipContent.NameType>>;
76
+ payloadUniqBy?: recharts_types_util_payload_getUniqPayload.UniqueOption<recharts_types_component_DefaultTooltipContent.Payload<recharts_types_component_DefaultTooltipContent.ValueType, recharts_types_component_DefaultTooltipContent.NameType>> | undefined;
77
77
  position?: Partial<recharts_types_util_types.Coordinate>;
78
78
  reverseDirection?: recharts_types_util_types.AllowInDimension;
79
79
  shared?: boolean;
@@ -89,7 +89,7 @@ declare const ChartTooltipContent: React.ForwardRefExoticComponent<Omit<Recharts
89
89
  labelKey?: string;
90
90
  }, "ref"> & React.RefAttributes<HTMLDivElement>>;
91
91
  declare const ChartLegend: typeof RechartsPrimitive.Legend;
92
- declare const ChartLegendContent: React.ForwardRefExoticComponent<Omit<React.ClassAttributes<HTMLDivElement> & React.HTMLAttributes<HTMLDivElement> & Pick<RechartsPrimitive.LegendProps, "verticalAlign" | "payload"> & {
92
+ declare const ChartLegendContent: React.ForwardRefExoticComponent<Omit<React.ClassAttributes<HTMLDivElement> & React.HTMLAttributes<HTMLDivElement> & Pick<RechartsPrimitive.LegendProps, "payload" | "verticalAlign"> & {
93
93
  hideIcon?: boolean;
94
94
  nameKey?: string;
95
95
  }, "ref"> & React.RefAttributes<HTMLDivElement>>;
package/dist/charts.cjs CHANGED
@@ -1,3 +1,4 @@
1
+ "use strict";
1
2
  var __create = Object.create;
2
3
  var __defProp = Object.defineProperty;
3
4
  var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -497,4 +498,3 @@ CarouselNext.displayName = "CarouselNext";
497
498
  ChartTooltip,
498
499
  ChartTooltipContent
499
500
  });
500
- //# sourceMappingURL=charts.cjs.map
package/dist/charts.d.cts CHANGED
@@ -1,4 +1,4 @@
1
- export { c as Carousel, C as CarouselApi, d as CarouselContent, e as CarouselItem, g as CarouselNext, f as CarouselPrevious, n as ChartConfig, h as ChartContainer, k as ChartLegend, l as ChartLegendContent, m as ChartStyle, i as ChartTooltip, j as ChartTooltipContent } from './charts-KwYmX5He.cjs';
1
+ export { c as Carousel, C as CarouselApi, d as CarouselContent, e as CarouselItem, g as CarouselNext, f as CarouselPrevious, n as ChartConfig, h as ChartContainer, k as ChartLegend, l as ChartLegendContent, m as ChartStyle, i as ChartTooltip, j as ChartTooltipContent } from './charts-DqY2Q-7w.cjs';
2
2
  import 'recharts/types/util/payload/getUniqPayload';
3
3
  import 'recharts/types/component/Tooltip';
4
4
  import 'recharts/types/util/types';
package/dist/charts.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- export { c as Carousel, C as CarouselApi, d as CarouselContent, e as CarouselItem, g as CarouselNext, f as CarouselPrevious, n as ChartConfig, h as ChartContainer, k as ChartLegend, l as ChartLegendContent, m as ChartStyle, i as ChartTooltip, j as ChartTooltipContent } from './charts-KwYmX5He.js';
1
+ export { c as Carousel, C as CarouselApi, d as CarouselContent, e as CarouselItem, g as CarouselNext, f as CarouselPrevious, n as ChartConfig, h as ChartContainer, k as ChartLegend, l as ChartLegendContent, m as ChartStyle, i as ChartTooltip, j as ChartTooltipContent } from './charts-DqY2Q-7w.js';
2
2
  import 'recharts/types/util/payload/getUniqPayload';
3
3
  import 'recharts/types/component/Tooltip';
4
4
  import 'recharts/types/util/types';
package/dist/charts.js CHANGED
@@ -451,4 +451,3 @@ export {
451
451
  ChartTooltip,
452
452
  ChartTooltipContent
453
453
  };
454
- //# sourceMappingURL=charts.js.map