1.0.0 • Published 1 year ago
wavy-header-react-native v1.0.0
wavy-header-react-native
a wavy header background for react-native
Installation
npm install wavy-header-react-nativeUsage
import { WavyBackground } from 'wavy-header-react-native';
// ...
<WavyBackground
height={140}
width={1100}
amplitude={30}
frequency={4}
offset={100}
color={'#06D6BC'}
maxHeight={290}
style={styles.wavesStyle}
bottom
/>;Example
Utilization
import WavyBackground from 'react-native-wavy-background';
// ...
<WavyBackground
height={140}
width={1100}
amplitude={30}
frequency={4}
offset={100}
color={'#06D6BC'}
maxHeight={290}
style={styles.wavesStyle}
bottom
/>;Props:
| Name | Default | Required | Description |
|---|---|---|---|
| width | null | yes | width of the wave. |
| height | null | yes | height of the wave. |
| frequency | null | yes | number of waves in the given length. |
| maxHeight | null | yes | maximum area covered by wave. |
| style | null | yes | style of the wave |
| amplitude | null | yes | distance from rest to crest. |
| offset | null | yes | height of two wave shapes. |
| color | '#06D6BC' | no | Color inside the wave shape. |
| bottom | 'false' | no | If the wave need to be in bottom. |
Contributing
See the contributing guide to learn how to contribute to the repository and the development workflow.
License
MIT
Made with create-react-native-library