react-outliner
v0.0.10
Published
A React UI component for typing notes.
Downloads
123
Readme
react-outliner
A Workflowy-style outliner UI component for React.
Live demo here: https://ashleydavis.github.io/react-outliner/
I live streamed development of this component on Twitch! See my YouTube channel to watch the recorded live stream:
https://www.youtube.com/c/thedatawrangler
Follow me on Twitter for updates and announcements:
https://twitter.com/ashleydavis75
Check Twitch for the next live stream:
https://www.twitch.tv/ashleydavis
Use it
Install it in your React application:
npm install --save react-outliner
Import it in your React code:
import { Outliner } from "react-outliner";
Use it in your render
function:
<Outliner notes={notes} />
For notes you can start with an empty array, you can create an array/tree of notes or you can load data from a database.
Each note must have an id that is locally unique with in the notes data structure.
Here's an example setup to get started:
const notes = [
{
id: "1",
text: "A note",
children: [],
},
{
id: "2",
text: "Another note",
children: [
{
id: "3",
text: "A child note!",
},
],
},
];
Example
You can find a complete example in the example
subdirectory of the code repository.
Live demo here: https://ashleydavis.github.io/react-outliner/