https://github.com/wrathchaos/react-native-gorgeous-header

Fully customizable & easy to use gorgeous header view for React Native
https://github.com/wrathchaos/react-native-gorgeous-header

Last synced: 5 days ago
JSON representation

Fully customizable & easy to use gorgeous header view for React Native

• Host: GitHub
• URL: https://github.com/wrathchaos/react-native-gorgeous-header
• Owner: WrathChaos
• Created: 2020-08-22T17:05:01.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-04-17T20:04:01.000Z (over 3 years ago)
• Last Synced: 2025-09-21T06:44:34.929Z (18 days ago)
• Language: Java
• Homepage:
• Size: 896 KB
• Stars: 13
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


[![Battle Tested ✅](https://img.shields.io/badge/-Battle--Tested%20%E2%9C%85-03666e?style=for-the-badge)](https://github.com/WrathChaos/react-native-gorgeous-header)

[![React Native Gorgeous Header](https://img.shields.io/badge/-Fully%20customizable%20%26%20easy%20to%20use%20gorgeous%20header%20view%20for%20React%20Native-orange?style=for-the-badge)](https://github.com/WrathChaos/react-native-gorgeous-header)

[![npm version](https://img.shields.io/npm/v/react-native-gorgeous-header.svg?style=for-the-badge)](https://www.npmjs.com/package/react-native-gorgeous-header)

[![npm](https://img.shields.io/npm/dt/react-native-gorgeous-header.svg?style=for-the-badge)](https://www.npmjs.com/package/react-native-gorgeous-header)

![Platform - Android and iOS](https://img.shields.io/badge/platform-Android%20%7C%20iOS-blue.svg?style=for-the-badge)

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)



  



# Installation

Add the dependency:

```bash

npm i react-native-gorgeous-header

```

## Peer Dependencies

Zero Dependency

# Usage

## Import

```jsx

import GorgeousHeader from "react-native-gorgeous-header";

```

## Fundamental Usage

```jsx

```

# Configuration - Props

## Gorgeous Header Props

| Property              |   Type   |            Default             | Description                                                             |

| --------------------- | :------: | :----------------------------: | ----------------------------------------------------------------------- |

| title                 |  string  |             Order              | change the title                                                        |

| subtitle              |  string  | Healthy food can keep you fit. | change the subtitle                                                     |

| searchIcon            |  asset   |            default             | set your own icon for the search one                                    |

| style                 |  style   |            default             | set your own style for main container                                   |

| contentContainerStyle |  style   |            default             | set your own style for content container style                          |

| titleTextStyle        |  style   |            default             | set your own style for title text                                       |

| subtitleTextStyle     |  style   |            default             | set your own style for subtitle text                                    |

| searchBarStyle        |  style   |            default             | set your own style for search text input container                      |

| searchInputStyle      |  style   |            default             | set your own style for search text input                                |

| menuImageStyle        |  style   |            default             | set your own style for hamburger menu image                             |

| menuImageSource       |  asset   |            default             | set your own image instead of default hamburger menu image              |

| profileImageStyle     |  style   |            default             | set your own style for profile image                                    |

| profileImageSource    |  asset   |           undefined            | use this to set your own image for profile image                        |

| onMenuImagePress      | function |           undefined            | use this to set your own function for pressing the hamburger menu image |

| onProfileImagePress   | function |           undefined            | use this to set your own function for pressing the profile image        |

## Future Plans

- [x] ~~LICENSE~~

## Author

FreakyCoder, kurayogun@gmail.com

## License

React Native Gorgeous Header is available under the MIT license. See the LICENSE file for more info.