react-18-ui-library 0.3.0 → 0.3.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.
- package/LICENSE +21 -0
- package/README.md +11 -0
- package/dist/components/layout/Navbar/Navbar.d.ts +13 -1
- package/dist/components/layout/Navbar/index.d.ts +1 -1
- package/dist/components/layout/Sidebar/Sidebar.d.ts +3 -1
- package/dist/index.cjs.js +156 -82
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +17 -3
- package/dist/index.esm.js +157 -83
- package/dist/index.esm.js.map +1 -1
- package/dist/styles.css +1 -1
- package/package.json +11 -5
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 ui-sandbox
|
|
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
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
> A fully customizable, theme-aware React 18 enterprise UI component library — 70+ components, schema-driven forms, fluent validation, drag-and-drop file upload, and zero runtime CSS-in-JS overhead.
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/react-18-ui-library)
|
|
6
|
+
[](https://6998a00a26549f1450ed8008-alszlltjoh.chromatic.com/)
|
|
6
7
|
[](https://www.typescriptlang.org/)
|
|
7
8
|
[](https://react.dev/)
|
|
8
9
|
[](https://tailwindcss.com/)
|
|
@@ -11,6 +12,13 @@
|
|
|
11
12
|
|
|
12
13
|
---
|
|
13
14
|
|
|
15
|
+
<p align="center">
|
|
16
|
+
<strong>📚 <a href="https://6998a00a26549f1450ed8008-alszlltjoh.chromatic.com/">View the live component library in Storybook</a></strong><br>
|
|
17
|
+
<em>Browse, test, and explore 70+ components</em>
|
|
18
|
+
</p>
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
14
22
|
## Table of Contents
|
|
15
23
|
|
|
16
24
|
- [Installation](#installation)
|
|
@@ -31,6 +39,7 @@
|
|
|
31
39
|
- [CSS Token Reference](#css-token-reference)
|
|
32
40
|
- [Security — Snyk](#security--snyk)
|
|
33
41
|
- [Development](#development)
|
|
42
|
+
- [CI/CD — Publishing](#cicd--publishing)
|
|
34
43
|
- [Peer Dependencies](#peer-dependencies)
|
|
35
44
|
- [License](#license)
|
|
36
45
|
|
|
@@ -72,6 +81,8 @@ export function App() {
|
|
|
72
81
|
|
|
73
82
|
> **Important:** `react-18-ui-library/styles` must be imported **before** any of your own stylesheets so your CSS token overrides take precedence. You do **not** need Tailwind installed in your consuming app — all utility classes are pre-compiled into the library's stylesheet.
|
|
74
83
|
|
|
84
|
+
> **📚 [View all components in Storybook →](https://6998a00a26549f1450ed8008-alszlltjoh.chromatic.com/)** — Browse and interact with the full component library.
|
|
85
|
+
|
|
75
86
|
---
|
|
76
87
|
|
|
77
88
|
## Theme System
|
|
@@ -6,14 +6,26 @@ export interface NavbarLink {
|
|
|
6
6
|
active?: boolean;
|
|
7
7
|
icon?: React.ReactNode;
|
|
8
8
|
}
|
|
9
|
+
export interface NavbarProfileMenuItem {
|
|
10
|
+
name: string;
|
|
11
|
+
href?: string;
|
|
12
|
+
onClick?: () => void;
|
|
13
|
+
}
|
|
14
|
+
export interface NavbarProfile {
|
|
15
|
+
name: string;
|
|
16
|
+
email?: string;
|
|
17
|
+
avatarUrl?: string;
|
|
18
|
+
menuItems?: NavbarProfileMenuItem[];
|
|
19
|
+
}
|
|
9
20
|
export interface NavbarProps {
|
|
10
21
|
logo?: React.ReactNode;
|
|
11
22
|
links?: NavbarLink[];
|
|
12
23
|
actions?: React.ReactNode;
|
|
24
|
+
profile?: NavbarProfile;
|
|
13
25
|
sticky?: boolean;
|
|
14
26
|
fixed?: boolean;
|
|
15
27
|
bordered?: boolean;
|
|
16
28
|
className?: string;
|
|
17
29
|
onMenuToggle?: (open: boolean) => void;
|
|
18
30
|
}
|
|
19
|
-
export declare function Navbar({ logo, links, actions, sticky, fixed, bordered, className, onMenuToggle, }: NavbarProps): import("react/jsx-runtime").JSX.Element;
|
|
31
|
+
export declare function Navbar({ logo, links, actions, profile, sticky, fixed, bordered, className, onMenuToggle, }: NavbarProps): import("react/jsx-runtime").JSX.Element;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
export { Navbar } from './Navbar';
|
|
2
|
-
export type { NavbarProps, NavbarLink } from './Navbar';
|
|
2
|
+
export type { NavbarProps, NavbarLink, NavbarProfile, NavbarProfileMenuItem } from './Navbar';
|
|
@@ -15,10 +15,12 @@ export interface SidebarProps {
|
|
|
15
15
|
defaultCollapsed?: boolean;
|
|
16
16
|
onCollapsedChange?: (collapsed: boolean) => void;
|
|
17
17
|
header?: React.ReactNode;
|
|
18
|
+
/** Compact icon/logo shown in the header area when the sidebar is collapsed */
|
|
19
|
+
collapsedIcon?: React.ReactNode;
|
|
18
20
|
footer?: React.ReactNode;
|
|
19
21
|
overlay?: boolean;
|
|
20
22
|
open?: boolean;
|
|
21
23
|
onClose?: () => void;
|
|
22
24
|
className?: string;
|
|
23
25
|
}
|
|
24
|
-
export declare function Sidebar({ items, collapsed: controlledCollapsed, defaultCollapsed, onCollapsedChange, header, footer, overlay, open, onClose, className, }: SidebarProps): import("react/jsx-runtime").JSX.Element;
|
|
26
|
+
export declare function Sidebar({ items, collapsed: controlledCollapsed, defaultCollapsed, onCollapsedChange, header, collapsedIcon, footer, overlay, open, onClose, className, }: SidebarProps): import("react/jsx-runtime").JSX.Element;
|