Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexzajac/react-native-skeleton-content-nonexpo
A customizable skeleton-like loading placeholder for react native projects not using expo.
https://github.com/alexzajac/react-native-skeleton-content-nonexpo
animation component loader react-native skeleton
Last synced: 1 day ago
JSON representation
A customizable skeleton-like loading placeholder for react native projects not using expo.
- Host: GitHub
- URL: https://github.com/alexzajac/react-native-skeleton-content-nonexpo
- Owner: alexZajac
- License: mit
- Created: 2019-08-03T16:54:24.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-30T14:55:47.000Z (about 1 year ago)
- Last Synced: 2025-01-13T02:03:37.247Z (8 days ago)
- Topics: animation, component, loader, react-native, skeleton
- Language: TypeScript
- Homepage:
- Size: 2.24 MB
- Stars: 310
- Watchers: 3
- Forks: 62
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## React Native Skeleton Content Nonexpo
> This the not-expo dependant version of [this package](https://github.com/alexZajac/react-native-skeleton-content).
React native Skeleton Content, a simple yet fully customizable component made to achieve loading animation in a Skeleton-style. Works in both iOS and Android.
### New Features
- The package has been rewritten to Hooks and is using the declarative [react-native-reanimated](https://github.com/software-mansion/react-native-reanimated) package for animations
- It now supports nested layouts for children bones, see an example on [this snack](https://snack.expo.io/@alexandrezajac/skeleton-content-demo)
- It finally supports percentages dimensions for bones, for any type of animation!
[](https://travis-ci.org/alexZajac/react-native-skeleton-content-nonexpo) [](https://coveralls.io/github/alexZajac/react-native-skeleton-content-nonexpo?branch=master) [](https://www.npmjs.com/package/react-native-skeleton-content)
- [React Native Skeleton Content](#react-native-skeleton-content)
- [Installation](#installation)
- [Usage](#usage)
- [Props](#props)
- [Examples](#examples)
- [Playground](#playground)
### Installation
```shell script
npm install react-native-skeleton-content-nonexpo
```
> This package requires the `react-native-linear-gradient` package, make sure it's installed and working on your project.
Also install the following peer dependencies as the package depends on them. We prefer you install these dependencies
inorder to prevent double instance errors.
```shell script
npm install react-native-reanimated
```
### Usage
1. Import react-native-skeleton-content:
```javascript
import SkeletonContent from 'react-native-skeleton-content-nonexpo';
```
2. Once you create the SkeletonContent, you have two options:
- **Child Layout** : The component will figure out the layout of its bones with the dimensions of its direct children.
- **Custom Layout** : You provide a prop `layout` to the component specifying the size of the bones (see the [Examples](#examples) section below). Herunder is the example with a custom layout. A key prop is optional but highly recommended.
```javascript
export default function Placeholder() {
return (
Your content
Other content
);
}
```
3. Then simply sync the prop `isLoading` to your state to show/hide the SkeletonContent when the assets/data are available to the user.
```javascript
export default function Placeholder () {
const [loading, setLoading] = useState(true);
return (
)
}
```
### Props
| Name | Type | Default | Description |
| ------------------ | ---------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| isLoading | bool | **required** | Shows the Skeleton bones when true |
| layout | array of objects | [] | A custom layout for the Skeleton bones |
| duration | number | 1200 ms | Duration of one cycle of animation |
| containerStyle | object | flex: 1 | The style applied to the View containing the bones |
| easing | Easing | bezier(0.5, 0, 0.25, 1) | Easing of the bones animation |
| animationType | string | "shiver" | The animation to be used for animating the bones (see demos below) |
| animationDirection | string | "horizontalRight" | Used only for shiver animation, describes the direction and end-point (ex: horizontalRight goes on the x-axis from left to right) |
| boneColor | string | "#E1E9EE" | Color of the bones |
| highlightColor | string | "#F2F8FC" | Color of the highlight of the bones |
**Note**: The Easing type function is the one provided by [react-native-reanimated](https://github.com/software-mansion/react-native-reanimated), so if you want to change the default you will have to install it as a dependency.
### Examples
See the playground section to experiment :
**1** - Changing the direction of the animation (animationDirection prop) :
```javascript
export default function Placeholder () {
return (
)
}
```
**2** - Changing the colors and switching to "pulse" animation (boneColor, highlightColor and animationType prop) :
```javascript
export default function Placeholder () {
return (
)
}
```
**3** - Customizing the layout of the bones (layout prop) :
```javascript
export default function Placeholder () {
return (
)
}
```
### Playground
You can test out the features and different props easily on [**Snack**](https://snack.expo.io/@alexandrezajac/skeleton-content-demo).
Don't hesitate to take contact if anything is unclear !