rnt

react-native-typescript-library-starter

Ready to Rock πŸ”₯

Showing:

Popularity

Downloads/wk

7

GitHub Stars

15

Maintenance

Last Commit

1mo ago

Contributors

2

Package

Dependencies

0

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

React Native Typescript Library Starter

Battle Tested βœ…

React Native Typescript Library Starter

npm version npm Platform - Android and iOS License: MIT styled with prettier

React Native Typescript Library Starter

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
> react-native-typescript-library-starter@0.1.0 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:

npm i react-native-typescript-library-starter

Peer Dependencies

IMPORTANT! You need install them
"react": ">= 16.x.x",
"react-native": ">= 0.55.x",

Usage

Import

import MyComponent from "react-native-typescript-library-starter";

Fundamental Usage

<MyComponent />

Example Project 😍

You can checkout the example project πŸ₯°

Simply run

  • npm i
  • react-native run-ios/android

should work of the example project.

Configuration - Props

Fundamentals

PropertyTypeDefaultDescription
titlestringundefinedchange the title
descriptionstringundefinedchange the descrition

Customization (Optionals)

PropertyTypeDefaultDescription
enableButtonbooleanfalselet you enable the button (must use it for button)
onPressfunctionundefinedset your own logic for the button functionality when it is pressed
buttonTextstringundefinedchange the button's text
styleViewStyledefaultset or override the style object for the main container
buttonStyleViewStyledefaultset or override the style object for the button style
ImageComponentImagedefaultset your own component instead of default react-native Image component

Future Plans

  • LICENSE
  • Write an article about the lib on Medium

Change Log

Change log will be here !

Author

FreakyCoder, kurayogun@gmail.com

License

React Native Typescript Library Starter is available under the MIT license. See the LICENSE file for more info.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100