Skip to content

Commit

Permalink
Merge pull request #3 from oguzturker8/dev
Browse files Browse the repository at this point in the history
Refactor Readme.md
turker0 authored Nov 19, 2021
2 parents dfd0349 + 1c33ee6 commit 900c85d
Showing 2 changed files with 9 additions and 9 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -116,14 +116,14 @@ function Screen4({ navigation }: screenNavigation) {

#### Header

| Prop | Description | Type |
| :-------: | :----------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------: | ------------------------------- | ------- |
| style | Header container style prop.Includes 5 parts <br> leftStyle <br> rightStyle <br> centerStyle <br> wrapperStyle <br> titleStyle | leftStyle?: ViewStyle <br> rightStyle?: ViewStyle <br> centerStyle?: ViewStyle <br> wrapperStyle?: ViewStyle <br> titleStyle?: TextStyle |
| title | Header title text | string |
| type | Decides left and right parts' types | LeftType = 'back' | 'close' <br> RightType = 'back' | 'close' |
| callback | Parts' onPress callbacks | onLeft?: () => any <br> onRight?: () => any <br> onCenter?: () => any |
| size | Parts' text sizes | left?: number <br> right?: number <br> center?: number |
| animation | Header animations | Described on below section |
| Prop | Description | Type |
| :-------: | :--------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------: |
| style | Header container style prop.<br>Includes 5 parts <br> leftStyle <br> rightStyle <br> centerStyle <br> wrapperStyle <br> titleStyle | leftStyle?: ViewStyle <br> rightStyle?: ViewStyle <br> centerStyle?: ViewStyle <br> wrapperStyle?: ViewStyle <br> titleStyle?: TextStyle |
| title | Header title text | string |
| type | Decides left and right parts' types | LeftType = 'back' - 'close' <br> RightType = 'back' - 'close' |
| callback | Parts' onPress callbacks | onLeft?: () => any <br> onRight?: () => any <br> onCenter?: () => any |
| size | Parts' text sizes | left?: number <br> right?: number <br> center?: number |
| animation | Header animations | Described on below section |

#### Animation

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@oguzturker8/header",
"version": "0.1.0",
"version": "0.2.1",
"description": "A header library for react-native. Uses power of reanimated2.",
"main": "lib/commonjs/index",
"module": "lib/module/index",

0 comments on commit 900c85d

Please sign in to comment.