This repository contains a WYSIWYG editor for markdown that conforms to the CommonMark specification.
The editor is based on React, Slate, and the Accord Project markdown-transform project.
npm install @accordproject/ui-markdown-editor @accordproject/markdown-slate slate slate-history slate-react semantic-ui-react semantic-ui-cssimport React, { useState, useCallback } from 'react';
import ReactDOM from 'react-dom';
import { SlateTransformer } from '@accordproject/markdown-slate';
import { MarkdownEditor } from '@accordproject/ui-markdown-editor';
import 'semantic-ui-css/semantic.min.css';
const slateTransformer = new SlateTransformer();
const defaultMarkdown = `This is text. You can edit it.`;
const App = () => {
const [slateValue, setSlateValue] = useState(() => {
const slate = slateTransformer.fromMarkdown(defaultMarkdown);
return slate.document.children;
});
const onSlateValueChange = useCallback((slateChildren) => {
localStorage.setItem('slate-editor-value', JSON.stringify(slateChildren));
const slateValue = { document: { children: slateChildren } };
setSlateValue(slateValue.document.children);
}, []);
return (<MarkdownEditor readOnly={false} value={slateValue} onChange={onSlateValueChange} />);
}
ReactDOM.render(<App />, document.getElementById('root'));While Storybook is running, if you make a change in a package that you want to see reflected in the demo, in a new terminal:
cd packages/ui-markdown-editor
npm run buildStorybook will reload with the applied changes.
value: Anarraywhich is the initial contents of the editor (markdown text)
onChange: A callbackfunctioncalled when contents of the editor change, receives the markdown text
readOnly: Abooleanto lock all text and remove the formatting toolbarplaceholder: Placeholderstringfor text when the editor is blankactiveButton: Optionalobjectto change formatting button active state color{ background: '#FFF', symbol: '#000' }
onChange: A callbackfunctioncalled when contents of the editor change, receives the markdown textaugmentEditor: A higher order function to augment the methods on the Slate editorcustomElements: Afunctionfor extending elements rendered by editorisEditable: Afunctionfor determining if the current edit should be allowedcanBeFormatted: Afunctionthat determines if current formatting change should be allowedcanCopy: Afunctionthat determines if current selection copy should be allowedcanKeyDown: Afunctionthat determines if current key event should be allowedonDragStart: Afunctionto call when onDragStart event fires which will receive editor and eventonDrop: Afunctionto call when onDrop event fires which will receive editor and eventonDragOver: Afunctionto call when onDragOver event fires which will receive editor and event
Accord Project is an open source, non-profit, initiative working to transform contract management and contract automation by digitizing contracts. Accord Project operates under the umbrella of the Linux Foundation. The technical charter for the Accord Project can be found here.
The Accord Project technology is being developed as open source. All the software packages are being actively maintained on GitHub and we encourage organizations and individuals to contribute requirements, documentation, issues, new templates, and code.
Find out what’s coming on our blog.
Join the Accord Project Technology Working Group Slack channel to get involved!
For code contributions, read our CONTRIBUTING guide and information for DEVELOPERS.
Using Accord Project? Add a README badge to let everyone know:
[](https://www.accordproject.org/)
Accord Project source code files are made available under the Apache License, Version 2.0. Accord Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0).
Copyright 2018-2019 Clause, Inc. All trademarks are the property of their respective owners. See LF Projects Trademark Policy.