Skip to content

Commit 96c5474

Browse files
authored
docs: add showcase and web support (#28)
1 parent 32b0ee7 commit 96c5474

File tree

9 files changed

+80
-6
lines changed

9 files changed

+80
-6
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44

55
React Native Header is a high-performance, cross-platform animated header component for React Native applications. It provides an easy-to-use interface for developers to quickly create beautiful and dynamic navigation headers.
66

7-
| iOS | Android |
8-
| ------------- | ------------- |
9-
| <img src="https://user-images.githubusercontent.com/128341688/226800421-03a17bd1-aeb9-4ff3-89e6-c51634e40c75.gif" alt="iOS React Native Header Showcase" width="100%"> | <img src="https://user-images.githubusercontent.com/128341688/226800411-5130076d-613a-49c9-b690-41a306b6414e.gif" alt="Android React Native Header Showcase" width="100%"> |
7+
| Android/iOS/Web |
8+
| ------------- |
9+
| <img src="https://github.com/codeherence/react-native-header/assets/128341688/b465a0f5-ce06-46a7-9894-849db698b66b" alt="iOS React Native Header Showcase" width="100%"> |
1010

1111
## Features
1212

13-
- Maintains a similar experience between **iOS** and **Android**.
13+
- Maintains a similar experience between **iOS**, **Android**, and **Web**.
1414
- Uses Reanimated for better animation performance
1515
- Works with [ScrollView](https://reactnative.dev/docs/scrollview), [FlatList](https://reactnative.dev/docs/flatlist), and [SectionList](https://reactnative.dev/docs/sectionlist)
1616
- Compatible with [Expo Go](https://docs.expo.dev/) and bare [React Native](https://github.com/react-native-community/cli) projects

docs/docs/04-web-support.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Web Support
3+
hide_table_of_contents: false
4+
slug: /web-support
5+
description: Web Support for React Native Header.
6+
---
7+
8+
import Tabs from '@theme/Tabs';
9+
import TabItem from '@theme/TabItem';
10+
11+
This library, primarily developed using [Reanimated](https://docs.swmansion.com/react-native-reanimated), necessitates specific setup steps to ensure compatibility with web platforms. Users are required to follow the [Web Support setup for react-native-reanimated](https://docs.swmansion.com/react-native-reanimated/docs/guides/web-support/) prior to integration, assuming this has not been previously done.
12+
13+
### FlashList
14+
15+
For web applications using FlashList, you are required to use a version of FlashList that is verified for web compatibility.

docs/docs/05-showcase.mdx

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Showcase
3+
hide_table_of_contents: false
4+
slug: /showcase
5+
description: Showcase of React Native Header.
6+
---
7+
8+
import Tabs from '@theme/Tabs';
9+
import TabItem from '@theme/TabItem';
10+
import ReactPlayer from 'react-player';
11+
12+
All of the examples can be reviewed in the [`example` application of the react-native-header repository](https://github.com/codeherence/react-native-header/tree/main/example).
13+
14+
## FlashList
15+
16+
<ReactPlayer playing controls url="/videos/flashlist.mp4" />
17+
18+
## Inverted Chat
19+
20+
<ReactPlayer playing controls url="/videos/inverted-chat.mp4" />
21+
22+
## Twitter
23+
24+
<ReactPlayer playing controls url="/videos/twitter.mp4" />
25+
26+
## Absolute Header with Blurred Surface
27+
28+
<ReactPlayer
29+
playing
30+
controls
31+
url="/videos/absolute-header-with-blurred-surface.mp4"
32+
/>

docs/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@
2121
"clsx": "^1.2.1",
2222
"prism-react-renderer": "^1.3.5",
2323
"react": "^17.0.2",
24-
"react-dom": "^17.0.2"
24+
"react-dom": "^17.0.2",
25+
"react-player": "^2.15.0"
2526
},
2627
"devDependencies": {
2728
"@docusaurus/module-type-aliases": "2.4.0",
690 KB
Binary file not shown.

docs/static/videos/flashlist.mp4

1.51 MB
Binary file not shown.
6.13 MB
Binary file not shown.

docs/static/videos/twitter.mp4

1.14 MB
Binary file not shown.

docs/yarn.lock

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3342,7 +3342,7 @@ deep-extend@^0.6.0:
33423342
resolved "https://registry.yarnpkg.com/deep-extend/-/deep-extend-0.6.0.tgz#c4fa7c95404a17a9c3e8ca7e1537312b736330ac"
33433343
integrity sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==
33443344

3345-
deepmerge@^4.2.2:
3345+
deepmerge@^4.0.0, deepmerge@^4.2.2:
33463346
version "4.3.1"
33473347
resolved "https://registry.yarnpkg.com/deepmerge/-/deepmerge-4.3.1.tgz#44b5f2147cd3b00d4b56137685966f26fd25dd4a"
33483348
integrity sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==
@@ -4882,6 +4882,11 @@ lines-and-columns@^1.1.6:
48824882
resolved "https://registry.yarnpkg.com/lines-and-columns/-/lines-and-columns-1.2.4.tgz#eca284f75d2965079309dc0ad9255abb2ebc1632"
48834883
integrity sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==
48844884

4885+
load-script@^1.0.0:
4886+
version "1.0.0"
4887+
resolved "https://registry.yarnpkg.com/load-script/-/load-script-1.0.0.tgz#0491939e0bee5643ee494a7e3da3d2bac70c6ca4"
4888+
integrity sha512-kPEjMFtZvwL9TaZo0uZ2ml+Ye9HUMmPwbYRJ324qF9tqMejwykJ5ggTyvzmrbBeapCAbk98BSbTeovHEEP1uCA==
4889+
48854890
loader-runner@^4.2.0:
48864891
version "4.3.0"
48874892
resolved "https://registry.yarnpkg.com/loader-runner/-/loader-runner-4.3.0.tgz#c1b4a163b99f614830353b16755e7149ac2314e1"
@@ -5058,6 +5063,11 @@ memfs@^3.1.2, memfs@^3.4.3:
50585063
dependencies:
50595064
fs-monkey "^1.0.3"
50605065

5066+
memoize-one@^5.1.1:
5067+
version "5.2.1"
5068+
resolved "https://registry.yarnpkg.com/memoize-one/-/memoize-one-5.2.1.tgz#8337aa3c4335581839ec01c3d594090cebe8f00e"
5069+
integrity sha512-zYiwtZUcYyXKo/np96AGZAckk+FWWsUdJ3cHGGmld7+AhvcWmQyGCYUh1hc4Q/pkOhb65dQR/pqCyK0cOaHz4Q==
5070+
50615071
merge-descriptors@1.0.1:
50625072
version "1.0.1"
50635073
resolved "https://registry.yarnpkg.com/merge-descriptors/-/merge-descriptors-1.0.1.tgz#b00aaa556dd8b44568150ec9d1b953f3f90cbb61"
@@ -6056,6 +6066,11 @@ react-error-overlay@^6.0.11:
60566066
resolved "https://registry.yarnpkg.com/react-error-overlay/-/react-error-overlay-6.0.11.tgz#92835de5841c5cf08ba00ddd2d677b6d17ff9adb"
60576067
integrity sha512-/6UZ2qgEyH2aqzYZgQPxEnz33NJ2gNsnHA2o5+o4wW9bLM/JYQitNP9xPhsXwC08hMMovfGe/8retsdDsczPRg==
60586068

6069+
react-fast-compare@^3.0.1:
6070+
version "3.2.2"
6071+
resolved "https://registry.yarnpkg.com/react-fast-compare/-/react-fast-compare-3.2.2.tgz#929a97a532304ce9fee4bcae44234f1ce2c21d49"
6072+
integrity sha512-nsO+KSNgo1SbJqJEYRE9ERzo7YtYbou/OqjSQKxV7jcKox7+usiUVZOAC+XnDOABXggQTno0Y1CpVnuWEc1boQ==
6073+
60596074
react-fast-compare@^3.2.0:
60606075
version "3.2.1"
60616076
resolved "https://registry.yarnpkg.com/react-fast-compare/-/react-fast-compare-3.2.1.tgz#53933d9e14f364281d6cba24bfed7a4afb808b5f"
@@ -6099,6 +6114,17 @@ react-loadable-ssr-addon-v5-slorber@^1.0.1:
60996114
dependencies:
61006115
"@babel/runtime" "^7.10.3"
61016116

6117+
react-player@^2.15.0:
6118+
version "2.15.0"
6119+
resolved "https://registry.yarnpkg.com/react-player/-/react-player-2.15.0.tgz#e7ed486de971f5a9643ccceefddefba9d923d78a"
6120+
integrity sha512-wo7LM3CwxkjW9WdvGrQ3I0PhIl5xY1h+9EdpSnCRaQhE4dRMGmfH60RITPaauUhd2uJkGpzAj27kWYHT1j/dBw==
6121+
dependencies:
6122+
deepmerge "^4.0.0"
6123+
load-script "^1.0.0"
6124+
memoize-one "^5.1.1"
6125+
prop-types "^15.7.2"
6126+
react-fast-compare "^3.0.1"
6127+
61026128
react-router-config@^5.1.1:
61036129
version "5.1.1"
61046130
resolved "https://registry.yarnpkg.com/react-router-config/-/react-router-config-5.1.1.tgz#0f4263d1a80c6b2dc7b9c1902c9526478194a988"

0 commit comments

Comments
 (0)