https://github.com/garrylachman/react-native-syslogd
https://github.com/garrylachman/react-native-syslogd
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/garrylachman/react-native-syslogd
- Owner: garrylachman
- Created: 2021-05-21T16:26:37.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-05-21T16:26:38.000Z (almost 4 years ago)
- Last Synced: 2025-02-15T14:23:40.123Z (2 months ago)
- Language: Java
- Size: 343 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/WrathChaos/react-native-typescript-library-starter)
[](https://github.com/WrathChaos/react-native-typescript-library-starter)
[](https://www.npmjs.com/package/react-native-typescript-library-starter)
[](https://www.npmjs.com/package/react-native-typescript-library-starter)
[](https://opensource.org/licenses/MIT)
[](https://github.com/prettier/prettier)
## 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
```
## Peer Dependencies
IMPORTANT! You need install them
```js
"react": ">= 16.x.x",
"react-native": ">= 0.55.x",
```
# Usage
## Import
```jsx
import MyComponent from "react-native-typescript-library-starter";
```
## Fundamental Usage
```jsx
```
## 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
| Property | Type | Default | Description |
| ----------- | :----: | :-------: | --------------------- |
| title | string | undefined | change the title |
| description | string | undefined | change the descrition |
## Customization (Optionals)
| Property | Type | Default | Description |
| -------------- | :-------: | :-------: | ---------------------------------------------------------------------- |
| enableButton | boolean | false | let you enable the button (must use it for button) |
| onPress | function | undefined | set your own logic for the button functionality when it is pressed |
| buttonText | string | undefined | change the button's text |
| style | ViewStyle | default | set or override the style object for the main container |
| buttonStyle | ViewStyle | default | set or override the style object for the button style |
| ImageComponent | Image | default | set your own component instead of default react-native Image component |
## 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.