react-skeletonify 1.0.0 โ 1.0.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 +73 -3
- package/package.json +8 -5
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Mohammed Sinan Mp
|
|
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,21 @@
|
|
|
1
|
+
[](https://www.npmjs.com/package/react-skeletonify)
|
|
2
|
+
[](https://www.npmjs.com/package/react-skeletonify)
|
|
3
|
+
[](https://github.com/prettier/prettier)
|
|
4
|
+
|
|
1
5
|
# React Skeletonify
|
|
2
6
|
|
|
3
|
-
|
|
4
|
-
|
|
7
|
+
React Skeletonify is a lightweight React skeleton loader component. Create beautiful loading placeholders for text, images, buttons, or cards with smooth animations.
|
|
8
|
+
|
|
9
|
+
## ๐ฎ Live Demo
|
|
10
|
+
|
|
11
|
+
๐ [Try it here](https://playcode.io/2556254)
|
|
5
12
|
|
|
6
|
-
|
|
13
|
+
## โจ Features
|
|
14
|
+
|
|
15
|
+
- Lightweight and dependency-free
|
|
16
|
+
- Easy to wrap around any component
|
|
17
|
+
- Smooth animations
|
|
18
|
+
- Customizable styles
|
|
7
19
|
|
|
8
20
|
## ๐ Installation
|
|
9
21
|
|
|
@@ -12,3 +24,61 @@ npm install react-skeletonify
|
|
|
12
24
|
# or
|
|
13
25
|
yarn add react-skeletonify
|
|
14
26
|
```
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
import "react-skeletonify/dist/index.css";
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Example
|
|
34
|
+
|
|
35
|
+
```jsx
|
|
36
|
+
import React from "react";
|
|
37
|
+
import { SkeletonWrapper } from "react-skeletonify";
|
|
38
|
+
import "react-skeletonify/dist/index.css";
|
|
39
|
+
|
|
40
|
+
function App() {
|
|
41
|
+
return (
|
|
42
|
+
<SkeletonWrapper loading={true}>
|
|
43
|
+
<div style={{ height: "100px", width: "500px", padding: "10px" }}>
|
|
44
|
+
<div
|
|
45
|
+
style={{
|
|
46
|
+
height: "50px",
|
|
47
|
+
width: "50px",
|
|
48
|
+
borderRadius: "100%",
|
|
49
|
+
}}></div>
|
|
50
|
+
<h6>React Skeletonify</h6>
|
|
51
|
+
<p>Example React component for creating loading skeleton</p>
|
|
52
|
+
</div>
|
|
53
|
+
</SkeletonWrapper>
|
|
54
|
+
);
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
export default App;
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## โ๏ธ API
|
|
61
|
+
|
|
62
|
+
### SkeletonWrapper
|
|
63
|
+
|
|
64
|
+
| Prop | Type | Default | Description |
|
|
65
|
+
| :------: | :-------: | :-----: | :---------------------------------------: |
|
|
66
|
+
| loading | boolean | false | Whether to show skeletons or real content |
|
|
67
|
+
| children | ReactNode | null | Content you want wrapped with skeletons |
|
|
68
|
+
|
|
69
|
+
## Versioning
|
|
70
|
+
|
|
71
|
+
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [versions](https://www.npmjs.com/package/react-skeletonify?activeTab=versions).
|
|
72
|
+
|
|
73
|
+
## ๐ค Contributing
|
|
74
|
+
|
|
75
|
+
Contributions, issues, and feature requests are welcome!
|
|
76
|
+
Feel free to open a PR or issue.
|
|
77
|
+
|
|
78
|
+
## Authors
|
|
79
|
+
|
|
80
|
+
- **Sinan** - [GitHub](https://github.com/Sinan0333) ยท [Portfolio](http://sinan-dev.in)
|
|
81
|
+
|
|
82
|
+
## License
|
|
83
|
+
|
|
84
|
+
[](https://opensource.org/licenses/MIT)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "react-skeletonify",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"main": "dist/index.js",
|
|
5
5
|
"module": "dist/index.mjs",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -15,10 +15,13 @@
|
|
|
15
15
|
"keywords": [
|
|
16
16
|
"react",
|
|
17
17
|
"skeleton",
|
|
18
|
-
"loader",
|
|
19
|
-
"
|
|
20
|
-
"
|
|
21
|
-
"
|
|
18
|
+
"skeleton loader",
|
|
19
|
+
"loading state",
|
|
20
|
+
"placeholder",
|
|
21
|
+
"react component",
|
|
22
|
+
"react ui",
|
|
23
|
+
"react skeleton loader",
|
|
24
|
+
"react shimmer"
|
|
22
25
|
],
|
|
23
26
|
"author": "Sinan sinan.m.p333@gmail.com",
|
|
24
27
|
"license": "MIT",
|