react-native-snow-backgroud 0.1.0 → 0.1.1
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/README.md +45 -15
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,37 +1,67 @@
|
|
|
1
1
|
# react-native-snow-backgroud
|
|
2
2
|
|
|
3
3
|
A simple snow background effect for React Native CLI using Skia.
|
|
4
|
+
This library renders a falling snow animation on a full-screen canvas with minimal setup.
|
|
4
5
|
|
|
5
|
-
|
|
6
|
+
It is designed to be lightweight, easy to understand, and suitable for learning or simple UI effects.
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Requirements
|
|
11
|
+
|
|
12
|
+
- React Native CLI
|
|
13
|
+
- React Native >= 0.72
|
|
14
|
+
- React >= 18
|
|
15
|
+
- @shopify/react-native-skia
|
|
6
16
|
|
|
17
|
+
Note: This library is intended for React Native CLI projects.
|
|
18
|
+
It may not work correctly in Expo environments.
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## Installation
|
|
7
23
|
|
|
8
|
-
```
|
|
24
|
+
```bash
|
|
9
25
|
npm install react-native-snow-backgroud
|
|
10
|
-
|
|
26
|
+
npm install @shopify/react-native-skia
|
|
27
|
+
````
|
|
11
28
|
|
|
29
|
+
For iOS:
|
|
12
30
|
|
|
13
|
-
|
|
31
|
+
```bash
|
|
32
|
+
cd ios && pod install
|
|
33
|
+
```
|
|
14
34
|
|
|
35
|
+
---
|
|
15
36
|
|
|
16
|
-
|
|
17
|
-
import { multiply } from 'react-native-snow-backgroud';
|
|
37
|
+
## Usage
|
|
18
38
|
|
|
19
|
-
|
|
39
|
+
```tsx
|
|
40
|
+
import { SnowView } from "react-native-snow-backgroud";
|
|
20
41
|
|
|
21
|
-
|
|
42
|
+
export default function App() {
|
|
43
|
+
return <SnowView count={120} />;
|
|
44
|
+
}
|
|
22
45
|
```
|
|
23
46
|
|
|
47
|
+
`SnowView` renders a full-screen Skia canvas with falling snow particles.
|
|
24
48
|
|
|
25
|
-
|
|
49
|
+
---
|
|
26
50
|
|
|
27
|
-
|
|
28
|
-
- [Sending a pull request](CONTRIBUTING.md#sending-a-pull-request)
|
|
29
|
-
- [Code of conduct](CODE_OF_CONDUCT.md)
|
|
51
|
+
## Props
|
|
30
52
|
|
|
31
|
-
|
|
53
|
+
### SnowView
|
|
32
54
|
|
|
33
|
-
|
|
55
|
+
| Name | Type | Default | Description |
|
|
56
|
+
| ----- | ------ | ------- | ----------------------------------------------- |
|
|
57
|
+
| count | number | 100 | Number of snow particles rendered on the screen |
|
|
34
58
|
|
|
35
59
|
---
|
|
36
60
|
|
|
37
|
-
|
|
61
|
+
## Performance Notes
|
|
62
|
+
|
|
63
|
+
* The default particle count is optimized for general usage.
|
|
64
|
+
* Increasing the particle count may affect performance on lower-end devices.
|
|
65
|
+
* Future versions may include rendering optimizations and additional effects.
|
|
66
|
+
|
|
67
|
+
---
|
package/package.json
CHANGED