From c35309d1d9d1742c30e4138b31015c02f2a28c89 Mon Sep 17 00:00:00 2001 From: Garry Lachman Date: Thu, 10 Jun 2021 03:53:01 +0300 Subject: [PATCH] readme --- README.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) diff --git a/README.md b/README.md index febdb39..6b0c684 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,72 @@ + # react-native-awesome-table + React-Native Simple Data Tables + + +Examples cam be found on our Storybook https://garrylachman.github.io/react-native-awesome-table/?path=/story/cell--default + +## Installation +#### NPM +``` bash +npm -i --save react-native-awesome-table +``` +### YARN +``` bash +yarn add react-native-awesome-table +``` + +## Examples +### Basic Example +![Basic Example](https://i.imgur.com/sLqnXre.png) + +``` ts +import React from 'react'; +import Table, {ColumnProps} from 'react-native-awesome-table'; + +type DataRow = { + id: number, + firstName: string, + lastName: string, + country: string +}; + +const columns:ColumnProps[] = [ + { 'dataKey': 'id', title: 'ID', flex: 1 }, + { 'dataKey': 'firstName', title: 'First Name', flex: 2 }, + { 'dataKey': 'lastName', title: 'Last Name', flex: 2 } + { 'dataKey': 'country', title: 'Country', flex: 3 } +] + +const exampleRow:DataRow = { + id: 0, + firstName: "Garry", + lastName: "Lachman", + country: "Israel" +}; + +export BasicTable = () => { + const [data, setData] = React.useState([]); + + React.useEffect(() => { + setData( + [...Array(10)].map( + (_, i) => ({...exampleRow, id: ++i}) + ) + ); + }, []); + + return ( + + ) +}; +``` +Basic example storybook: https://garrylachman.github.io/react-native-awesome-table/?path=/story/table--basic&args=rowsCount:10 + + + +### License +React Native Awesome Table is [MIT licensed](./LICENSE). \ No newline at end of file