Skip to content

Update readme files + check publish #157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 4, 2021
Merged

Update readme files + check publish #157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,13 @@ Two optional themes are supported when using React Tree:
<img src="react-tree-demo.gif?raw=true" width="288" />
</p>

Both options support component customization. - [examples](https://github.com/kenshoo/react-tree/blob/master/packages/docs/stories/core.stories.js)
Both options support component customization. <br/>
Examples can be found - [here](https://github.com/kenshoo/react-tree/blob/master/packages/docs/stories/core.stories.js)

<br/>

### Props

<!-- props-table-start -->
| Name | Type | Default | Description |
| :------------------ | :---------- | :--------------------- | :-------------------------------------------------------------- |
| `structure` | `Array` | `[]` | `Component input - array of leaves along with their ancestors` |
Expand All @@ -50,7 +51,7 @@ Both options support component customization. - [examples](https://github.com/ke
| `treeContainerRenderer`| `Component` | `tree_container.js` | `Component to replace the default TreeContainer component. ` |
| `customItemsRenderer ` | `Component` | | `Component to replace the default Items && inner Item component.`|
| `markSelectedItem` | `boolean` | `false` | `Toggle to mark selected item. ` |

<!-- props-table-end -->
<br/>

## How to Contribute
Expand Down
3 changes: 2 additions & 1 deletion packages/core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ React Tree is a straight forward component that allows a user to display and man

The basic tree is built using @emotion/core, and supports both styling and component renderers customizations.

[Examples](https://github.com/kenshoo/react-tree/blob/master/packages/docs/stories/core.stories.js)

Examples can be found - [here](https://github.com/kenshoo/react-tree/blob/master/packages/docs/stories/core.stories.js)


<p align="center">
Expand Down
1 change: 1 addition & 0 deletions packages/material_tree/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Material Tree is an enrichment to React Tree component.
It is based on basic React Tree logic and allows
a user to display and manage a hierarchical structure of items using <b>Material-UI</b> components.

Examples can be found - [here](https://github.com/kenshoo/react-tree/blob/master/packages/docs/stories/core.stories.js)

<p align="center">
<img src="react-tree-demo.gif?raw=true" width="288" />
Expand Down