@epilot/volt-ui 1.0.0-alpha.28 → 1.0.0-alpha.3
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 +25 -38
- package/dist/components/button/button.d.ts +7 -6
- package/dist/index.d.ts +2 -21
- package/dist/index.es.js +1287 -8102
- package/dist/index.umd.js +30 -0
- package/dist/style.css +1 -1
- package/package.json +47 -57
- package/dist/components/accordion/accordion.d.ts +0 -10
- package/dist/components/badge/badge.d.ts +0 -39
- package/dist/components/button/button-group.d.ts +0 -11
- package/dist/components/callout/callout.d.ts +0 -15
- package/dist/components/checkbox/checkbox.d.ts +0 -4
- package/dist/components/command/command.d.ts +0 -19
- package/dist/components/dialog/dialog.d.ts +0 -17
- package/dist/components/field/field-addon.d.ts +0 -7
- package/dist/components/field/field-combobox.d.ts +0 -22
- package/dist/components/field/field-input.d.ts +0 -3
- package/dist/components/field/field-select.d.ts +0 -13
- package/dist/components/field/field-textarea.d.ts +0 -4
- package/dist/components/field/field.d.ts +0 -26
- package/dist/components/label/label.d.ts +0 -10
- package/dist/components/popover/popover.d.ts +0 -8
- package/dist/components/radio/radio.d.ts +0 -5
- package/dist/components/separator/seperator.d.ts +0 -4
- package/dist/components/switch/switch.d.ts +0 -13
- package/dist/components/tooltip/tooltip.d.ts +0 -10
- package/dist/index.cjs.js +0 -45
- package/dist/reset.css +0 -1
- /package/dist/{lib/utils.d.ts → utils/cn.d.ts} +0 -0
package/README.md
CHANGED
|
@@ -1,56 +1,43 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @epilot/volt-ui
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A tree-shakeable design system library for React applications. Built with Tailwind CSS v4, Radix UI primitives, and TypeScript.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Docs
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
- [Vite](https://vitejs.dev/) for development and bundling
|
|
9
|
-
- [Tailwind CSS](https://tailwindcss.com/) for styling
|
|
10
|
-
- [Radix UI](https://www.radix-ui.com/) for UI components
|
|
11
|
-
- [Fumadocs](https://fumadocs.com/) for documentation
|
|
12
|
-
- [Vitest](https://vitest.dev/) and [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/) for testing
|
|
13
|
-
|
|
14
|
-
> **Note**: We prefix the CSS classes and variables with `volt-ui-` to avoid conflicts with the application styles.
|
|
7
|
+
See [documentation](./docs) for more information.
|
|
15
8
|
|
|
16
9
|
## Installation
|
|
17
10
|
|
|
18
|
-
Install dependencies via [bun](https://bun.com/docs/installation).
|
|
19
|
-
|
|
20
11
|
```bash
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
To run the development, documentation server and watch for changes, run:
|
|
27
|
-
|
|
28
|
-
```bash
|
|
29
|
-
bun run dev:watch
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Open http://localhost:3000 with your browser to see the result.
|
|
33
|
-
|
|
34
|
-
## Testing
|
|
35
|
-
|
|
36
|
-
To run the tests, run:
|
|
37
|
-
|
|
38
|
-
```bash
|
|
39
|
-
bun run test
|
|
12
|
+
npm install @epilot/volt-ui
|
|
13
|
+
# or
|
|
14
|
+
yarn add @epilot/volt-ui
|
|
15
|
+
# or
|
|
16
|
+
bun add @epilot/volt-ui
|
|
40
17
|
```
|
|
41
18
|
|
|
42
19
|
## Build
|
|
43
20
|
|
|
44
21
|
```bash
|
|
22
|
+
npm run build
|
|
23
|
+
# or
|
|
24
|
+
yarn build
|
|
25
|
+
# or
|
|
45
26
|
bun run build
|
|
46
27
|
```
|
|
47
28
|
|
|
48
|
-
|
|
29
|
+
## Build Output
|
|
49
30
|
|
|
50
|
-
|
|
31
|
+
```
|
|
32
|
+
@epilot/volt-ui/
|
|
33
|
+
├── dist/
|
|
34
|
+
│ ├── index.es.js # ESM bundle
|
|
35
|
+
│ ├── index.umd.js # UMD bundle
|
|
36
|
+
│ ├── index.d.ts # TypeScript declarations
|
|
37
|
+
│ └── style.css # Scoped CSS (requires [data-volt-ui])
|
|
38
|
+
└── ...
|
|
39
|
+
```
|
|
51
40
|
|
|
52
|
-
|
|
41
|
+
## License
|
|
53
42
|
|
|
54
|
-
|
|
55
|
-
npm run publish
|
|
56
|
-
```
|
|
43
|
+
See LICENSE file for details.
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import type { ComponentPropsWithoutRef } from "react";
|
|
2
1
|
import { type VariantProps } from "class-variance-authority";
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
import type { ComponentPropsWithoutRef } from "react";
|
|
3
|
+
declare const buttonVariants: (props?: ({
|
|
4
|
+
variant?: "primary" | "secondary" | "tertiary" | null | undefined;
|
|
5
|
+
size?: "sm" | "base" | "lg" | null | undefined;
|
|
6
6
|
} & import("class-variance-authority/types").ClassProp) | undefined) => string;
|
|
7
7
|
export type ButtonVariant = VariantProps<typeof buttonVariants>["variant"];
|
|
8
8
|
export type ButtonSize = VariantProps<typeof buttonVariants>["size"];
|
|
@@ -10,8 +10,9 @@ export type ButtonProps = ComponentPropsWithoutRef<"button"> & VariantProps<type
|
|
|
10
10
|
asChild?: boolean;
|
|
11
11
|
};
|
|
12
12
|
export declare const Button: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & VariantProps<(props?: ({
|
|
13
|
-
variant?: "primary" | "secondary" | "tertiary" |
|
|
14
|
-
size?: "
|
|
13
|
+
variant?: "primary" | "secondary" | "tertiary" | null | undefined;
|
|
14
|
+
size?: "sm" | "base" | "lg" | null | undefined;
|
|
15
15
|
} & import("class-variance-authority/types").ClassProp) | undefined) => string> & {
|
|
16
16
|
asChild?: boolean;
|
|
17
17
|
} & import("react").RefAttributes<HTMLButtonElement>>;
|
|
18
|
+
export {};
|
package/dist/index.d.ts
CHANGED
|
@@ -1,21 +1,2 @@
|
|
|
1
|
-
import "
|
|
2
|
-
export {
|
|
3
|
-
export { Button, buttonVariants } from "./components/button/button";
|
|
4
|
-
export { ButtonGroup, ButtonGroupSeparator, ButtonGroupText, } from "./components/button/button-group";
|
|
5
|
-
export { Field, FieldSet, FieldContent, FieldDescription, FieldError, FieldGroup, FieldLabel, FieldLabelContent, useFieldContext, } from "./components/field/field";
|
|
6
|
-
export { FieldInput, FieldInputGroup } from "./components/field/field-input";
|
|
7
|
-
export { FieldGroupAddon } from "./components/field/field-addon";
|
|
8
|
-
export { FieldTextarea } from "./components/field/field-textarea";
|
|
9
|
-
export { FieldCombobox, FieldComboboxGroup, FieldComboboxGroupLabel, FieldComboboxValue, FieldComboboxTrigger, FieldComboboxContent, FieldComboboxItem, FieldComboboxItemCheckIcon, FieldComboboxEmpty, FieldComboboxSeparator, FieldComboboxInput, FieldComboboxList, FieldComboboxLoading, FieldComboboxClear, FieldComboboxClearValue, FieldComboboxPlaceholder, } from "./components/field/field-combobox";
|
|
10
|
-
export { Select, SelectContent, SelectGroup, SelectItem, SelectLabel, SelectScrollDownButton, SelectScrollUpButton, SelectSeparator, SelectTrigger, SelectValue, } from "./components/field/field-select";
|
|
11
|
-
export { Label } from "./components/label/label";
|
|
12
|
-
export { Tooltip, TooltipTrigger, TooltipContent, TooltipProvider, } from "./components/tooltip/tooltip";
|
|
13
|
-
export { Switch } from "./components/switch/switch";
|
|
14
|
-
export { Separator } from "./components/separator/seperator";
|
|
15
|
-
export { Popover, PopoverTrigger, PopoverContent, PopoverAnchor, PopoverPortal, } from "./components/popover/popover";
|
|
16
|
-
export { Dialog, DialogClose, DialogContent, DialogDescription, DialogFooter, DialogHeader, DialogOverlay, DialogPortal, DialogTitle, DialogTrigger, } from "./components/dialog/dialog";
|
|
17
|
-
export { Checkbox } from "./components/checkbox/checkbox";
|
|
18
|
-
export { RadioGroup, RadioGroupItem } from "./components/radio/radio";
|
|
19
|
-
export { Badge, badgeVariants } from "./components/badge/badge";
|
|
20
|
-
export { Callout, CalloutTitle, CalloutDescription, CalloutAction, CalloutIcon, } from "./components/callout/callout";
|
|
21
|
-
export { Accordion, AccordionItem, AccordionTrigger, AccordionContent, } from "./components/accordion/accordion";
|
|
1
|
+
import "./styles/index.css";
|
|
2
|
+
export { Button, type ButtonProps, type ButtonVariant, type ButtonSize } from "./components/button/button";
|