orizon 0.2.0 → 0.2.2

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.
Files changed (167) hide show
  1. package/README.md +45 -7
  2. package/bin/cli.mjs +53 -16
  3. package/bin/init.mjs +541 -156
  4. package/dist/components/affix/Affix.d.ts +19 -0
  5. package/dist/components/affix/Affix.stories.d.ts +9 -0
  6. package/dist/components/affix/index.d.ts +23 -0
  7. package/dist/components/alert/Alert.d.ts +21 -0
  8. package/dist/components/alert/Alert.stories.d.ts +13 -0
  9. package/dist/components/alert/ErrorBoundary.d.ts +10 -0
  10. package/dist/components/alert/index.d.ts +20 -0
  11. package/dist/components/anchor/Anchor.d.ts +23 -0
  12. package/dist/components/anchor/Anchor.stories.d.ts +9 -0
  13. package/dist/components/anchor/index.d.ts +24 -0
  14. package/dist/components/app/App.d.ts +25 -0
  15. package/dist/components/app/App.stories.d.ts +8 -0
  16. package/dist/components/app/index.d.ts +18 -0
  17. package/dist/components/auto-complete/AutoComplete.d.ts +22 -0
  18. package/dist/components/auto-complete/AutoComplete.stories.d.ts +12 -0
  19. package/dist/components/auto-complete/index.d.ts +22 -0
  20. package/dist/components/avatar/Avatar.d.ts +24 -0
  21. package/dist/components/avatar/Avatar.stories.d.ts +10 -0
  22. package/dist/components/avatar/index.d.ts +21 -0
  23. package/dist/components/badge/Badge.d.ts +19 -0
  24. package/dist/components/badge/Badge.stories.d.ts +12 -0
  25. package/dist/components/badge/index.d.ts +19 -0
  26. package/dist/components/breadcrumb/Breadcrumb.d.ts +24 -0
  27. package/dist/components/breadcrumb/Breadcrumb.stories.d.ts +9 -0
  28. package/dist/components/breadcrumb/index.d.ts +25 -0
  29. package/dist/components/button/Button.d.ts +24 -0
  30. package/dist/components/button/Button.stories.d.ts +20 -0
  31. package/dist/components/button/ButtonGroup.d.ts +23 -0
  32. package/dist/components/button/index.d.ts +33 -0
  33. package/dist/components/button/types.d.ts +87 -11
  34. package/dist/components/calendar/Calendar.d.ts +21 -0
  35. package/dist/components/calendar/Calendar.stories.d.ts +10 -0
  36. package/dist/components/calendar/index.d.ts +19 -0
  37. package/dist/components/card/Card.d.ts +21 -0
  38. package/dist/components/card/Card.stories.d.ts +14 -0
  39. package/dist/components/card/index.d.ts +25 -0
  40. package/dist/components/carousel/Carousel.d.ts +23 -0
  41. package/dist/components/carousel/Carousel.stories.d.ts +11 -0
  42. package/dist/components/carousel/index.d.ts +25 -0
  43. package/dist/components/cascader/Cascader.d.ts +26 -0
  44. package/dist/components/cascader/Cascader.stories.d.ts +11 -0
  45. package/dist/components/cascader/index.d.ts +25 -0
  46. package/dist/components/checkbox/Checkbox.d.ts +21 -0
  47. package/dist/components/checkbox/Checkbox.stories.d.ts +11 -0
  48. package/dist/components/checkbox/CheckboxGroup.d.ts +10 -0
  49. package/dist/components/checkbox/index.d.ts +19 -0
  50. package/dist/components/collapse/Collapse.d.ts +25 -0
  51. package/dist/components/collapse/Collapse.stories.d.ts +12 -0
  52. package/dist/components/collapse/index.d.ts +26 -0
  53. package/dist/components/color-picker/ColorPicker.d.ts +22 -0
  54. package/dist/components/color-picker/ColorPicker.stories.d.ts +11 -0
  55. package/dist/components/color-picker/index.d.ts +22 -0
  56. package/dist/components/date-picker/DatePicker.d.ts +20 -0
  57. package/dist/components/date-picker/DatePicker.stories.d.ts +12 -0
  58. package/dist/components/date-picker/RangePicker.d.ts +12 -0
  59. package/dist/components/date-picker/index.d.ts +21 -0
  60. package/dist/components/descriptions/Descriptions.d.ts +25 -0
  61. package/dist/components/descriptions/Descriptions.stories.d.ts +12 -0
  62. package/dist/components/descriptions/index.d.ts +25 -0
  63. package/dist/components/divider/Divider.stories.d.ts +12 -0
  64. package/dist/components/divider/index.d.ts +10 -0
  65. package/dist/components/drawer/Drawer.stories.d.ts +10 -0
  66. package/dist/components/drawer/index.d.ts +13 -0
  67. package/dist/components/dropdown/Dropdown.stories.d.ts +12 -0
  68. package/dist/components/dropdown/index.d.ts +14 -0
  69. package/dist/components/empty/Empty.stories.d.ts +11 -0
  70. package/dist/components/empty/index.d.ts +14 -0
  71. package/dist/components/flex/Flex.stories.d.ts +12 -0
  72. package/dist/components/flex/index.d.ts +15 -0
  73. package/dist/components/float-button/FloatButton.stories.d.ts +12 -0
  74. package/dist/components/float-button/index.d.ts +15 -0
  75. package/dist/components/form/Form.stories.d.ts +10 -0
  76. package/dist/components/form/index.d.ts +17 -0
  77. package/dist/components/grid/Grid.stories.d.ts +11 -0
  78. package/dist/components/grid/index.d.ts +20 -0
  79. package/dist/components/image/Image.stories.d.ts +11 -0
  80. package/dist/components/image/index.d.ts +14 -0
  81. package/dist/components/input/Input.stories.d.ts +14 -0
  82. package/dist/components/input/index.d.ts +15 -0
  83. package/dist/components/input-number/InputNumber.stories.d.ts +13 -0
  84. package/dist/components/input-number/index.d.ts +10 -0
  85. package/dist/components/layout/Layout.stories.d.ts +9 -0
  86. package/dist/components/layout/index.d.ts +17 -0
  87. package/dist/components/list/List.stories.d.ts +13 -0
  88. package/dist/components/list/index.d.ts +18 -0
  89. package/dist/components/masonry/Masonry.stories.d.ts +11 -0
  90. package/dist/components/masonry/index.d.ts +12 -0
  91. package/dist/components/mentions/Mentions.stories.d.ts +12 -0
  92. package/dist/components/mentions/index.d.ts +11 -0
  93. package/dist/components/menu/Menu.stories.d.ts +12 -0
  94. package/dist/components/menu/index.d.ts +15 -0
  95. package/dist/components/message/Message.stories.d.ts +8 -0
  96. package/dist/components/message/index.d.ts +16 -0
  97. package/dist/components/modal/Modal.stories.d.ts +12 -0
  98. package/dist/components/modal/index.d.ts +17 -0
  99. package/dist/components/notification/Notification.stories.d.ts +10 -0
  100. package/dist/components/notification/index.d.ts +14 -0
  101. package/dist/components/pagination/Pagination.stories.d.ts +13 -0
  102. package/dist/components/pagination/index.d.ts +13 -0
  103. package/dist/components/popconfirm/Popconfirm.stories.d.ts +11 -0
  104. package/dist/components/popconfirm/index.d.ts +13 -0
  105. package/dist/components/popover/Popover.stories.d.ts +10 -0
  106. package/dist/components/popover/index.d.ts +10 -0
  107. package/dist/components/progress/Progress.stories.d.ts +13 -0
  108. package/dist/components/progress/index.d.ts +10 -0
  109. package/dist/components/qrcode/QRCode.stories.d.ts +11 -0
  110. package/dist/components/qrcode/index.d.ts +9 -0
  111. package/dist/components/radio/Radio.stories.d.ts +13 -0
  112. package/dist/components/radio/index.d.ts +17 -0
  113. package/dist/components/rate/Rate.stories.d.ts +12 -0
  114. package/dist/components/rate/index.d.ts +13 -0
  115. package/dist/components/result/Result.stories.d.ts +12 -0
  116. package/dist/components/result/index.d.ts +9 -0
  117. package/dist/components/segmented/Segmented.stories.d.ts +12 -0
  118. package/dist/components/segmented/index.d.ts +9 -0
  119. package/dist/components/select/Select.stories.d.ts +14 -0
  120. package/dist/components/select/index.d.ts +10 -0
  121. package/dist/components/skeleton/Skeleton.stories.d.ts +12 -0
  122. package/dist/components/skeleton/index.d.ts +15 -0
  123. package/dist/components/slider/Slider.stories.d.ts +13 -0
  124. package/dist/components/slider/index.d.ts +10 -0
  125. package/dist/components/space/Space.stories.d.ts +13 -0
  126. package/dist/components/space/index.d.ts +18 -0
  127. package/dist/components/spin/Spin.stories.d.ts +13 -0
  128. package/dist/components/spin/index.d.ts +14 -0
  129. package/dist/components/splitter/Splitter.stories.d.ts +12 -0
  130. package/dist/components/splitter/index.d.ts +18 -0
  131. package/dist/components/statistic/Statistic.stories.d.ts +10 -0
  132. package/dist/components/statistic/index.d.ts +17 -0
  133. package/dist/components/steps/Steps.stories.d.ts +11 -0
  134. package/dist/components/steps/index.d.ts +15 -0
  135. package/dist/components/switch/Switch.stories.d.ts +10 -0
  136. package/dist/components/switch/index.d.ts +12 -0
  137. package/dist/components/table/Table.stories.d.ts +12 -0
  138. package/dist/components/table/index.d.ts +12 -0
  139. package/dist/components/tabs/Tabs.stories.d.ts +11 -0
  140. package/dist/components/tabs/index.d.ts +16 -0
  141. package/dist/components/tag/Tag.stories.d.ts +11 -0
  142. package/dist/components/tag/index.d.ts +14 -0
  143. package/dist/components/time-picker/TimePicker.stories.d.ts +10 -0
  144. package/dist/components/time-picker/index.d.ts +13 -0
  145. package/dist/components/timeline/Timeline.stories.d.ts +10 -0
  146. package/dist/components/timeline/index.d.ts +15 -0
  147. package/dist/components/tooltip/Tooltip.stories.d.ts +8 -0
  148. package/dist/components/tooltip/index.d.ts +10 -0
  149. package/dist/components/tour/Tour.stories.d.ts +8 -0
  150. package/dist/components/tour/index.d.ts +16 -0
  151. package/dist/components/transfer/Transfer.stories.d.ts +9 -0
  152. package/dist/components/transfer/index.d.ts +15 -0
  153. package/dist/components/tree/Tree.stories.d.ts +10 -0
  154. package/dist/components/tree/index.d.ts +18 -0
  155. package/dist/components/tree-select/TreeSelect.stories.d.ts +9 -0
  156. package/dist/components/tree-select/index.d.ts +16 -0
  157. package/dist/components/typography/Typography.stories.d.ts +11 -0
  158. package/dist/components/typography/index.d.ts +14 -0
  159. package/dist/components/upload/Upload.stories.d.ts +10 -0
  160. package/dist/components/upload/index.d.ts +17 -0
  161. package/dist/components/watermark/Watermark.stories.d.ts +9 -0
  162. package/dist/components/watermark/index.d.ts +11 -0
  163. package/dist/orizon.cjs.js +101 -101
  164. package/dist/orizon.es.js +26200 -25378
  165. package/dist/preset.css +4 -4
  166. package/dist/themes/corporate.css +169 -0
  167. package/package.json +16 -3
