Skip to content

Commit

Permalink
docs: add usage and props
Browse files Browse the repository at this point in the history
  • Loading branch information
erichartline committed Jul 19, 2021
1 parent c1ab11b commit 0477988
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,18 @@ yarn add dictyBase/dicty-components-page-editor#1.0.0

## Usage

coming soon...
Check the `example` folder for a demo app showing how to use the page editor library.

The demo app can also be started by running `yarn demo`.

### Props

coming soon...
- `pageContent` (string) - fetched page content _(optional)_
- `readOnly` (boolean) - determines if editor is in read-only mode
- `handleSave` (function) - called when user clicks the save button
- `handleCancel` (function) - called when user clicks the cancel button
- `inline` (boolean) - used to display a smaller toolbar for inline editing _(optional)_
- `theme` (Material-UI theme) - any custom MUI theme _(optional)_

## Development

Expand Down

0 comments on commit 0477988

Please sign in to comment.