# @hamzav/react-native-headerbar

> Header bar with a hamburger menu for react-native apps

Latest version **1.0.2** (published 2019-04-26) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @hamzav/react-native-headerbar
pnpm add @hamzav/react-native-headerbar
yarn add @hamzav/react-native-headerbar
bun add @hamzav/react-native-headerbar
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2019-04-26 |
| First published | 2019-04-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 9.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | hamzav |
| Maintainers | hamzav |
| Keywords | react-native-header, react-native-headerbar, headerbar |

## Links

- npm: https://www.npmjs.com/package/@hamzav/react-native-headerbar
- Repository: https://github.com/HamzaKV/react-native-headerbar
- Homepage: https://github.com/HamzaKV/react-native-headerbar#readme
- Issues: https://github.com/HamzaKV/react-native-headerbar/issues
- npm.io page: https://npm.io/package/@hamzav/react-native-headerbar

## Recent versions

- 1.0.2 (latest) — 2019-04-26
- 1.0.1 — 2019-04-26
- 1.0.0 — 2019-04-26

## README

# React Native Header Bar

Header bar with a hamburger menu for react-native apps.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

What things you need to install the software:

Download and Install: [Node](https://nodejs.org/en/)

Once Node is installed, run

```
npm install react-native
```

Have an up and running react-native project. See https://facebook.github.io/react-native/docs/getting-started for more information.

### Installing

To install component, navigate to project root directory and run

```
npm install react-native-simple-headerbar
```

## Documentation

### Props

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `hideHamburgerMenu` | `PropTypes.boolean` | No |  | Boolean to hide hamburger menu. |
| `onMenuPress` | `PropTypes.func` | No |  | Function to handle on hambruger menu press. |
| `hamburgerMenuColor` | `PropTypes.string` | No |  | String to hold hamburger menu color. |
| `text` | `PropTypes.string` | No |  | Title for the header. |
| `textStyle` | `PropTypes.object` | No |  | CSS object to style text. |
| `showBackButton` | `PropTypes.boolean` | No |  | Boolean to control if back button should be shown. (hideHamburgerMenu takes precedence) |
| `onBackButtonPress` | `PropTypes.func` | No |  | Function to handle on back button press. |
| `style` | `PropTypes.object` | No |  | CSS object to style bar. |

### Usage

#### Within react-native js file

```
import Header from 'react-native-headerbar';

<Header
    hideHamburgerMenu={false}
    hamburgerMenuColor="white"
    onMenuPress={...}
    text="Example"
    textStyle={...}
/>
```

## Built With

* [Node](https://nodejs.org/en/)
* [React](https://reactjs.org/)
* [React Native](https://facebook.github.io/react-native/)

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). 

## Authors

* **Hamza Varvani** - *Initial work* - [HamzaKV](https://github.com/HamzaKV)

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## Acknowledgments

* Inspiration - https://github.com/fattahmuhyiddeen/react-native-arrow

---
_Source: https://npm.io/package/@hamzav/react-native-headerbar · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._