https://github.com/rintoj/native-x-screen
https://github.com/rintoj/native-x-screen
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/rintoj/native-x-screen
- Owner: rintoj
- Created: 2021-02-06T05:01:54.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-10T10:28:59.000Z (almost 5 years ago)
- Last Synced: 2026-01-02T22:42:55.825Z (6 months ago)
- Language: TypeScript
- Size: 166 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# native-x-screen
[](https://github.com/semantic-release/semantic-release)
A wrapper components for screens
## Install
### Yarn
```sh
yarn add native-x-screen
```
### NPM
```sh
npm install native-x-screen
```
## Usage
```tsx
import { Screen } from 'native-x-screen'
function HomeScreen() {
const header = (
HEADER
)
return (
...
)
}
```
## API
| Property | Default Value | Usage |
| ---------------------- | ------------- | ----------------------------------------------------- |
| fill?: boolean | true | Fill container or available space |
| scrollable?: boolean | false | Set true if the screen is scrollable |
| hasForm?: boolean | false | Set true if the screen has a form |
| header?: ReactNode | | Header component |
| children?: ReactNode[] | | Content of the screen |
| keepKeyboard?: boolean | false | If set to true, keyboard will stay up while scrolling |
## Automatic Release
Here is an example of the release type that will be done based on a commit messages:
| Commit message | Release type |
| ------------------- | --------------------- |
| fix: [comment] | Patch Release |
| feat: [comment] | Minor Feature Release |
| perf: [comment] | Major Feature Release |
| doc: [comment] | No Release |
| refactor: [comment] | No Release |
| chore: [comment] | No Release |