generated from WrathChaos/react-native-typescript-library-starter
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Re-write ClassicHeader for better coding and better styling
- Loading branch information
1 parent
d17474d
commit dbd0440
Showing
18 changed files
with
489 additions
and
389 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,48 +1,26 @@ | ||
| <img alt="React Native Typescript Library Starter" src="assets/logo.png" width="1050"/> | ||
| <img alt="React Native Classic Header" src="assets/logo.png" width="1050"/> | ||
|
|
||
| [](https://github.com/WrathChaos/react-native-typescript-library-starter) | ||
| [](https://github.com/WrathChaos/react-native-classic-header) | ||
|
|
||
| [](https://github.com/WrathChaos/react-native-typescript-library-starter) | ||
| [](https://github.com/WrathChaos/react-native-classic-header) | ||
|
|
||
| [](https://www.npmjs.com/package/react-native-typescript-library-starter) | ||
| [](https://www.npmjs.com/package/react-native-typescript-library-starter) | ||
| [](https://www.npmjs.com/package/react-native-classic-header) | ||
| [](https://www.npmjs.com/package/react-native-classic-header) | ||
|  | ||
| [](https://opensource.org/licenses/MIT) | ||
| [](https://github.com/prettier/prettier) | ||
|
|
||
| <p align="center"> | ||
| <img alt="React Native Typescript Library Starter" | ||
| src="assets/Screenshots/typescript.jpg" /> | ||
| <img alt="React Native Classic Header" | ||
| src="assets/Screenshots/React-Native-Classic-Header.png" /> | ||
| </p> | ||
|
|
||
| ## Library Usage | ||
|
|
||
| - `npm i` | ||
| - Delete example folder | ||
| - Delete build folder | ||
| - Make your own library into the `lib` folder | ||
| - Change package.json | ||
| - Change README for your own documentation | ||
| - `npm run build` | ||
|
|
||
| ``` | ||
| > [email protected] build /Users/kuray/Coursion/MyLibraries/ReactNative/react-native-typescript-library-starter | ||
| > cd lib && tsc && cp ../package.json ../build/dist/ && Echo Build completed! | ||
| Build completed! | ||
| ``` | ||
|
|
||
| - Test your build/dist into the new project | ||
| - Finally, time to npm publish :) | ||
|
|
||
| ### Below part is for Documentation ! Remove above Library Usage | ||
|
|
||
| # Installation | ||
|
|
||
| Add the dependency: | ||
|
|
||
| ```bash | ||
| npm i react-native-typescript-library-starter | ||
| npm i react-native-classic-header | ||
| ``` | ||
|
|
||
| ## Peer Dependencies | ||
|
|
@@ -52,44 +30,88 @@ npm i react-native-typescript-library-starter | |
| ```js | ||
| "react": ">= 16.x.x", | ||
| "react-native": ">= 0.55.x", | ||
| "react-native-vector-icons": ">= 7.0.0", | ||
| "react-native-dynamic-vector-icons": ">= 1.0.0", | ||
| "@freakycoder/react-native-helpers": ">= 0.1.3" | ||
| ``` | ||
|
|
||
| # Usage | ||
|
|
||
| ## Import | ||
|
|
||
| ```jsx | ||
| import MyComponent from "react-native-typescript-library-starter"; | ||
| import ClassicHeader from "react-native-classic-header"; | ||
| ``` | ||
|
|
||
| ## Fundamental Usage | ||
| ## Classic Header Usage | ||
|
|
||
| ### Basic Usage | ||
|
|
||
| ```jsx | ||
| <MyComponent /> | ||
| <ClassicHeader | ||
| headerTitle="Header" | ||
| rightComponentDisable | ||
| leftComponentOnPress={() => {}} | ||
| hitSlops={ | ||
| top: 30, | ||
| bottom: 30, | ||
| left: 30, | ||
| right: 30 | ||
| } | ||
| /> | ||
| ``` | ||
|
|
||
| ### Advanced Custom Usage | ||
|
|
||
| ```jsx | ||
| <ClassicHeader | ||
| headerTitle="Header" | ||
| leftComponent={ | ||
| <TouchableOpacity onPress={() => {}}> | ||
| <Icon name="ios-arrow-back" type="Ionicons" size={30} color="blue" /> | ||
| </TouchableOpacity> | ||
| } | ||
| rightComponent={ | ||
| <TouchableOpacity onPress={() => {}}> | ||
| <Icon name="github" type="AntDesign" size={30} color="purple" /> | ||
| </TouchableOpacity> | ||
| } | ||
| /> | ||
| ``` | ||
|
|
||
| # Configuration - Props | ||
|
|
||
| | Property | Type | Default | Description | | ||
| | -------- | :-----: | :-----: | ------------------------------------------------------- | | ||
| | outline | boolean | true | make the button outline | | ||
| | solid | boolean | false | make the button with a solid background and a shadow | | ||
| | gradient | boolean | false | make the button with a gradient background and a shadow | | ||
| | width | number | 150 | change the button's width | | ||
| ## Classic Header Props | ||
|
|
||
| | Property | Type | Default | Description | | ||
| | --------------------- | :-------: | :--------: | ---------------------------------------------------------------------------- | | ||
| | styles | styles | styles | use this to change main style of the header | | ||
| | height | number | 50 | use this to change the header's height | | ||
| | width | number | 100% | use this to change the header's width | | ||
| | statusBarHidden | boolean | false | use this to let Header Component itself re-arrange depends on the status bar | | ||
| | hitSlops | object | object: 30 | use this to change the header's left and right components' hitSlots | | ||
| | bottomStick | boolean | false | stick the header to bottom side | | ||
| | headerTitle | string | "" | use this to set header's title | | ||
| | backgroundColor | color | #ffffff | use this to change the header's background color | | ||
| | leftComponent | component | Icon | set the left component | | ||
| | leftComponentStyle | style | style | set the left component's style | | ||
| | leftComponentDisable | boolean | false | disable the left component | | ||
| | leftComponentOnPress | function | null | set the left component's onPress function | | ||
| | rightComponent | component | Icon | set the right component | | ||
| | rightComponentStyle | style | style | set the right component's style | | ||
| | rightComponentDisable | boolean | false | disable the right component | | ||
| | rightComponentOnPress | function | null | set the right component's onPress function | | ||
| | centerComponent | component | Icon | set the center component | | ||
| | centerComponentStyle | style | style | set the center component's style | | ||
|
|
||
| ## Future Plans | ||
|
|
||
| - [x] ~~LICENSE~~ | ||
| - [ ] Write an article about the lib on Medium | ||
|
|
||
| # Change Log | ||
|
|
||
| Change log will be here ! | ||
|
|
||
| ## Author | ||
|
|
||
| FreakyCoder, [email protected] | ||
|
|
||
| ## License | ||
|
|
||
| React Native Typescript Library Starter is available under the MIT license. See the LICENSE file for more info. | ||
| React Native Classic Header is available under the MIT license. See the LICENSE file for more info. | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,114 +1,16 @@ | ||
| /** | ||
| * Sample React Native App | ||
| * https://github.com/facebook/react-native | ||
| * | ||
| * @format | ||
| * @flow strict-local | ||
| */ | ||
| import React from "react"; | ||
| import { StatusBar, SafeAreaView } from "react-native"; | ||
| import ClassicHeader from "react-native-classic-header"; | ||
|
|
||
| import React from 'react'; | ||
| import { | ||
| SafeAreaView, | ||
| StyleSheet, | ||
| ScrollView, | ||
| View, | ||
| Text, | ||
| StatusBar, | ||
| } from 'react-native'; | ||
|
|
||
| import { | ||
| Header, | ||
| LearnMoreLinks, | ||
| Colors, | ||
| DebugInstructions, | ||
| ReloadInstructions, | ||
| } from 'react-native/Libraries/NewAppScreen'; | ||
|
|
||
| const App: () => React$Node = () => { | ||
| const App = () => { | ||
| return ( | ||
| <> | ||
| <StatusBar barStyle="dark-content" /> | ||
| <SafeAreaView> | ||
| <ScrollView | ||
| contentInsetAdjustmentBehavior="automatic" | ||
| style={styles.scrollView}> | ||
| <Header /> | ||
| {global.HermesInternal == null ? null : ( | ||
| <View style={styles.engine}> | ||
| <Text style={styles.footer}>Engine: Hermes</Text> | ||
| </View> | ||
| )} | ||
| <View style={styles.body}> | ||
| <View style={styles.sectionContainer}> | ||
| <Text style={styles.sectionTitle}>Step One</Text> | ||
| <Text style={styles.sectionDescription}> | ||
| Edit <Text style={styles.highlight}>App.js</Text> to change this | ||
| screen and then come back to see your edits. | ||
| </Text> | ||
| </View> | ||
| <View style={styles.sectionContainer}> | ||
| <Text style={styles.sectionTitle}>See Your Changes</Text> | ||
| <Text style={styles.sectionDescription}> | ||
| <ReloadInstructions /> | ||
| </Text> | ||
| </View> | ||
| <View style={styles.sectionContainer}> | ||
| <Text style={styles.sectionTitle}>Debug</Text> | ||
| <Text style={styles.sectionDescription}> | ||
| <DebugInstructions /> | ||
| </Text> | ||
| </View> | ||
| <View style={styles.sectionContainer}> | ||
| <Text style={styles.sectionTitle}>Learn More</Text> | ||
| <Text style={styles.sectionDescription}> | ||
| Read the docs to discover what to do next: | ||
| </Text> | ||
| </View> | ||
| <LearnMoreLinks /> | ||
| </View> | ||
| </ScrollView> | ||
| <ClassicHeader title="Profile" /> | ||
| </SafeAreaView> | ||
| </> | ||
| ); | ||
| }; | ||
|
|
||
| const styles = StyleSheet.create({ | ||
| scrollView: { | ||
| backgroundColor: Colors.lighter, | ||
| }, | ||
| engine: { | ||
| position: 'absolute', | ||
| right: 0, | ||
| }, | ||
| body: { | ||
| backgroundColor: Colors.white, | ||
| }, | ||
| sectionContainer: { | ||
| marginTop: 32, | ||
| paddingHorizontal: 24, | ||
| }, | ||
| sectionTitle: { | ||
| fontSize: 24, | ||
| fontWeight: '600', | ||
| color: Colors.black, | ||
| }, | ||
| sectionDescription: { | ||
| marginTop: 8, | ||
| fontSize: 18, | ||
| fontWeight: '400', | ||
| color: Colors.dark, | ||
| }, | ||
| highlight: { | ||
| fontWeight: '700', | ||
| }, | ||
| footer: { | ||
| color: Colors.dark, | ||
| fontSize: 12, | ||
| fontWeight: '600', | ||
| padding: 4, | ||
| paddingRight: 12, | ||
| textAlign: 'right', | ||
| }, | ||
| }); | ||
|
|
||
| export default App; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.