@jacshuo/onyx 1.0.0 → 1.1.0
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 +10 -4
- package/README.zh-CN.md +4 -4
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
<p align="center">
|
|
2
2
|
<img src="https://img.shields.io/npm/v/@jacshuo/onyx?color=8b5cf6&style=flat-square" alt="npm version" />
|
|
3
3
|
<img src="https://img.shields.io/npm/l/@jacshuo/onyx?style=flat-square" alt="license" />
|
|
4
|
-
<img src="https://img.shields.io/github/actions/workflow/status/jacshuo/
|
|
4
|
+
<img src="https://img.shields.io/github/actions/workflow/status/jacshuo/OnyxUI/ci.yml?branch=main&style=flat-square&label=CI" alt="CI" />
|
|
5
5
|
<img src="https://img.shields.io/npm/dm/@jacshuo/onyx?color=10b981&style=flat-square" alt="downloads" />
|
|
6
6
|
</p>
|
|
7
7
|
|
|
@@ -15,7 +15,7 @@ A **React UI component library** built with Tailwind CSS v4 — crafted for resp
|
|
|
15
15
|
|
|
16
16
|
Born from a passion for **polished cross-platform experiences**, Onyx delivers a consistent look and feel from mobile screens to 4K displays — with dark mode, keyboard navigation, and touch interactions built in from day one.
|
|
17
17
|
|
|
18
|
-
> **Live Demo →** [jacshuo.github.io/
|
|
18
|
+
> **Live Demo →** [jacshuo.github.io/OnyxUI](https://jacshuo.github.io/OnyxUI)
|
|
19
19
|
|
|
20
20
|
---
|
|
21
21
|
|
|
@@ -237,7 +237,7 @@ The library uses Tailwind's **class-based** dark mode. Add `class="dark"` to you
|
|
|
237
237
|
|
|
238
238
|
```html
|
|
239
239
|
<html class="dark">
|
|
240
|
-
<!-- all
|
|
240
|
+
<!-- all OnyxUI components render in dark mode -->
|
|
241
241
|
</html>
|
|
242
242
|
```
|
|
243
243
|
|
|
@@ -698,7 +698,7 @@ npm run typecheck
|
|
|
698
698
|
## Project Structure
|
|
699
699
|
|
|
700
700
|
```
|
|
701
|
-
|
|
701
|
+
OnyxUI/
|
|
702
702
|
├── src/
|
|
703
703
|
│ ├── components/ # All React components
|
|
704
704
|
│ ├── lib/utils.ts # cn() utility (clsx + tailwind-merge)
|
|
@@ -737,6 +737,12 @@ jac-ui/
|
|
|
737
737
|
4. Push to the branch (`git push origin feature/my-feature`)
|
|
738
738
|
5. Open a Pull Request
|
|
739
739
|
|
|
740
|
+
### Community & Security
|
|
741
|
+
|
|
742
|
+
- Contribution guide: [CONTRIBUTING.md](./CONTRIBUTING.md)
|
|
743
|
+
- Code of conduct: [CODE_OF_CONDUCT.md](./.github/CODE_OF_CONDUCT.md)
|
|
744
|
+
- Security policy: [SECURITY.md](./.github/SECURITY.md)
|
|
745
|
+
|
|
740
746
|
---
|
|
741
747
|
|
|
742
748
|
## License
|
package/README.zh-CN.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
<p align="center">
|
|
2
2
|
<img src="https://img.shields.io/npm/v/@jacshuo/onyx?color=8b5cf6&style=flat-square" alt="npm version" />
|
|
3
3
|
<img src="https://img.shields.io/npm/l/@jacshuo/onyx?style=flat-square" alt="license" />
|
|
4
|
-
<img src="https://img.shields.io/github/actions/workflow/status/jacshuo/
|
|
4
|
+
<img src="https://img.shields.io/github/actions/workflow/status/jacshuo/OnyxUI/ci.yml?branch=main&style=flat-square&label=CI" alt="CI" />
|
|
5
5
|
<img src="https://img.shields.io/npm/dm/@jacshuo/onyx?color=10b981&style=flat-square" alt="downloads" />
|
|
6
6
|
</p>
|
|
7
7
|
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
|
|
16
16
|
源自对**精致跨端体验**的热忱，Onyx 在手机屏幕到 4K 显示器之间提供一致的视觉表现 —— 暗色模式、键盘导航与触摸交互，从第一天起就已内置，绝非事后补丁。
|
|
17
17
|
|
|
18
|
-
> **在线演示 →** [jacshuo.github.io/
|
|
18
|
+
> **在线演示 →** [jacshuo.github.io/OnyxUI](https://jacshuo.github.io/OnyxUI)
|
|
19
19
|
|
|
20
20
|
---
|
|
21
21
|
|
|
@@ -238,7 +238,7 @@ import { CinePlayer } from '@jacshuo/onyx/CinePlayer';
|
|
|
238
238
|
|
|
239
239
|
```html
|
|
240
240
|
<html class="dark">
|
|
241
|
-
<!-- 所有
|
|
241
|
+
<!-- 所有 OnyxUI 组件将以暗色模式渲染 -->
|
|
242
242
|
</html>
|
|
243
243
|
```
|
|
244
244
|
|
|
@@ -699,7 +699,7 @@ npm run typecheck
|
|
|
699
699
|
## 项目结构
|
|
700
700
|
|
|
701
701
|
```
|
|
702
|
-
|
|
702
|
+
OnyxUI/
|
|
703
703
|
├── src/
|
|
704
704
|
│ ├── components/ # 所有 React 组件
|
|
705
705
|
│ ├── lib/utils.ts # cn() 工具函数（clsx + tailwind-merge）
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jacshuo/onyx",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"description": "Cross-platform React UI component library — works in web & Electron",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.cjs",
|
|
@@ -34,12 +34,12 @@
|
|
|
34
34
|
},
|
|
35
35
|
"repository": {
|
|
36
36
|
"type": "git",
|
|
37
|
-
"url": "git+https://github.com/jacshuo/
|
|
37
|
+
"url": "git+https://github.com/jacshuo/OnyxUI.git"
|
|
38
38
|
},
|
|
39
39
|
"bugs": {
|
|
40
|
-
"url": "https://github.com/jacshuo/
|
|
40
|
+
"url": "https://github.com/jacshuo/OnyxUI/issues"
|
|
41
41
|
},
|
|
42
|
-
"homepage": "https://jacshuo.github.io/
|
|
42
|
+
"homepage": "https://jacshuo.github.io/OnyxUI",
|
|
43
43
|
"scripts": {
|
|
44
44
|
"dev": "webpack serve --config webpack.dev.config.cjs",
|
|
45
45
|
"build": "npm run clean && npm run build:js && npm run build:css",
|