funuicss 1.9.10 → 1.9.11
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.txt +21 -0
- package/README.md +91 -24
- package/package-lock.json +4155 -0
- package/package.json +2 -1
package/LICENSE.txt
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 FunUi
|
|
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,9 +1,23 @@
|
|
|
1
|
-
<
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://funui.netlify.app/logo.png" width="200px">
|
|
3
|
+
</p>
|
|
4
|
+
<h1 align="center">The React & Next Js Ui Library</h1>
|
|
5
|
+
|
|
6
|
+
<p>
|
|
7
|
+
The framework is easy to integrate, just install the package and import the CSS file
|
|
8
|
+
</p>
|
|
9
|
+
|
|
10
|
+
<h3>Why Choose FunUi </h3>
|
|
11
|
+
<ul>
|
|
12
|
+
<li>The framework is build in modules, you just need to import the module you want to use</li>
|
|
13
|
+
<li>The framework is build with flexbox, which makes it easy to fit all screen sizes</li>
|
|
14
|
+
<li>The framework is easy to integrate, just install the package and import the CSS file</li>
|
|
15
|
+
</ul>
|
|
16
|
+
|
|
2
17
|
<h3>Learn how to use the framework at our official website 👎</h3>
|
|
3
18
|
https://funui.netlify.app
|
|
4
19
|
|
|
5
|
-
<h3>
|
|
6
|
-
<img src="https://raw.githubusercontent.com/FunUi-io/starterImage/main/starter.png" width="80%" style="border-radius:2rem"/>
|
|
20
|
+
<h3>Installation</h3>
|
|
7
21
|
|
|
8
22
|
<h3>Using Npm</h3>
|
|
9
23
|
Install the package via NPM
|
|
@@ -18,33 +32,86 @@ Import the css file at your entry point to apply our classes,for example: _app.j
|
|
|
18
32
|
import 'funuicss/css/fun.css'
|
|
19
33
|
</pre>
|
|
20
34
|
|
|
35
|
+
<h3>Simple Progress Bars </h3>
|
|
36
|
+
<p> These progress bars are good for showind the state of an action, for example, a user downloading an asset </p>
|
|
21
37
|
|
|
22
|
-
|
|
23
|
-
|
|
38
|
+
```jsx
|
|
39
|
+
import React from 'react'
|
|
40
|
+
import ProgressBar from 'funuicss/component/ProgressBar'
|
|
41
|
+
import Typography from 'funuicss/component/Typography'
|
|
42
|
+
export default function App() {
|
|
24
43
|
|
|
25
|
-
|
|
26
|
-
git clone git@github.com:FunUi-io/starter.git
|
|
27
|
-
</pre>
|
|
44
|
+
return (
|
|
28
45
|
|
|
29
|
-
<
|
|
30
|
-
|
|
46
|
+
<div>
|
|
47
|
+
<ProgressBar
|
|
48
|
+
progress={99}
|
|
49
|
+
content={"Success! 99%"}
|
|
50
|
+
bg="light-success"
|
|
51
|
+
/>
|
|
52
|
+
<ProgressBar
|
|
53
|
+
progress={85}
|
|
54
|
+
content={<Typography text="85%" color="primary" bold/>}
|
|
55
|
+
bg="primary"
|
|
56
|
+
lined
|
|
57
|
+
/>
|
|
58
|
+
<ProgressBar
|
|
59
|
+
progress={90}
|
|
60
|
+
content={<Typography text="90%" color="secondary" bold/>}
|
|
61
|
+
bg="secondary"
|
|
62
|
+
lined/>
|
|
63
|
+
</div>
|
|
31
64
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
65
|
+
)
|
|
66
|
+
}
|
|
67
|
+
```
|
|
35
68
|
|
|
36
|
-
<h3>
|
|
37
|
-
|
|
69
|
+
<h3>Simple App NavBar with FunUi </h3>
|
|
70
|
+
<p> This is a simple Navbar you just import and use for your project </p>
|
|
38
71
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
72
|
+
```jsx
|
|
73
|
+
import React from 'react'
|
|
74
|
+
import Navbar from 'funuicss/component/Navbar'
|
|
75
|
+
import Typography from 'funuicss/component/Typography'
|
|
76
|
+
import LinkWrapper from 'funuicss/component/LinkWrapper'
|
|
77
|
+
import Button from 'funuicss/component/Button'
|
|
78
|
+
import NavLogo from 'funuicss/component/NavLogo'
|
|
79
|
+
export default function App() {
|
|
80
|
+
return (
|
|
42
81
|
|
|
43
|
-
<
|
|
44
|
-
|
|
82
|
+
<div>
|
|
83
|
+
<Navbar>
|
|
84
|
+
<NavLogo>
|
|
85
|
+
<Typography heading="h4" text="Fun Ui" />
|
|
86
|
+
</NavLogo>
|
|
45
87
|
|
|
46
|
-
|
|
88
|
+
<LinkWrapper visibleLinks>
|
|
89
|
+
<Button text="Sign In" color="primary"> </Button>
|
|
90
|
+
<Button text="Sign Up" bg="primary" rounded > </Button>
|
|
91
|
+
</LinkWrapper>
|
|
47
92
|
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
93
|
+
</Navbar>
|
|
94
|
+
</div>
|
|
95
|
+
|
|
96
|
+
)
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
<p>
|
|
100
|
+
<h2>Documentaion</h2>
|
|
101
|
+
<div>Check our <a href="https://funui.netlify.app"> Documentation </a> for more exmaples and explanation</div>
|
|
102
|
+
<p>
|
|
103
|
+
<ul>
|
|
104
|
+
<li><a href="https://funui.netlify.app"> Documentation </a></li>
|
|
105
|
+
<li><a href="https://funui.netlify.app/gettingstarted"> Installing </a></li>
|
|
106
|
+
<li><a href="https://funui.netlify.app/components"> Components </a></li>
|
|
107
|
+
<li><a href="https://funui.netlify.app/darkmode"> Dark Mode </a></li>
|
|
108
|
+
<li><a href="https://funui.netlify.app/icons"> Icons </a></li>
|
|
109
|
+
<li><a href="https://funui.netlify.app/notifications"> Notifications </a></li>
|
|
110
|
+
</ul>
|
|
111
|
+
</p>
|
|
112
|
+
</p>
|
|
113
|
+
|
|
114
|
+
<p>
|
|
115
|
+
<h2>License</h2>
|
|
116
|
+
<div> The project is licensed under the terms of <a href="https://github.com/FunUi-io/FunUi/blob/main/LICENSE.txt"> MIT </a>
|
|
117
|
+
</p>
|