ixia-ui-react 0.0.0-stage → 1.0.0-rc.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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 PHNTMbandit
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,103 @@
1
- # Temporary Holding Version
2
-
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
1
+ # Ixia UI React
2
+
3
+ A React component library for building polished product interfaces with composable primitives, Tailwind CSS styling, and accessible interaction patterns.
4
+
5
+ [![Sponsor on GitHub](https://img.shields.io/badge/Sponsor-GitHub-DB61A2?logo=githubsponsors&logoColor=white)](https://github.com/sponsors/PHNTMbandit)
6
+ [![npm version](https://img.shields.io/npm/v/ixia-ui-react?logo=npm)](https://www.npmjs.com/package/ixia-ui-react)
7
+ [![npm weekly downloads](https://img.shields.io/npm/dw/ixia-ui-react?logo=npm)](https://www.npmjs.com/package/ixia-ui-react)
8
+ [![License](https://img.shields.io/npm/l/ixia-ui-react)](LICENSE)
9
+ [![TypeScript declarations](https://img.shields.io/npm/types/ixia-ui-react)](https://www.npmjs.com/package/ixia-ui-react)
10
+
11
+ Ixia UI React is currently in release-candidate testing for `1.0.0`. APIs are nearing stability, but breaking changes may still happen before the stable release.
12
+
13
+ ## Features
14
+
15
+ - Accessible React components built on modern primitives.
16
+ - Tailwind CSS 4 styling with reusable design tokens.
17
+ - TypeScript-first exports for components, hooks, and utilities.
18
+ - Storybook coverage for component development and review.
19
+ - Semantic-release powered alpha, beta, release-candidate, and stable channels.
20
+ - Vite+ unified tooling for development, formatting, linting, type checking, and tests.
21
+
22
+ ## Installation
23
+
24
+ Install Ixia UI React with your package manager:
25
+
26
+ ```sh
27
+ npm install ixia-ui-react
28
+ pnpm add ixia-ui-react
29
+ yarn add ixia-ui-react
30
+ bun add ixia-ui-react
31
+ ```
32
+
33
+ Install the required peer dependencies if your app does not already include them:
34
+
35
+ ```sh
36
+ npm install react react-dom
37
+ pnpm add react react-dom
38
+ yarn add react react-dom
39
+ bun add react react-dom
40
+ ```
41
+
42
+ Import the library styles once in your app entry file:
43
+
44
+ ```ts
45
+ import 'ixia-ui-react/styles'
46
+ ```
47
+
48
+ ## Usage
49
+
50
+ ```tsx
51
+ import { Button } from 'ixia-ui-react'
52
+
53
+ export function Example() {
54
+ return <Button>Continue</Button>
55
+ }
56
+ ```
57
+
58
+ ## Available Components
59
+
60
+ Ixia UI React includes primitives for accordions, alerts, dialogs, autocomplete, avatars, badges, breadcrumbs, buttons, charts, checkboxes, code blocks, comboboxes, context menus, drawers, dropzones, fields, forms, inputs, menus, navigation, popovers, profiles, progress, radio groups, scroll areas, selects, sidebars, sliders, switches, tables, tabs, text areas, toasts, toggles, tooltips, and more.
61
+
62
+ ## Sponsor Development
63
+
64
+ If Ixia UI React saves you time or helps your product, consider [sponsoring its development on GitHub](https://github.com/sponsors/PHNTMbandit). Sponsorship helps fund ongoing maintenance, accessibility improvements, documentation, testing, and new components. One-time and recurring support are both welcome, and sponsorship is never required to use or contribute to the library.
65
+
66
+ ## Development
67
+
68
+ ```sh
69
+ vp install
70
+ vp run storybook
71
+ ```
72
+
73
+ Vite+ provides the `vp` CLI for the project toolchain. Use its built-in commands for checks and tests, and `vp run <script>` to run a script from `package.json`.
74
+
75
+ ```sh
76
+ vp check
77
+ vp test
78
+ vp run build
79
+ vp run build-storybook
80
+ ```
81
+
82
+ See the [Vite+ guide](https://viteplus.dev/guide/) for CLI details.
83
+
84
+ ## Release Channels
85
+
86
+ This repository uses semantic-release with prerelease branches:
87
+
88
+ - `alpha` publishes `1.0.0-alpha.x`
89
+ - `beta` publishes `1.0.0-beta.x`
90
+ - `rc` publishes `1.0.0-rc.x`
91
+ - `main` publishes stable releases
92
+
93
+ ## Contributing
94
+
95
+ Contributions are welcome. Read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request.
96
+
97
+ ## Security
98
+
99
+ Please report vulnerabilities privately using the guidance in [SECURITY.md](SECURITY.md).
100
+
101
+ ## License
102
+
103
+ MIT. See [LICENSE](LICENSE).