ab-nextjs-components 0.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/LICENSE +25 -0
- package/README.md +72 -0
- package/package.json +34 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
~~~~~~~~~~~
|
|
3
|
+
ab-nextjs-components
|
|
4
|
+
~~~~~~~~~~~
|
|
5
|
+
Copyright (c) 2024 Abraham Ukachi. Ab UI / NextJS Components.
|
|
6
|
+
|
|
7
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
8
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
9
|
+
in the Software without restriction, including without limitation the rights
|
|
10
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
11
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
12
|
+
furnished to do so, subject to the following conditions:
|
|
13
|
+
|
|
14
|
+
The above copyright notice and this permission notice shall be included in all
|
|
15
|
+
copies or substantial portions of the Software.
|
|
16
|
+
|
|
17
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
18
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
19
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
20
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
21
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
22
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
23
|
+
SOFTWARE.
|
|
24
|
+
|
|
25
|
+
|
package/README.md
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
`ab-nextjs-components`
|
|
2
|
+
|
|
3
|
+
> IMPORTANT: This is a work in progress and subject to major changes until version 1.0.
|
|
4
|
+
|
|
5
|
+
🚀 This is a lightweight collection of server & client React UI components created by [Abraham UKachi](https://github.com/abraham-ukachi), and optimized for Next.js applications 😎.
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Getting Started
|
|
9
|
+
|
|
10
|
+
### Installation
|
|
11
|
+
|
|
12
|
+
#### pnpm
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
pnpm install @ab-ui/nextjs-components
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
### Types
|
|
19
|
+
|
|
20
|
+
All the types are located in the `types` folder.
|
|
21
|
+
A specific type like *`AbButtonProps`* can be imported directly like this:
|
|
22
|
+
|
|
23
|
+
```ts
|
|
24
|
+
import type { AbButtonProps } from '@ab-ui/nextjs-components';
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
## Client Components
|
|
30
|
+
|
|
31
|
+
A list of all the **client components** and their current status:
|
|
32
|
+
|
|
33
|
+
| No. | Name | File | Status |
|
|
34
|
+
|:----|:-----|:-----|:-------|
|
|
35
|
+
| 1 | *`AbLogo`* | **ab-logo/index.tsx** | Pending |
|
|
36
|
+
| 2 | *`AbIcon`* | **ab-icon/index.tsx** | Pending |
|
|
37
|
+
| 3 | *`AbButton`* | **ab-button/index.tsx** | Pending |
|
|
38
|
+
| 4 | *`AbInput`* | **ab-input/index.tsx** | Pending |
|
|
39
|
+
|
|
40
|
+
> NOTE:
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
## Server Components
|
|
45
|
+
|
|
46
|
+
A list of all the **server components** and their current status:
|
|
47
|
+
|
|
48
|
+
| No. | Name | File | Status |
|
|
49
|
+
|:----|:-----|:-----|:-------|
|
|
50
|
+
| 1 | *`AbLogo`* | **server/ab-logo/index.tsx** | Pending |
|
|
51
|
+
| 2 | *`AbIcon`* | **server/ab-icon/index.tsx** | Pending |
|
|
52
|
+
| 3 | *`AbButton`* | **server/ab-button/index.tsx** | Pending |
|
|
53
|
+
|
|
54
|
+
> NOTE:
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
## Learn More abElements
|
|
59
|
+
|
|
60
|
+
To learn more about **`abElements`**, take a look at the following resources:
|
|
61
|
+
|
|
62
|
+
- [abElements Documentation](https://ab-elements.vercel.app/docs) - learn about abElements features and API.
|
|
63
|
+
|
|
64
|
+
You can check out [the abElements GitHub repository](https://github.com/abraham-ukachi/ab-elements-app) for more details.
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
## License
|
|
68
|
+
|
|
69
|
+
This **`ab-nextjs-components`** project is [MIT Licensed](./LICENSE) ;)
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
package/package.json
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "ab-nextjs-components",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "🚀 A lightweight collection of server & client React components created by Abraham Ukachi, and optimized for Next.js applications 😎.",
|
|
5
|
+
"main": "index.js",
|
|
6
|
+
"types": "types/index.d.ts",
|
|
7
|
+
"homepage": "https://github.com/abraham-ukachi/ab-nextjs-components#readme",
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "git+https://github.com/abraham-ukachi/ab-nextjs-components.git"
|
|
11
|
+
},
|
|
12
|
+
"bugs": {
|
|
13
|
+
"url": "https://github.com/abraham-ukachi/ab-nextjs-components/issues"
|
|
14
|
+
},
|
|
15
|
+
"keywords": [
|
|
16
|
+
"react",
|
|
17
|
+
"nextjs",
|
|
18
|
+
"server",
|
|
19
|
+
"client",
|
|
20
|
+
"components",
|
|
21
|
+
"abraham",
|
|
22
|
+
"ukachi",
|
|
23
|
+
"ab-nextjs-components"
|
|
24
|
+
],
|
|
25
|
+
"author": {
|
|
26
|
+
"name": "Abraham Ukachi",
|
|
27
|
+
"url": "https://github.com/abraham-ukachi",
|
|
28
|
+
"email": "abraham.ukachi@laplateforme.io"
|
|
29
|
+
},
|
|
30
|
+
"license": "MIT",
|
|
31
|
+
"scripts": {
|
|
32
|
+
"test": "echo \"Error: no test specified\" && exit 1"
|
|
33
|
+
}
|
|
34
|
+
}
|