Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added description to use components
  • Loading branch information
082rakesh authored May 8, 2024
1 parent 5af8451 commit 243cd54
Showing 1 changed file with 24 additions and 7 deletions.
31 changes: 24 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# react-native-ui-kit

This is React Native reusable UI Kit
This is a React Native reusable UI Kit. It contains
- CustomButton
- CardView

## Installation

Expand All @@ -10,20 +12,35 @@ npm install react-native-ui-kit

## Usage

# import CustomButton from 'rm-ui-widget';

<CustomButton type={ButtonType.PRIMARY} onPress={onPrimaryPressHandler}>
Custom button has 5 button types available however you can customize button style and pass style in Props

```js
import CustomButton from 'rm-ui-widget';

<CustomButton type={ButtonType.PRIMARY} onPress={onPrimaryPressHandler}>
<Text>Primary Button</Text>
</CustomButton>

<CustomButton type={ButtonType.SECONDARY}>
<Text>Secondary Button</Text>
</CustomButton>

# Custom button has 5 button type available however you can customize button style and pass style in Props

```
## Customize button with custom style:
```js
export type Props = {
children: React.ReactElement;
onPress?: () => void;
style?: ViewStyle;
type?: ButtonType;
};
```
# CardView
```js
// ...
import CardView from 'rm-ui-widget';
<View style={styles.container}>
<CardView />
</View>
```

## Contributing
Expand Down

0 comments on commit 243cd54

Please sign in to comment.