Skip to content
This repository was archived by the owner on Dec 3, 2022. It is now read-only.

Commit c24ce8b

Browse files
authored
Update README.md
1 parent edb22b0 commit c24ce8b

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
1-
# React Navigation Hooks
1+
# React Navigation Hooks (v3/v4 only)
22

33
[![npm version](https://badge.fury.io/js/react-navigation-hooks.svg)](https://badge.fury.io/js/react-navigation-hooks) [![npm downloads](https://img.shields.io/npm/dm/react-navigation-hooks.svg)](https://www.npmjs.com/package/react-navigation-hooks) [![CircleCI badge](https://circleci.com/gh/react-navigation/hooks/tree/master.svg?style=shield)](https://circleci.com/gh/react-navigation/hooks/tree/master) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://reactnavigation.org/docs/contributing.html)
44

55
🏄‍♀️ Surfing the wave of React Hook hype with a few convenience hooks for `@react-navigation/core` v3/v4. Destined to work on web, server, and React Native. Contributions welcome!
66

7-
**IMPORTANT**: [react-navigation v5](https://github.com/react-navigation/navigation-ex) is already on its way and is a full rewrite (including hooks). This project will not live past v4, and will try to make the migration path from v4 to v5 easy by not introducing any new hook that won't be in v5.
7+
**IMPORTANT**: [react-navigation v5](https://reactnavigation.org/blog/2020/02/06/react-navigation-5.0.html) is officially released as stable, and includes similar, but rewritten hooks (should be easy to upgrade from v4 to v5). If you use react-naviigation v5, you should import hooks from react-navigation v5 directly, and should not add this project.
88

9-
## Examples (web only so far)
10-
11-
See an example web app which uses react-navigation and hooks on the client and the server:
12-
13-
https://github.com/react-navigation/web-server-example
149

1510
## Docs
1611

@@ -182,3 +177,9 @@ One (always, and only one) of the following values will be true in the focus sta
182177
- isBlurred
183178
- isFocusing
184179

180+
## Web example
181+
182+
See an example web app which uses react-navigation and hooks on the client and the server:
183+
184+
https://github.com/react-navigation/web-server-example
185+

0 commit comments

Comments
 (0)