You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
[//]: #"This README file is part of the Axiom documentation website (check overview.mdx)"
1
+
[//]: #"This README file is part of the Overflow UI documentation website (check overview.mdx)"
2
2
3
3
A React library for creating node-based user interfaces and diagram-driven apps. Built to work seamlessly with React Flow, it provides a collection of ready-to-use components and templates that simplify the development of visual editors, workflows, and interactive diagrams.
4
4
@@ -8,30 +8,30 @@ Developed and maintained by **[Synergy Codes](https://www.synergycodes.com/)**.
8
8
9
9
### 📦 Installation
10
10
11
-
Use one of the commands below to add **Axiom** to your project:
11
+
Use one of the commands below to add **Overflow UI** to your project:
12
12
13
13
```bash
14
-
npm install @synergycodes/axiom
14
+
npm install @synergycodes/overflow-ui
15
15
```
16
16
17
17
```bash
18
-
pnpm add @synergycodes/axiom
18
+
pnpm add @synergycodes/overflow-ui
19
19
```
20
20
21
21
```bash
22
-
yarn add @synergycodes/axiom
22
+
yarn add @synergycodes/overflow-ui
23
23
```
24
24
25
25
### 🎨 Import styles
26
26
27
27
Add to your style sheet or component:
28
28
29
29
```css
30
-
@import'@synergycodes/axiom/tokens.css';
30
+
@import'@synergycodes/overflow-ui/tokens.css';
31
31
```
32
32
33
33
```tsx
34
-
import'@synergycodes/axiom/tokens.css';
34
+
import'@synergycodes/overflow-ui/tokens.css';
35
35
```
36
36
37
37
### 🌗 Set the theme
@@ -45,7 +45,7 @@ To make the styles use proper variables, include `data-theme` (`light` or `dark`
45
45
### 🎛️ Use components
46
46
47
47
```tsx
48
-
import { Input } from'@synergycodes/axiom';
48
+
import { Input } from'@synergycodes/overflow-ui';
49
49
50
50
// …
51
51
@@ -54,7 +54,7 @@ import { Input } from '@synergycodes/axiom';
54
54
55
55
## Customization
56
56
57
-
Each axiom component uses CSS variables that are derived from primitive values.
57
+
Each Overflow UI component uses CSS variables that are derived from primitive values.
58
58
59
59
You can override them:
60
60
@@ -72,9 +72,9 @@ or a derived value used by the selected component:
72
72
}
73
73
```
74
74
75
-
### Axiom css layers
75
+
### Overflow UI css layers
76
76
77
-
Axiom uses [CSS layers](https://developer.mozilla.org/en-US/docs/Web/CSS/@layer) to separate its styles from yours. By default, CSS styles outside of any layer take precedence over what Axiom defines, so your styles will always win the specificity war. You can customize Axiom components with simple `input {}`.
77
+
Overflow UI uses [CSS layers](https://developer.mozilla.org/en-US/docs/Web/CSS/@layer) to separate its styles from yours. By default, CSS styles outside of any layer take precedence over what Overflow UI defines, so your styles will always win the specificity war. You can customize Overflow UI components with simple `input {}`.
Copy file name to clipboardExpand all lines: packages/ui/README.md
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# @synergycodes/axiom
1
+
# @synergycodes/overflow-ui
2
2
3
3
A React library for creating node-based user interfaces and diagram-driven apps. Built to work seamlessly with React Flow, it provides a collection of ready-to-use components and templates that simplify the development of visual editors, workflows, and interactive diagrams.
4
4
@@ -8,30 +8,30 @@ Developed and maintained by **[Synergy Codes](https://www.synergycodes.com/)**.
8
8
9
9
### 📦 Installation
10
10
11
-
Use one of the commands below to add **Axiom** to your project:
11
+
Use one of the commands below to add **Overflow UI** to your project:
12
12
13
13
```bash
14
-
npm install @synergycodes/axiom
14
+
npm install @synergycodes/overflow-ui
15
15
```
16
16
17
17
```bash
18
-
pnpm add @synergycodes/axiom
18
+
pnpm add @synergycodes/overflow-ui
19
19
```
20
20
21
21
```bash
22
-
yarn add @synergycodes/axiom
22
+
yarn add @synergycodes/overflow-ui
23
23
```
24
24
25
25
### 🎨 Import styles
26
26
27
27
Add to your style sheet or component:
28
28
29
29
```css
30
-
@import'@synergycodes/axiom/tokens.css';
30
+
@import'@synergycodes/overflow-ui/tokens.css';
31
31
```
32
32
33
33
```tsx
34
-
import'@synergycodes/axiom/tokens.css';
34
+
import'@synergycodes/overflow-ui/tokens.css';
35
35
```
36
36
37
37
### 🎛️ Apply the Theme
@@ -45,7 +45,7 @@ To make the styles use proper variables, include data-theme (light or dark) attr
45
45
### 🧱 Use components
46
46
47
47
```tsx
48
-
import { Input } from'@synergycodes/axiom';
48
+
import { Input } from'@synergycodes/overflow-ui';
49
49
50
50
// …
51
51
@@ -54,7 +54,7 @@ import { Input } from '@synergycodes/axiom';
54
54
55
55
## Overview
56
56
57
-
Forget cobbling together UI kits with diagram libraries. Axiom provides a unified set of designed, ready-to-use components: buttons, inputs, accordions, node templates, and more — all built to work seamlessly together.
57
+
Forget cobbling together UI kits with diagram libraries. Overflow UI provides a unified set of designed, ready-to-use components: buttons, inputs, accordions, node templates, and more — all built to work seamlessly together.
58
58
59
59
## Features
60
60
@@ -66,7 +66,7 @@ Forget cobbling together UI kits with diagram libraries. Axiom provides a unifie
66
66
67
67
## Customization
68
68
69
-
Each Axiom component uses CSS variables that are derived from primitive values.
69
+
Each Overflow UI component uses CSS variables that are derived from primitive values.
70
70
71
71
You can override them:
72
72
@@ -84,9 +84,9 @@ or a derived value used by the selected component:
84
84
}
85
85
```
86
86
87
-
### Axiom css layers
87
+
### Overflow UI css layers
88
88
89
-
Axiom uses [CSS layers](https://developer.mozilla.org/en-US/docs/Web/CSS/@layer) to separate its styles from yours. By default, CSS styles outside of any layer take precedence over what Axiom defines, so your styles will always win the specificity war. You can customize Axiom components with simple `input {}`.
89
+
Overflow UI uses [CSS layers](https://developer.mozilla.org/en-US/docs/Web/CSS/@layer) to separate its styles from yours. By default, CSS styles outside of any layer take precedence over what Overflow UI defines, so your styles will always win the specificity war. You can customize Overflow UI components with simple `input {}`.
@@ -129,18 +129,18 @@ Edit `ui/preview-page/preview-page.tsx` to display desired components.
129
129
130
130
### 📣 Important Note on Underlying Technology
131
131
132
-
> **Axiom is built on top of [MUI Base](https://v6.mui.com/base-ui/getting-started/), a headless component library that focuses on accessibility and logic, while leaving the styling up to us.**
132
+
> **Overflow UI is built on top of [MUI Base](https://v6.mui.com/base-ui/getting-started/), a headless component library that focuses on accessibility and logic, while leaving the styling up to us.**
133
133
>
134
-
> Thanks to MUI Base, Axiom provides components that are **accessible by default** and **fully customizable** through our design tokens.
134
+
> Thanks to MUI Base, Overflow UI provides components that are **accessible by default** and **fully customizable** through our design tokens.
135
135
>
136
136
> We are aware that **MUI Base has been deprecated**, and the MUI team recommends migrating to [Base UI](https://base-ui.com).
137
-
> However, after careful evaluation, we’ve chosen to **stay with MUI Base** for now because:
137
+
> However, after careful evaluation, we've chosen to **stay with MUI Base** for now because:
138
138
>
139
139
> * ✅ **Base UI is not yet mature enough** for our needs.
140
-
> * ✅ We want to ensure a stable, well-tested experience for Axiom users.
140
+
> * ✅ We want to ensure a stable, well-tested experience for Overflow UI users.
141
141
>
142
142
> This is a **conscious and informed decision**.
143
-
> We will continue to monitor Base UI’s progress and will consider migrating when we feel it’s the right time, ensuring a smooth and thoughtful transition for Axiom users.
143
+
> We will continue to monitor Base UI's progress and will consider migrating when we feel it's the right time, ensuring a smooth and thoughtful transition for Overflow UI users.
144
144
>
145
145
> If you have any questions or concerns, feel free to reach out — we’re happy to share our reasoning and plans in more detail!
Copy file name to clipboardExpand all lines: packages/ui/package.json
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
{
2
-
"name": "@synergycodes/axiom",
2
+
"name": "@synergycodes/overflow-ui",
3
3
"type": "module",
4
4
"version": "1.0.0-beta.22",
5
5
"description": "A React library for creating node-based UIs and diagram-driven applications. Perfect for React Flow users, providing ready-to-use node templates and components that work seamlessly with React Flow's ecosystem.",
0 commit comments