react-marky-markdown
TypeScript icon, indicating that this package has built-in type declarations

0.6.2 • Public • Published

React Marky Markdown

npm version

A clean markdown editor for react.

Currently in beta. Like this readme :)

Usage

yarn add react-marky-markdown

import { Editor, Mention } from 'react-marky-markdown';
// Includes necessary styling
import 'react-marky-markdown/dist/styles.css';
 
const App = () => {
  return (
    <Editor>
      <Mention
        prefix="@"
        data={[
          { value: 'terminator', label: 'Arnold Schwarzenegger' },
          { value: 'markymark', label: 'Mark wahlberg' },
        ]}
      />
    </Editor>
  );
};

Props

// Editor
{
  defaultValue?: string;
  singleLine?: boolean;
  disableFormatting?: boolean;
  onChange?(value: string): void;
  onSubmit?()void;
  onBlur?()void;
  onCancel?()void;
}
 
// Mention
{
  prefix: string;
  dataItem[]// { value: string | number; label: string; }
  onSearch?(value: string): void;
}

Package Sidebar

Install

npm i react-marky-markdown

Weekly Downloads

11

Version

0.6.2

License

MIT

Unpacked Size

175 kB

Total Files

13

Last publish

Collaborators

  • danielbrodin