package/README.md CHANGED
@@ -1,6 +1,10 @@
1
1
  # Orizon
2
2
 
3
- Ant Design API on shadcn/ui primitives. 68 React components with full TypeScript support.
3
+ Ant Design API on shadcn/ui primitives. 68 production-ready React components with full TypeScript support, built with Tailwind CSS v4.
4
+
5
+ > **Note:** I'm a junior developer and started this as a side project to learn React component architecture. Currently Orizon works with **Vite** only. Support for Next.js and other frameworks may come in the future.
6
+
7
+ [Documentation](https://ui-orizon.netlify.app/) | [GitHub](https://github.com/web-vikas/orizon)
4
8
 
5
9
  ## Install
6
10
 
@@ -11,7 +15,7 @@ npm install orizon
11
15
  **Peer dependencies** — your project needs:
12
16
 
13
17
  ```bash
14
- npm install react react-dom tailwindcss
18
+ npm install react react-dom tailwindcss @tailwindcss/vite
15
19
  ```
16
20
 
17
21
  For the **Form** component (optional):
@@ -20,9 +24,19 @@ For the **Form** component (optional):
20
24
  npm install react-hook-form @hookform/resolvers zod
21
25
  ```
22
26
 
23
- ## Setup
27
+ ## Setup (Vite)
28
+
29
+ 1. Add the Tailwind plugin to `vite.config.ts`:
30
+
31
+ ```ts
32
+ import tailwindcss from "@tailwindcss/vite";
33
+
34
+ export default defineConfig({
35
+ plugins: [react(), tailwindcss()],
36
+ });
37
+ ```
24
38
 
25
- Add these 3 lines to your app's CSS file:
39
+ 2. Add these 3 lines to your app's CSS file:
26
40
 
27
41
  ```css
28
42
  @import "tailwindcss";
@@ -77,7 +91,17 @@ notification.open({ message: "Done" });
77
91
 
78
92
  ## Theming
79
93
 
80
- Override CSS variables in your CSS:
94
+ Swap the CSS import to completely change the look of all components:
95
+
96
+ ```css
97
+ /* Default theme */
98
+ @import "orizon/preset.css";
99
+
100
+ /* Corporate theme — teal primary, large radius */
101
+ @import "orizon/themes/corporate.css";
102
+ ```
103
+
104
+ Or override individual CSS variables:
81
105
 
82
106
  ```css
83
107
  :root {
@@ -86,16 +110,30 @@ Override CSS variables in your CSS:
86
110
  }
87
111
  ```
88
112
 
89
- Or use the ConfigProvider:
113
+ Or use the ConfigProvider at runtime:
90
114
 
91
115
  ```tsx
92
116
  import { ConfigProvider } from "orizon";
93
117
 
94
- <ConfigProvider theme={{ algorithm: "dark" }}>
118
+ <ConfigProvider theme={{ algorithm: "dark", token: { colorPrimary: "#1890ff" } }}>
95
119
  <App />
96
120
  </ConfigProvider>
97
121
  ```
98
122
 
123
+ ## CLI
124
+
125
+ Orizon includes a CLI to help you get started:
126
+
127
+ ```bash
128
+ npx orizon init # scaffold a new Vite + Orizon project
129
+ npx orizon add button # show usage info for a component
130
+ npx orizon list # list all 68 components
131
+ ```
132
+
99
133
  ## License
100
134
 
101
135
  MIT
136
+
137
+ ## Author
138
+
139
+ [Vikas Patel](https://github.com/web-vikas) — Junior Developer, learning by building.
package/bin/cli.mjs CHANGED
@@ -3,6 +3,7 @@
3
3
  import { readFileSync } from "node:fs";
4
4
  import { dirname, resolve } from "node:path";
5
5
  import { fileURLToPath } from "node:url";
6
+ import pc from "picocolors";
6
7
 
7
8
  const __dirname = dirname(fileURLToPath(import.meta.url));
8
9
  const pkg = JSON.parse(
@@ -11,20 +12,47 @@ const pkg = JSON.parse(
11
12
 
12
13
  const [command] = process.argv.slice(2);
13
14
 
14
- function printHelp() {
15
- console.log(`
16
- orizon v${pkg.version}
17
-
18
- Usage:
19
- npx orizon <command>
20
-
21
- Commands:
22
- init Set up Orizon in your React + Vite project
15
+ function printBanner() {
16
+ console.log();
17
+ console.log(
18
+ pc.cyan(pc.bold(" ⬡ Orizon")) +
19
+ pc.dim(` v${pkg.version}`) +
20
+ pc.dim(" Ant Design API on shadcn/ui primitives"),
21
+ );
22
+ console.log(pc.dim(" " + "─".repeat(54)));
23
+ console.log();
24
+ }
23
25
 
24
- Options:
25
- --version Show version number
26
- --help Show this help message
27
- `);
26
+ function printHelp() {
27
+ printBanner();
28
+ console.log(
29
+ ` ${pc.bold("Usage")}`,
30
+ );
31
+ console.log(
32
+ ` ${pc.cyan("$")} npx orizon ${pc.green("<command>")}`,
33
+ );
34
+ console.log();
35
+ console.log(
36
+ ` ${pc.bold("Commands")}`,
37
+ );
38
+ console.log(
39
+ ` ${pc.green("init")} Set up Orizon in your React + Vite project`,
40
+ );
41
+ console.log();
42
+ console.log(
43
+ ` ${pc.bold("Options")}`,
44
+ );
45
+ console.log(
46
+ ` ${pc.yellow("--version")} Show version number`,
47
+ );
48
+ console.log(
49
+ ` ${pc.yellow("--help")} Show this help message`,
50
+ );
51
+ console.log();
52
+ console.log(
53
+ pc.dim(" Docs: https://orizon.dev | GitHub: github.com/nicepkg/orizon"),
54
+ );
55
+ console.log();
28
56
  }
29
57
 
30
58
  switch (command) {
@@ -36,7 +64,9 @@ switch (command) {
36
64
 
37
65
  case "--version":
38
66
  case "-v":
39
- console.log(pkg.version);
67
+ console.log(
68
+ pc.cyan(pc.bold("⬡ Orizon")) + " " + pc.bold(pkg.version),
69
+ );
40
70
  break;
41
71
 
42
72
  case "--help":
@@ -46,7 +76,14 @@ switch (command) {
46
76
  break;
47
77
 
48
78
  default:
49
- console.error(`Unknown command: ${command}\n`);
50
- printHelp();
79
+ console.log();
80
+ console.error(
81
+ ` ${pc.red("✖")} Unknown command: ${pc.bold(command)}`,
82
+ );
83
+ console.log();
84
+ console.log(
85
+ ` Run ${pc.cyan("npx orizon --help")} to see available commands.`,
86
+ );
87
+ console.log();
51
88
  process.exit(1);
52
89
  }