From 15e8e506019d683dc16285690c5ca760a44dd905 Mon Sep 17 00:00:00 2001 From: Tom Moor Date: Sat, 2 Dec 2017 23:14:27 -0800 Subject: [PATCH] Slate 30 --- .flowconfig | 3 + app/components/Collaborators/Collaborators.js | 4 +- app/components/Editor/Editor.js | 114 ++++---- .../Editor/components/BlockInsert.js | 39 ++- app/components/Editor/components/Code.js | 4 +- app/components/Editor/components/Contents.js | 13 +- app/components/Editor/components/Heading.js | 7 +- .../Editor/components/HorizontalRule.js | 4 +- app/components/Editor/components/Image.js | 16 +- app/components/Editor/components/Link.js | 8 +- app/components/Editor/components/ListItem.js | 4 +- app/components/Editor/components/Paragraph.js | 4 +- app/components/Editor/components/TodoItem.js | 13 +- .../Editor/components/Toolbar/BlockToolbar.js | 49 ++-- .../Editor/components/Toolbar/Toolbar.js | 23 +- .../Toolbar/components/FormattingToolbar.js | 37 +-- .../Toolbar/components/LinkToolbar.js | 26 +- app/components/Editor/headingToSlug.js | 4 +- app/components/Editor/insertImage.js | 11 +- app/components/Editor/marks.js | 22 ++ app/components/Editor/nodes.js | 75 +++++ app/components/Editor/plugins.js | 28 +- .../Editor/plugins/KeyboardShortcuts.js | 25 +- .../Editor/plugins/MarkdownShortcuts.js | 126 ++++----- app/components/Editor/schema.js | 266 +++++++++--------- app/components/Editor/transforms.js | 25 +- app/components/Editor/types.js | 118 -------- package.json | 20 +- yarn.lock | 139 ++++++--- 29 files changed, 617 insertions(+), 610 deletions(-) create mode 100644 app/components/Editor/marks.js create mode 100644 app/components/Editor/nodes.js delete mode 100644 app/components/Editor/types.js diff --git a/.flowconfig b/.flowconfig index 7c57deb4..64330e69 100644 --- a/.flowconfig +++ b/.flowconfig @@ -8,6 +8,9 @@ .*/node_modules/polished/.* .*/node_modules/react-side-effect/.* .*/node_modules/fbjs/.* +.*/node_modules/slate-edit-code/.* +.*/node_modules/slate-edit-list/.* +.*/node_modules/slate-prism/.* .*/node_modules/config-chain/.* *.test.js diff --git a/app/components/Collaborators/Collaborators.js b/app/components/Collaborators/Collaborators.js index d7eaf16e..88b88cfb 100644 --- a/app/components/Collaborators/Collaborators.js +++ b/app/components/Collaborators/Collaborators.js @@ -29,8 +29,8 @@ const Collaborators = ({ document }: Props) => { {collaborators.map(user => ( - - + + ))} diff --git a/app/components/Editor/Editor.js b/app/components/Editor/Editor.js index 8fa84d74..fdb35519 100644 --- a/app/components/Editor/Editor.js +++ b/app/components/Editor/Editor.js @@ -2,9 +2,10 @@ import React, { Component } from 'react'; import { observable } from 'mobx'; import { observer } from 'mobx-react'; -import { Editor, Plain } from 'slate'; +import { Editor } from 'slate-react'; +import type { state, props, change } from 'slate-prop-types'; +import Plain from 'slate-plain-serializer'; import keydown from 'react-keydown'; -import type { State, Editor as EditorType } from './types'; import getDataTransferFiles from 'utils/getDataTransferFiles'; import Flex from 'shared/components/Flex'; import ClickablePadding from './components/ClickablePadding'; @@ -13,18 +14,19 @@ import BlockInsert from './components/BlockInsert'; import Placeholder from './components/Placeholder'; import Contents from './components/Contents'; import Markdown from './serializer'; -import createSchema from './schema'; import createPlugins from './plugins'; import insertImage from './insertImage'; +import renderMark from './marks'; +import createRenderNode from './nodes'; import styled from 'styled-components'; type Props = { text: string, - onChange: Function, - onSave: Function, - onCancel: Function, - onImageUploadStart: Function, - onImageUploadStop: Function, + onChange: change => *, + onSave: (redirect?: boolean) => *, + onCancel: () => void, + onImageUploadStart: () => void, + onImageUploadStop: () => void, emoji?: string, readOnly: boolean, }; @@ -37,15 +39,15 @@ type KeyData = { @observer class MarkdownEditor extends Component { props: Props; - editor: EditorType; - schema: Object; - plugins: Array; - @observable editorState: State; + editor: Editor; + renderNode: props => *; + plugins: Object[]; + @observable editorValue: state; constructor(props: Props) { super(props); - this.schema = createSchema({ + this.renderNode = createRenderNode({ onInsertImage: this.insertImageFile, onChange: this.onChange, }); @@ -55,9 +57,9 @@ class MarkdownEditor extends Component { }); if (props.text.trim().length) { - this.editorState = Markdown.deserialize(props.text); + this.editorValue = Markdown.deserialize(props.text); } else { - this.editorState = Plain.deserialize(''); + this.editorValue = Plain.deserialize(''); } } @@ -77,12 +79,11 @@ class MarkdownEditor extends Component { } } - onChange = (editorState: State) => { - if (this.editorState !== editorState) { - this.props.onChange(Markdown.serialize(editorState)); + onChange = (change: change) => { + if (this.editorValue !== change.value) { + this.props.onChange(Markdown.serialize(change.value)); } - - this.editorState = editorState; + this.editorValue = change.value; }; handleDrop = async (ev: SyntheticEvent) => { @@ -103,17 +104,16 @@ class MarkdownEditor extends Component { }; insertImageFile = async (file: window.File) => { - const state = this.editor.getState(); - let transform = state.transform(); - - transform = await insertImage( - transform, - file, - this.editor, - this.props.onImageUploadStart, - this.props.onImageUploadStop + this.editor.change( + async change => + await insertImage( + change, + file, + this.editor, + this.props.onImageUploadStart, + this.props.onImageUploadStop + ) ); - this.editor.onChange(transform.apply()); }; cancelEvent = (ev: SyntheticEvent) => { @@ -136,7 +136,7 @@ class MarkdownEditor extends Component { ev.preventDefault(); ev.stopPropagation(); - this.props.onSave({ redirect: false }); + this.props.onSave(true); } @keydown('esc') @@ -146,37 +146,33 @@ class MarkdownEditor extends Component { } // Handling of keyboard shortcuts within editor focus - onKeyDown = (ev: SyntheticKeyboardEvent, data: KeyData, state: State) => { + onKeyDown = (ev: SyntheticKeyboardEvent, data: KeyData, change: change) => { if (!data.isMeta) return; switch (data.key) { case 's': this.onSave(ev); - return state; + return change; case 'enter': this.onSaveAndExit(ev); - return state; + return change; case 'escape': this.onCancel(); - return state; + return change; default: } }; focusAtStart = () => { - const state = this.editor.getState(); - const transform = state.transform(); - transform.collapseToStartOf(state.document); - transform.focus(); - this.editorState = transform.apply(); + this.editor.change(change => + change.collapseToStartOf(change.value.document).focus() + ); }; focusAtEnd = () => { - const state = this.editor.getState(); - const transform = state.transform(); - transform.collapseToEndOf(state.document); - transform.focus(); - this.editorState = transform.apply(); + this.editor.change(change => + change.collapseToEndOf(change.value.document).focus() + ); }; render = () => { @@ -193,25 +189,27 @@ class MarkdownEditor extends Component { >
- {readOnly && } - {!readOnly && ( - - )} - {!readOnly && ( - - )} + {readOnly && this.editor && } + {!readOnly && + this.editor && ( + + )} + {!readOnly && + this.editor && ( + + )} (this.editor = ref)} placeholder="Start with a title…" bodyPlaceholder="…the rest is your canvas" - schema={this.schema} plugins={this.plugins} emoji={emoji} - state={this.editorState} + value={this.editorValue} + renderNode={this.renderNode} + renderMark={renderMark} onKeyDown={this.onKeyDown} onChange={this.onChange} onSave={onSave} diff --git a/app/components/Editor/components/BlockInsert.js b/app/components/Editor/components/BlockInsert.js index fe7ac38e..02673b0e 100644 --- a/app/components/Editor/components/BlockInsert.js +++ b/app/components/Editor/components/BlockInsert.js @@ -1,18 +1,16 @@ // @flow import React, { Component } from 'react'; import { Portal } from 'react-portal'; -import { findDOMNode, Node } from 'slate'; +import { Node } from 'slate'; +import { Editor, findDOMNode } from 'slate-react'; import { observable } from 'mobx'; import { observer } from 'mobx-react'; import styled from 'styled-components'; import { color } from 'shared/styles/constants'; import PlusIcon from 'components/Icon/PlusIcon'; -import type { State } from '../types'; type Props = { - state: State, - onChange: Function, - onInsertImage: File => Promise<*>, + editor: Editor, }; function findClosestRootNode(state, ev) { @@ -53,7 +51,7 @@ export default class BlockInsert extends Component { handleMouseMove = (ev: SyntheticMouseEvent) => { const windowWidth = window.innerWidth / 2.5; - const result = findClosestRootNode(this.props.state, ev); + const result = findClosestRootNode(this.props.editor.value, ev); const movementThreshold = 200; this.mouseMovementSinceClick += @@ -70,7 +68,7 @@ export default class BlockInsert extends Component { this.closestRootNode = result.node; // do not show block menu on title heading or editor - const firstNode = this.props.state.document.nodes.first(); + const firstNode = this.props.editor.value.document.nodes.first(); if (result.node === firstNode || result.node.type === 'block-toolbar') { this.left = -1000; } else { @@ -89,23 +87,22 @@ export default class BlockInsert extends Component { this.mouseMovementSinceClick = 0; this.active = false; - const { state } = this.props; + const { editor } = this.props; const type = { type: 'block-toolbar', isVoid: true }; - let transform = state.transform(); - // remove any existing toolbars in the document as a fail safe - state.document.nodes.forEach(node => { - if (node.type === 'block-toolbar') { - transform.removeNodeByKey(node.key); - } + editor.change(change => { + // remove any existing toolbars in the document as a fail safe + editor.value.document.nodes.forEach(node => { + if (node.type === 'block-toolbar') { + change.removeNodeByKey(node.key); + } + }); + + change + .collapseToStartOf(this.closestRootNode) + .collapseToEndOfPreviousBlock() + .insertBlock(type); }); - - transform - .collapseToStartOf(this.closestRootNode) - .collapseToEndOfPreviousBlock() - .insertBlock(type); - - this.props.onChange(transform.apply()); }; render() { diff --git a/app/components/Editor/components/Code.js b/app/components/Editor/components/Code.js index 99cef6ba..7c2118ee 100644 --- a/app/components/Editor/components/Code.js +++ b/app/components/Editor/components/Code.js @@ -1,11 +1,11 @@ // @flow import React from 'react'; import styled from 'styled-components'; +import type { props } from 'slate-prop-types'; import CopyButton from './CopyButton'; import { color } from 'shared/styles/constants'; -import type { Props } from '../types'; -export default function Code({ children, node, readOnly, attributes }: Props) { +export default function Code({ children, node, readOnly, attributes }: props) { const language = node.data.get('language') || 'javascript'; return ( diff --git a/app/components/Editor/components/Contents.js b/app/components/Editor/components/Contents.js index b92ef7ce..81dcfad0 100644 --- a/app/components/Editor/components/Contents.js +++ b/app/components/Editor/components/Contents.js @@ -2,14 +2,15 @@ import React, { Component } from 'react'; import { observable } from 'mobx'; import { observer } from 'mobx-react'; +import { Editor } from 'slate-react'; +import type { state, block } from 'slate-prop-types'; import { List } from 'immutable'; import { color } from 'shared/styles/constants'; import headingToSlug from '../headingToSlug'; -import type { State, Block } from '../types'; import styled from 'styled-components'; type Props = { - state: State, + editor: Editor, }; @observer @@ -53,10 +54,10 @@ class Contents extends Component { return elements; } - get headings(): List { - const { state } = this.props; + get headings(): List { + const { editor } = this.props; - return state.document.nodes.filter((node: Block) => { + return editor.value.document.nodes.filter((node: block) => { if (!node.text) return false; return node.type.match(/^heading/); }); @@ -74,7 +75,7 @@ class Contents extends Component { const active = this.activeHeading === slug; return ( - + {heading.text} diff --git a/app/components/Editor/components/Heading.js b/app/components/Editor/components/Heading.js index 9c29c6db..2a57279b 100644 --- a/app/components/Editor/components/Heading.js +++ b/app/components/Editor/components/Heading.js @@ -1,16 +1,17 @@ // @flow import React from 'react'; import { Document } from 'slate'; +import { Editor } from 'slate-react'; import styled from 'styled-components'; +import type { node } from 'slate-prop-types'; import headingToSlug from '../headingToSlug'; -import type { Node, Editor } from '../types'; import Placeholder from './Placeholder'; type Props = { children: React$Element<*>, placeholder?: boolean, - parent: Node, - node: Node, + parent: node, + node: node, editor: Editor, readOnly: boolean, component?: string, diff --git a/app/components/Editor/components/HorizontalRule.js b/app/components/Editor/components/HorizontalRule.js index 9eed79e0..7efcbe99 100644 --- a/app/components/Editor/components/HorizontalRule.js +++ b/app/components/Editor/components/HorizontalRule.js @@ -1,10 +1,10 @@ // @flow import React from 'react'; import styled from 'styled-components'; -import type { Props } from '../types'; +import type { props } from 'slate-prop-types'; import { color } from 'shared/styles/constants'; -function HorizontalRule(props: Props) { +function HorizontalRule(props: props) { const { state, node, attributes } = props; const active = state.isFocused && state.selection.hasEdgeIn(node); return ; diff --git a/app/components/Editor/components/Image.js b/app/components/Editor/components/Image.js index 3200a104..23ab022e 100644 --- a/app/components/Editor/components/Image.js +++ b/app/components/Editor/components/Image.js @@ -2,23 +2,23 @@ import React, { Component } from 'react'; import ImageZoom from 'react-medium-image-zoom'; import styled from 'styled-components'; -import type { Props } from '../types'; +import type { props } from 'slate-prop-types'; import { color } from 'shared/styles/constants'; class Image extends Component { - props: Props; + props: props; handleChange = (ev: SyntheticInputEvent) => { const alt = ev.target.value; const { editor, node } = this.props; const data = node.data.toObject(); - const state = editor - .getState() - .transform() - .setNodeByKey(node.key, { data: { ...data, alt } }) - .apply(); - editor.onChange(state); + editor.onChange( + editor + .getState() + .change() + .setNodeByKey(node.key, { data: { ...data, alt } }) + ); }; handleClick = (ev: SyntheticInputEvent) => { diff --git a/app/components/Editor/components/Link.js b/app/components/Editor/components/Link.js index 0642415e..0938dd53 100644 --- a/app/components/Editor/components/Link.js +++ b/app/components/Editor/components/Link.js @@ -1,7 +1,7 @@ // @flow import React from 'react'; import { Link as InternalLink } from 'react-router-dom'; -import type { Props } from '../types'; +import type { props } from 'slate-prop-types'; function getPathFromUrl(href: string) { if (href[0] === '/') return href; @@ -14,7 +14,7 @@ function getPathFromUrl(href: string) { } } -function isOutlineUrl(href: string) { +function isInternalUrl(href: string) { if (href[0] === '/') return true; try { @@ -26,11 +26,11 @@ function isOutlineUrl(href: string) { } } -export default function Link({ attributes, node, children, readOnly }: Props) { +export default function Link({ attributes, node, children, readOnly }: props) { const href = node.data.get('href'); const path = getPathFromUrl(href); - if (isOutlineUrl(href) && readOnly) { + if (isInternalUrl(href) && readOnly) { return ( {children} diff --git a/app/components/Editor/components/ListItem.js b/app/components/Editor/components/ListItem.js index 0c151765..51fea4c0 100644 --- a/app/components/Editor/components/ListItem.js +++ b/app/components/Editor/components/ListItem.js @@ -1,6 +1,6 @@ // @flow import React from 'react'; -import type { Props } from '../types'; +import type { props } from 'slate-prop-types'; import TodoItem from './TodoItem'; export default function ListItem({ @@ -8,7 +8,7 @@ export default function ListItem({ node, attributes, ...props -}: Props) { +}: props) { const checked = node.data.get('checked'); if (checked !== undefined) { diff --git a/app/components/Editor/components/Paragraph.js b/app/components/Editor/components/Paragraph.js index 5b4b9a48..07801e1f 100644 --- a/app/components/Editor/components/Paragraph.js +++ b/app/components/Editor/components/Paragraph.js @@ -1,7 +1,7 @@ // @flow import React from 'react'; import { Document } from 'slate'; -import type { Props } from '../types'; +import type { props } from 'slate-prop-types'; import Placeholder from './Placeholder'; export default function Link({ @@ -11,7 +11,7 @@ export default function Link({ parent, children, readOnly, -}: Props) { +}: props) { const parentIsDocument = parent instanceof Document; const firstParagraph = parent && parent.nodes.get(1) === node; const lastParagraph = parent && parent.nodes.last() === node; diff --git a/app/components/Editor/components/TodoItem.js b/app/components/Editor/components/TodoItem.js index 91e62cb3..bb7a9cf2 100644 --- a/app/components/Editor/components/TodoItem.js +++ b/app/components/Editor/components/TodoItem.js @@ -2,21 +2,20 @@ import React, { Component } from 'react'; import styled from 'styled-components'; import { color } from 'shared/styles/constants'; -import type { Props } from '../types'; +import type { props } from 'slate-prop-types'; export default class TodoItem extends Component { - props: Props & { checked: boolean }; + props: props & { checked: boolean }; handleChange = (ev: SyntheticInputEvent) => { const checked = ev.target.checked; const { editor, node } = this.props; - const state = editor + const change = editor .getState() - .transform() - .setNodeByKey(node.key, { data: { checked } }) - .apply(); + .change() + .setNodeByKey(node.key, { data: { checked } }); - editor.onChange(state); + editor.onChange(change); }; render() { diff --git a/app/components/Editor/components/Toolbar/BlockToolbar.js b/app/components/Editor/components/Toolbar/BlockToolbar.js index 165d5cca..61551561 100644 --- a/app/components/Editor/components/Toolbar/BlockToolbar.js +++ b/app/components/Editor/components/Toolbar/BlockToolbar.js @@ -13,12 +13,12 @@ import HorizontalRuleIcon from 'components/Icon/HorizontalRuleIcon'; import TodoListIcon from 'components/Icon/TodoListIcon'; import Flex from 'shared/components/Flex'; import ToolbarButton from './components/ToolbarButton'; -import type { Props as BaseProps } from '../../types'; +import type { props } from 'slate-prop-types'; import { color } from 'shared/styles/constants'; import { fadeIn } from 'shared/styles/animations'; import { splitAndInsertBlock } from '../../transforms'; -type Props = BaseProps & { +type Props = props & { onInsertImage: Function, onChange: Function, }; @@ -34,16 +34,15 @@ class BlockToolbar extends Component { file: HTMLInputElement; componentWillReceiveProps(nextProps: Props) { - const wasActive = this.props.state.selection.hasEdgeIn(this.props.node); - const isActive = nextProps.state.selection.hasEdgeIn(nextProps.node); + const { editor } = this.props; + const wasActive = editor.value.selection.hasEdgeIn(this.props.node); + const isActive = nextProps.editor.value.selection.hasEdgeIn(nextProps.node); const becameInactive = !isActive && wasActive; if (becameInactive) { - const state = nextProps.state - .transform() - .removeNodeByKey(nextProps.node.key) - .apply(); - this.props.onChange(state); + nextProps.editor.change(change => + change.removeNodeByKey(nextProps.node.key) + ); } } @@ -52,24 +51,25 @@ class BlockToolbar extends Component { ev.preventDefault(); ev.stopPropagation(); - const state = this.props.state - .transform() - .removeNodeByKey(this.props.node.key) - .apply(); - this.props.onChange(state); + this.props.editor.change(change => + change.removeNodeByKey(this.props.node.key) + ); } insertBlock = (options: Options) => { - const { state } = this.props; - let transform = splitAndInsertBlock(state.transform(), state, options); + const { editor } = this.props; - state.document.nodes.forEach(node => { - if (node.type === 'block-toolbar') { - transform.removeNodeByKey(node.key); - } + editor.change(change => { + splitAndInsertBlock(change, options); + + change.value.document.nodes.forEach(node => { + if (node.type === 'block-toolbar') { + change.removeNodeByKey(node.key); + } + }); + + change.focus(); }); - - this.props.onChange(transform.focus().apply()); }; handleClickBlock = (ev: SyntheticEvent, type: string) => { @@ -126,8 +126,9 @@ class BlockToolbar extends Component { }; render() { - const { state, attributes, node } = this.props; - const active = state.isFocused && state.selection.hasEdgeIn(node); + const { editor, attributes, node } = this.props; + const active = + editor.value.isFocused && editor.value.selection.hasEdgeIn(node); return ( diff --git a/app/components/Editor/components/Toolbar/Toolbar.js b/app/components/Editor/components/Toolbar/Toolbar.js index 696e3ed4..1efb8552 100644 --- a/app/components/Editor/components/Toolbar/Toolbar.js +++ b/app/components/Editor/components/Toolbar/Toolbar.js @@ -3,9 +3,10 @@ import React, { Component } from 'react'; import { observable } from 'mobx'; import { observer } from 'mobx-react'; import { Portal } from 'react-portal'; +import { Editor } from 'slate-react'; +import type { value } from 'slate-prop-types'; import styled from 'styled-components'; import _ from 'lodash'; -import type { State } from '../../types'; import FormattingToolbar from './components/FormattingToolbar'; import LinkToolbar from './components/LinkToolbar'; @@ -18,8 +19,8 @@ export default class Toolbar extends Component { @observable left: string = ''; props: { - state: State, - onChange: (state: State) => void, + editor: Editor, + value: value, }; menu: HTMLElement; @@ -41,11 +42,11 @@ export default class Toolbar extends Component { }; get linkInSelection(): any { - const { state } = this.props; + const { value } = this.props; try { - const selectedLinks = state.startBlock - .getInlinesAtRange(state.selection) + const selectedLinks = value.startBlock + .getInlinesAtRange(value.selection) .filter(node => node.type === 'link'); if (selectedLinks.size) { return selectedLinks.first(); @@ -56,10 +57,10 @@ export default class Toolbar extends Component { } update = () => { - const { state } = this.props; + const { value } = this.props; const link = this.linkInSelection; - if (state.isBlurred || (state.isCollapsed && !link)) { + if (value.isBlurred || (value.isCollapsed && !link)) { if (this.active && !this.focused) { this.active = false; this.link = undefined; @@ -70,11 +71,11 @@ export default class Toolbar extends Component { } // don't display toolbar for document title - const firstNode = state.document.nodes.first(); - if (firstNode === state.startBlock) return; + const firstNode = value.document.nodes.first(); + if (firstNode === value.startBlock) return; // don't display toolbar for code blocks - if (state.startBlock.type === 'code') return; + if (value.startBlock.type === 'code') return; this.active = true; this.focused = !!link; diff --git a/app/components/Editor/components/Toolbar/components/FormattingToolbar.js b/app/components/Editor/components/Toolbar/components/FormattingToolbar.js index df56d703..5dd7e6c3 100644 --- a/app/components/Editor/components/Toolbar/components/FormattingToolbar.js +++ b/app/components/Editor/components/Toolbar/components/FormattingToolbar.js @@ -1,7 +1,7 @@ // @flow import React, { Component } from 'react'; import styled from 'styled-components'; -import type { State } from '../../../types'; +import { Editor } from 'slate-react'; import ToolbarButton from './ToolbarButton'; import BoldIcon from 'components/Icon/BoldIcon'; import CodeIcon from 'components/Icon/CodeIcon'; @@ -13,8 +13,7 @@ import StrikethroughIcon from 'components/Icon/StrikethroughIcon'; class FormattingToolbar extends Component { props: { - state: State, - onChange: Function, + editor: Editor, onCreateLink: Function, }; @@ -25,11 +24,11 @@ class FormattingToolbar extends Component { * @return {Boolean} */ hasMark = (type: string) => { - return this.props.state.marks.some(mark => mark.type === type); + return this.props.editor.value.marks.some(mark => mark.type === type); }; isBlock = (type: string) => { - return this.props.state.startBlock.type === type; + return this.props.editor.value.startBlock.type === type; }; /** @@ -40,37 +39,23 @@ class FormattingToolbar extends Component { */ onClickMark = (ev: SyntheticEvent, type: string) => { ev.preventDefault(); - let { state } = this.props; - - state = state - .transform() - .toggleMark(type) - .apply(); - this.props.onChange(state); + this.props.editor.change(change => change.toggleMark(type)); }; onClickBlock = (ev: SyntheticEvent, type: string) => { ev.preventDefault(); - let { state } = this.props; - - state = state - .transform() - .setBlock(type) - .apply(); - this.props.onChange(state); + this.props.editor.change(change => change.setBlock(type)); }; onCreateLink = (ev: SyntheticEvent) => { ev.preventDefault(); ev.stopPropagation(); - let { state } = this.props; + const data = { href: '' }; - state = state - .transform() - .wrapInline({ type: 'link', data }) - .apply(); - this.props.onChange(state); - this.props.onCreateLink(); + this.props.editor.change(change => { + change.wrapInline({ type: 'link', data }); + this.props.onCreateLink(); + }); }; renderMarkButton = (type: string, IconClass: Function) => { diff --git a/app/components/Editor/components/Toolbar/components/LinkToolbar.js b/app/components/Editor/components/Toolbar/components/LinkToolbar.js index 4bdd21c7..f0fd65a9 100644 --- a/app/components/Editor/components/Toolbar/components/LinkToolbar.js +++ b/app/components/Editor/components/Toolbar/components/LinkToolbar.js @@ -4,11 +4,12 @@ import ReactDOM from 'react-dom'; import { observable, action } from 'mobx'; import { observer, inject } from 'mobx-react'; import { withRouter } from 'react-router-dom'; +import { Editor } from 'slate-react'; import styled from 'styled-components'; import ArrowKeyNavigation from 'boundless-arrow-key-navigation'; +import type { change } from 'slate-prop-types'; import ToolbarButton from './ToolbarButton'; import DocumentResult from './DocumentResult'; -import type { State } from '../../../types'; import DocumentsStore from 'stores/DocumentsStore'; import keydown from 'react-keydown'; import CloseIcon from 'components/Icon/CloseIcon'; @@ -23,11 +24,11 @@ class LinkToolbar extends Component { firstDocument: HTMLElement; props: { - state: State, + editor: Editor, link: Object, documents: DocumentsStore, onBlur: () => void, - onChange: State => void, + onChange: change => *, }; @observable isEditing: boolean = false; @@ -112,17 +113,14 @@ class LinkToolbar extends Component { save = (href: string) => { href = href.trim(); - const { state } = this.props; - const transform = state.transform(); - - if (href) { - transform.setInline({ type: 'link', data: { href } }); - } else { - transform.unwrapInline('link'); - } - - this.props.onChange(transform.apply()); - this.props.onBlur(); + this.props.editor.change(change => { + if (href) { + change.setInline({ type: 'link', data: { href } }); + } else { + change.unwrapInline('link'); + } + this.props.onBlur(); + }); }; setFirstDocumentRef = ref => { diff --git a/app/components/Editor/headingToSlug.js b/app/components/Editor/headingToSlug.js index 04b9d627..cf46ab2b 100644 --- a/app/components/Editor/headingToSlug.js +++ b/app/components/Editor/headingToSlug.js @@ -1,9 +1,9 @@ // @flow import { escape } from 'lodash'; -import type { Node } from './types'; +import type { node } from 'slate-prop-types'; import slug from 'slug'; -export default function headingToSlug(node: Node) { +export default function headingToSlug(node: node) { const level = node.type.replace('heading', 'h'); return escape(`${level}-${slug(node.text)}-${node.key}`); } diff --git a/app/components/Editor/insertImage.js b/app/components/Editor/insertImage.js index d3e4c6bd..01480cc2 100644 --- a/app/components/Editor/insertImage.js +++ b/app/components/Editor/insertImage.js @@ -1,10 +1,11 @@ // @flow import uuid from 'uuid'; import uploadFile from 'utils/uploadFile'; -import type { Editor, Transform } from './types'; +import { Editor } from 'slate-react'; +import type { change } from 'slate-prop-types'; export default async function insertImageFile( - transform: Transform, + change: change, file: window.File, editor: Editor, onImageUploadStart: () => void, @@ -21,7 +22,7 @@ export default async function insertImageFile( const src = reader.result; // insert into document as uploading placeholder - const state = transform + const state = change .insertBlock({ type: 'image', isVoid: true, @@ -36,11 +37,11 @@ export default async function insertImageFile( const asset = await uploadFile(file); const src = asset.url; - // we dont use the original transform provided to the callback here + // we dont use the original change provided to the callback here // as the state may have changed significantly in the time it took to // upload the file. const state = editor.getState(); - const finalTransform = state.transform(); + const finalTransform = state.change(); const placeholder = state.document.findDescendant( node => node.data && node.data.get('id') === id ); diff --git a/app/components/Editor/marks.js b/app/components/Editor/marks.js new file mode 100644 index 00000000..58d25c63 --- /dev/null +++ b/app/components/Editor/marks.js @@ -0,0 +1,22 @@ +// @flow +import React from 'react'; +import InlineCode from './components/InlineCode'; +import type { props } from 'slate-prop-types'; + +export default function renderMark(props: props) { + switch (props.mark.type) { + case 'bold': + return {props.children}; + case 'code': + return {props.children}; + case 'italic': + return {props.children}; + case 'underlined': + return {props.children}; + case 'deleted': + return {props.children}; + case 'added': + return {props.children}; + default: + } +} diff --git a/app/components/Editor/nodes.js b/app/components/Editor/nodes.js new file mode 100644 index 00000000..b20e4de4 --- /dev/null +++ b/app/components/Editor/nodes.js @@ -0,0 +1,75 @@ +// @flow +import React from 'react'; +import Code from './components/Code'; +import BlockToolbar from './components/Toolbar/BlockToolbar'; +import HorizontalRule from './components/HorizontalRule'; +import Image from './components/Image'; +import Link from './components/Link'; +import ListItem from './components/ListItem'; +import TodoList from './components/TodoList'; +import { + Heading1, + Heading2, + Heading3, + Heading4, + Heading5, + Heading6, +} from './components/Heading'; +import Paragraph from './components/Paragraph'; +import type { props } from 'slate-prop-types'; + +type Options = { + onInsertImage: *, +}; + +export default function createRenderNode({ onChange, onInsertImage }: Options) { + return function renderNode(props: props) { + const { attributes } = props; + + switch (props.node.type) { + case 'paragraph': + return ; + case 'block-toolbar': + return ; + case 'block-quote': + return
{props.children}
; + case 'bulleted-list': + return
    {props.children}
; + case 'ordered-list': + return
    {props.children}
; + case 'todo-list': + return {props.children}; + case 'table': + return {props.children}
; + case 'table-row': + return {props.children}; + case 'table-head': + return {props.children}; + case 'table-cell': + return {props.children}; + case 'list-item': + return ; + case 'horizontal-rule': + return ; + case 'code': + return ; + case 'image': + return ; + case 'link': + return ; + case 'heading1': + return ; + case 'heading2': + return ; + case 'heading3': + return ; + case 'heading4': + return ; + case 'heading5': + return ; + case 'heading6': + return ; + default: + } + }; +} diff --git a/app/components/Editor/plugins.js b/app/components/Editor/plugins.js index 30688ea1..b3130aac 100644 --- a/app/components/Editor/plugins.js +++ b/app/components/Editor/plugins.js @@ -1,5 +1,5 @@ // @flow -import DropOrPasteImages from '@tommoor/slate-drop-or-paste-images'; +// import DropOrPasteImages from '@tommoor/slate-drop-or-paste-images'; import PasteLinkify from 'slate-paste-linkify'; import CollapseOnEscape from 'slate-collapse-on-escape'; import TrailingBlock from 'slate-trailing-block'; @@ -8,7 +8,7 @@ import Prism from 'slate-prism'; import EditList from './plugins/EditList'; import KeyboardShortcuts from './plugins/KeyboardShortcuts'; import MarkdownShortcuts from './plugins/MarkdownShortcuts'; -import insertImage from './insertImage'; +// import insertImage from './insertImage'; const onlyInCode = node => node.type === 'code'; @@ -23,18 +23,18 @@ const createPlugins = ({ onImageUploadStart, onImageUploadStop }: Options) => { type: 'link', collapseTo: 'end', }), - DropOrPasteImages({ - extensions: ['png', 'jpg', 'gif'], - applyTransform: (transform, file, editor) => { - return insertImage( - transform, - file, - editor, - onImageUploadStart, - onImageUploadStop - ); - }, - }), + // DropOrPasteImages({ + // extensions: ['png', 'jpg', 'gif'], + // applyTransform: (transform, file, editor) => { + // return insertImage( + // transform, + // file, + // editor, + // onImageUploadStart, + // onImageUploadStop + // ); + // }, + // }), EditList, EditCode({ onlyIn: onlyInCode, diff --git a/app/components/Editor/plugins/KeyboardShortcuts.js b/app/components/Editor/plugins/KeyboardShortcuts.js index bf1a2fb0..e3b8c06c 100644 --- a/app/components/Editor/plugins/KeyboardShortcuts.js +++ b/app/components/Editor/plugins/KeyboardShortcuts.js @@ -1,4 +1,5 @@ // @flow +import type { change } from 'slate-prop-types'; export default function KeyboardShortcuts() { return { @@ -10,38 +11,32 @@ export default function KeyboardShortcuts() { * @param {State} state * @return {State or Null} state */ - onKeyDown(ev: SyntheticEvent, data: Object, state: Object) { + onKeyDown(ev: SyntheticEvent, data: Object, change: change) { if (!data.isMeta) return null; switch (data.key) { case 'b': - return this.toggleMark(state, 'bold'); + return this.toggleMark(change, 'bold'); case 'i': - return this.toggleMark(state, 'italic'); + return this.toggleMark(change, 'italic'); case 'u': - return this.toggleMark(state, 'underlined'); + return this.toggleMark(change, 'underlined'); case 'd': - return this.toggleMark(state, 'deleted'); + return this.toggleMark(change, 'deleted'); case 'k': - return state - .transform() - .wrapInline({ type: 'link', data: { href: '' } }) - .apply(); + return change.wrapInline({ type: 'link', data: { href: '' } }); default: return null; } }, - toggleMark(state: Object, type: string) { + toggleMark(change: change, type: string) { + const { state } = change; // don't allow formatting of document title const firstNode = state.document.nodes.first(); if (firstNode === state.startBlock) return; - state = state - .transform() - .toggleMark(type) - .apply(); - return state; + return state.change().toggleMark(type); }, }; } diff --git a/app/components/Editor/plugins/MarkdownShortcuts.js b/app/components/Editor/plugins/MarkdownShortcuts.js index 6132a8c6..8800f4f5 100644 --- a/app/components/Editor/plugins/MarkdownShortcuts.js +++ b/app/components/Editor/plugins/MarkdownShortcuts.js @@ -1,4 +1,11 @@ // @flow +import type { change } from 'slate-prop-types'; + +type KeyData = { + isMeta: boolean, + key: string, +}; + const inlineShortcuts = [ { mark: 'bold', shortcut: '**' }, { mark: 'bold', shortcut: '__' }, @@ -14,20 +21,20 @@ export default function MarkdownShortcuts() { /** * On key down, check for our specific key shortcuts. */ - onKeyDown(ev: SyntheticEvent, data: Object, state: Object) { + onKeyDown(ev: SyntheticEvent, data: KeyData, change: change) { switch (data.key) { case '-': - return this.onDash(ev, state); + return this.onDash(ev, change); case '`': - return this.onBacktick(ev, state); + return this.onBacktick(ev, change); case 'tab': - return this.onTab(ev, state); + return this.onTab(ev, change); case 'space': - return this.onSpace(ev, state); + return this.onSpace(ev, change); case 'backspace': - return this.onBackspace(ev, state); + return this.onBackspace(ev, change); case 'enter': - return this.onEnter(ev, state); + return this.onEnter(ev, change); default: return null; } @@ -37,7 +44,8 @@ export default function MarkdownShortcuts() { * On space, if it was after an auto-markdown shortcut, convert the current * node into the shortcut's corresponding type. */ - onSpace(ev: SyntheticEvent, state: Object) { + onSpace(ev: SyntheticEvent, change: change) { + const { state } = change; if (state.isExpanded) return; const { startBlock, startOffset } = state; const chars = startBlock.text.slice(0, startOffset).trim(); @@ -50,25 +58,19 @@ export default function MarkdownShortcuts() { let checked; if (chars === '[x]') checked = true; if (chars === '[ ]') checked = false; - const transform = state - .transform() - .setBlock({ type, data: { checked } }); + const change = state.change().setBlock({ type, data: { checked } }); if (type === 'list-item') { if (checked !== undefined) { - transform.wrapBlock('todo-list'); + change.wrapBlock('todo-list'); } else if (chars === '1.') { - transform.wrapBlock('ordered-list'); + change.wrapBlock('ordered-list'); } else { - transform.wrapBlock('bulleted-list'); + change.wrapBlock('bulleted-list'); } } - state = transform - .extendToStartOf(startBlock) - .delete() - .apply(); - return state; + return change.extendToStartOf(startBlock).delete(); } for (const key of inlineShortcuts) { @@ -97,35 +99,32 @@ export default function MarkdownShortcuts() { // if we have multiple tags then mark the text between as inline code if (inlineTags.length > 1) { - const transform = state.transform(); + const change = state.change(); const firstText = startBlock.getFirstText(); const firstCodeTagIndex = inlineTags[0]; const lastCodeTagIndex = inlineTags[inlineTags.length - 1]; - transform.removeTextByKey( + change.removeTextByKey( firstText.key, lastCodeTagIndex, shortcut.length ); - transform.removeTextByKey( + change.removeTextByKey( firstText.key, firstCodeTagIndex, shortcut.length ); - transform.moveOffsetsTo( + change.moveOffsetsTo( firstCodeTagIndex, lastCodeTagIndex - shortcut.length ); - transform.addMark(mark); - state = transform - .collapseToEnd() - .removeMark(mark) - .apply(); - return state; + change.addMark(mark); + return change.collapseToEnd().removeMark(mark); } } }, - onDash(ev: SyntheticEvent, state: Object) { + onDash(ev: SyntheticEvent, change: change) { + const { state } = change; if (state.isExpanded) return; const { startBlock, startOffset } = state; const chars = startBlock.text.slice(0, startOffset).replace(/\s*/g, ''); @@ -133,7 +132,7 @@ export default function MarkdownShortcuts() { if (chars === '--') { ev.preventDefault(); return state - .transform() + .change() .extendToStartOf(startBlock) .delete() .setBlock({ @@ -141,12 +140,12 @@ export default function MarkdownShortcuts() { isVoid: true, }) .collapseToStartOfNextBlock() - .insertBlock('paragraph') - .apply(); + .insertBlock('paragraph'); } }, - onBacktick(ev: SyntheticEvent, state: Object) { + onBacktick(ev: SyntheticEvent, change: change) { + const { state } = change; if (state.isExpanded) return; const { startBlock, startOffset } = state; const chars = startBlock.text.slice(0, startOffset).replace(/\s*/g, ''); @@ -154,18 +153,18 @@ export default function MarkdownShortcuts() { if (chars === '``') { ev.preventDefault(); return state - .transform() + .change() .extendToStartOf(startBlock) .delete() .setBlock({ type: 'code', - }) - .apply(); + }); } }, - onBackspace(ev: SyntheticEvent, state: Object) { - if (state.isExpanded) return; + onBackspace(ev: SyntheticEvent, change: change) { + const { state } = change; + if (change.isExpanded) return; const { startBlock, selection, startOffset } = state; // If at the start of a non-paragraph, convert it back into a paragraph @@ -173,13 +172,11 @@ export default function MarkdownShortcuts() { if (startBlock.type === 'paragraph') return; ev.preventDefault(); - const transform = state.transform().setBlock('paragraph'); + const change = state.change().setBlock('paragraph'); if (startBlock.type === 'list-item') - transform.unwrapBlock('bulleted-list'); - - state = transform.apply(); - return state; + change.unwrapBlock('bulleted-list'); + return change; } // If at the end of a code mark hitting backspace should remove the mark @@ -198,15 +195,14 @@ export default function MarkdownShortcuts() { .reverse() .takeUntil((v, k) => !v.marks.some(mark => mark.type === 'code')); - const transform = state.transform(); - transform.removeMarkByKey( - textNode.key, - state.startOffset - charsInCodeBlock.size, - state.startOffset, - 'code' - ); - state = transform.apply(); - return state; + return state + .change() + .removeMarkByKey( + textNode.key, + change.startOffset - charsInCodeBlock.size, + change.startOffset, + 'code' + ); } } }, @@ -215,14 +211,15 @@ export default function MarkdownShortcuts() { * On tab, if at the end of the heading jump to the main body content * as if it is another input field (act the same as enter). */ - onTab(ev: SyntheticEvent, state: Object) { + onTab(ev: SyntheticEvent, change: change) { + const { state } = change; + if (state.startBlock.type === 'heading1') { ev.preventDefault(); return state - .transform() + .change() .splitBlock() - .setBlock('paragraph') - .apply(); + .setBlock('paragraph'); } }, @@ -230,11 +227,12 @@ export default function MarkdownShortcuts() { * On return, if at the end of a node type that should not be extended, * create a new paragraph below it. */ - onEnter(ev: SyntheticEvent, state: Object) { + onEnter(ev: SyntheticEvent, change: change) { + const { state } = change; if (state.isExpanded) return; const { startBlock, startOffset, endOffset } = state; if (startOffset === 0 && startBlock.length === 0) - return this.onBackspace(ev, state); + return this.onBackspace(ev, change); if (endOffset !== startBlock.length) return; // Hitting enter while an image is selected should jump caret below and @@ -242,10 +240,9 @@ export default function MarkdownShortcuts() { if (startBlock.type === 'image') { ev.preventDefault(); return state - .transform() + .change() .collapseToEnd() - .insertBlock('paragraph') - .apply(); + .insertBlock('paragraph'); } // Hitting enter in a heading or blockquote will split the node at that @@ -264,10 +261,9 @@ export default function MarkdownShortcuts() { ev.preventDefault(); return state - .transform() + .change() .splitBlock() - .setBlock('paragraph') - .apply(); + .setBlock('paragraph'); }, /** diff --git a/app/components/Editor/schema.js b/app/components/Editor/schema.js index d4ed674b..1b59683a 100644 --- a/app/components/Editor/schema.js +++ b/app/components/Editor/schema.js @@ -1,133 +1,133 @@ -// @flow -import React from 'react'; -import Code from './components/Code'; -import HorizontalRule from './components/HorizontalRule'; -import InlineCode from './components/InlineCode'; -import Image from './components/Image'; -import Link from './components/Link'; -import ListItem from './components/ListItem'; -import TodoList from './components/TodoList'; -import { - Heading1, - Heading2, - Heading3, - Heading4, - Heading5, - Heading6, -} from './components/Heading'; -import Paragraph from './components/Paragraph'; -import BlockToolbar from './components/Toolbar/BlockToolbar'; -import type { Props, Node, Transform } from './types'; - -type Options = { - onInsertImage: Function, - onChange: Function, -}; - -const createSchema = ({ onInsertImage, onChange }: Options) => { - return { - marks: { - bold: (props: Props) => {props.children}, - code: (props: Props) => {props.children}, - italic: (props: Props) => {props.children}, - underlined: (props: Props) => {props.children}, - deleted: (props: Props) => {props.children}, - added: (props: Props) => {props.children}, - }, - - nodes: { - 'block-toolbar': (props: Props) => ( - - ), - paragraph: (props: Props) => , - 'block-quote': (props: Props) => ( -
{props.children}
- ), - 'horizontal-rule': HorizontalRule, - 'bulleted-list': (props: Props) => ( -
    {props.children}
- ), - 'ordered-list': (props: Props) => ( -
    {props.children}
- ), - 'todo-list': (props: Props) => ( - {props.children} - ), - table: (props: Props) => ( - {props.children}
- ), - 'table-row': (props: Props) => ( - {props.children} - ), - 'table-head': (props: Props) => ( - {props.children} - ), - 'table-cell': (props: Props) => ( - {props.children} - ), - code: Code, - image: Image, - link: Link, - 'list-item': ListItem, - heading1: (props: Props) => , - heading2: (props: Props) => , - heading3: (props: Props) => , - heading4: (props: Props) => , - heading5: (props: Props) => , - heading6: (props: Props) => , - }, - - rules: [ - // ensure first node is always a heading - { - match: (node: Node) => { - return node.kind === 'document'; - }, - validate: (document: Node) => { - const firstNode = document.nodes.first(); - return firstNode && firstNode.type === 'heading1' ? null : firstNode; - }, - normalize: (transform: Transform, document: Node, firstNode: Node) => { - transform.setBlock({ type: 'heading1' }); - }, - }, - - // automatically removes any marks in first heading - { - match: (node: Node) => { - return node.kind === 'heading1'; - }, - validate: (heading: Node) => { - const hasMarks = heading.getMarks().isEmpty(); - const hasInlines = heading.getInlines().isEmpty(); - - return !(hasMarks && hasInlines); - }, - normalize: (transform: Transform, heading: Node) => { - transform.unwrapInlineByKey(heading.key); - - heading.getMarks().forEach(mark => { - heading.nodes.forEach(textNode => { - if (textNode.kind === 'text') { - transform.removeMarkByKey( - textNode.key, - 0, - textNode.text.length, - mark - ); - } - }); - }); - - return transform; - }, - }, - ], - }; -}; - -export default createSchema; +// // @flow +// import React from 'react'; +// import Code from './components/Code'; +// import HorizontalRule from './components/HorizontalRule'; +// import InlineCode from './components/InlineCode'; +// import Image from './components/Image'; +// import Link from './components/Link'; +// import ListItem from './components/ListItem'; +// import TodoList from './components/TodoList'; +// import { +// Heading1, +// Heading2, +// Heading3, +// Heading4, +// Heading5, +// Heading6, +// } from './components/Heading'; +// import Paragraph from './components/Paragraph'; +// import BlockToolbar from './components/Toolbar/BlockToolbar'; +// import type { Props, Node, Transform } from './types'; +// +// type Options = { +// onInsertImage: Function, +// onChange: Function, +// }; +// +// const createSchema = ({ onInsertImage, onChange }: Options) => { +// return { +// marks: { +// bold: (props: Props) => {props.children}, +// code: (props: Props) => {props.children}, +// italic: (props: Props) => {props.children}, +// underlined: (props: Props) => {props.children}, +// deleted: (props: Props) => {props.children}, +// added: (props: Props) => {props.children}, +// }, +// +// nodes: { +// 'block-toolbar': (props: Props) => ( +// +// ), +// paragraph: (props: Props) => , +// 'block-quote': (props: Props) => ( +//
{props.children}
+// ), +// 'horizontal-rule': HorizontalRule, +// 'bulleted-list': (props: Props) => ( +//
    {props.children}
+// ), +// 'ordered-list': (props: Props) => ( +//
    {props.children}
+// ), +// 'todo-list': (props: Props) => ( +// {props.children} +// ), +// table: (props: Props) => ( +// {props.children}
+// ), +// 'table-row': (props: Props) => ( +// {props.children} +// ), +// 'table-head': (props: Props) => ( +// {props.children} +// ), +// 'table-cell': (props: Props) => ( +// {props.children} +// ), +// code: Code, +// image: Image, +// link: Link, +// 'list-item': ListItem, +// heading1: (props: Props) => , +// heading2: (props: Props) => , +// heading3: (props: Props) => , +// heading4: (props: Props) => , +// heading5: (props: Props) => , +// heading6: (props: Props) => , +// }, +// +// rules: [ +// // ensure first node is always a heading +// { +// match: (node: Node) => { +// return node.kind === 'document'; +// }, +// validate: (document: Node) => { +// const firstNode = document.nodes.first(); +// return firstNode && firstNode.type === 'heading1' ? null : firstNode; +// }, +// normalize: (transform: Transform, document: Node, firstNode: Node) => { +// transform.setBlock({ type: 'heading1' }); +// }, +// }, +// +// // automatically removes any marks in first heading +// { +// match: (node: Node) => { +// return node.kind === 'heading1'; +// }, +// validate: (heading: Node) => { +// const hasMarks = heading.getMarks().isEmpty(); +// const hasInlines = heading.getInlines().isEmpty(); +// +// return !(hasMarks && hasInlines); +// }, +// normalize: (transform: Transform, heading: Node) => { +// transform.unwrapInlineByKey(heading.key); +// +// heading.getMarks().forEach(mark => { +// heading.nodes.forEach(textNode => { +// if (textNode.kind === 'text') { +// transform.removeMarkByKey( +// textNode.key, +// 0, +// textNode.text.length, +// mark +// ); +// } +// }); +// }); +// +// return transform; +// }, +// }, +// ], +// }; +// }; +// +// export default createSchema; diff --git a/app/components/Editor/transforms.js b/app/components/Editor/transforms.js index d404c570..e5c30184 100644 --- a/app/components/Editor/transforms.js +++ b/app/components/Editor/transforms.js @@ -1,6 +1,6 @@ // @flow +import type { change } from 'slate-prop-types'; import EditList from './plugins/EditList'; -import type { State, Transform } from './types'; const { transforms } = EditList; @@ -10,28 +10,25 @@ type Options = { append?: string | Object, }; -export function splitAndInsertBlock( - transform: Transform, - state: State, - options: Options -) { +export function splitAndInsertBlock(change: change, options: Options) { const { type, wrapper, append } = options; - const { document } = state; - const parent = document.getParent(state.startBlock.key); + const { value } = change; + const { document } = value; + const parent = document.getParent(value.startBlock.key); // lists get some special treatment if (parent && parent.type === 'list-item') { - transform = transforms.unwrapList( + change = transforms.unwrapList( transforms - .splitListItem(transform.collapseToStart()) + .splitListItem(change.collapseToStart()) .collapseToEndOfPreviousBlock() ); } - transform = transform.insertBlock(type); + change = change.insertBlock(type); - if (wrapper) transform = transform.wrapBlock(wrapper); - if (append) transform = transform.insertBlock(append); + if (wrapper) change = change.wrapBlock(wrapper); + if (append) change = change.insertBlock(append); - return transform; + return change; } diff --git a/app/components/Editor/types.js b/app/components/Editor/types.js deleted file mode 100644 index 51562825..00000000 --- a/app/components/Editor/types.js +++ /dev/null @@ -1,118 +0,0 @@ -// @flow -import { List, Set, Map } from 'immutable'; -import { Selection } from 'slate'; - -export type NodeTransform = { - addMarkByKey: Function, - insertNodeByKey: Function, - insertTextByKey: Function, - moveNodeByKey: Function, - removeMarkByKey: Function, - removeNodeByKey: Function, - removeTextByKey: Function, - setMarkByKey: Function, - setNodeByKey: Function, - splitNodeByKey: Function, - unwrapInlineByKey: Function, - unwrapBlockByKey: Function, - unwrapNodeByKey: Function, - wrapBlockByKey: Function, - wrapInlineByKey: Function, -}; - -export type StateTransform = { - deleteBackward: Function, - deleteForward: Function, - delete: Function, - insertBlock: Function, - insertFragment: Function, - insertInline: Function, - insertText: Function, - addMark: Function, - setBlock: Function, - setInline: Function, - splitBlock: Function, - splitInline: Function, - removeMark: Function, - toggleMark: Function, - unwrapBlock: Function, - unwrapInline: Function, - wrapBlock: Function, - wrapInline: Function, - wrapText: Function, -}; - -export type SelectionTransform = { - collapseToStart: Function, - collapseToEnd: Function, -}; - -export type Transform = NodeTransform & StateTransform & SelectionTransform; - -export type Editor = { - props: Object, - className: string, - onChange: Function, - onDocumentChange: Function, - onSelectionChange: Function, - plugins: Array, - readOnly: boolean, - state: Object, - style: Object, - placeholder?: string, - placeholderClassName?: string, - placeholderStyle?: string, - blur: Function, - focus: Function, - getSchema: Function, - getState: Function, -}; - -export type Node = { - key: string, - kind: string, - type: string, - length: number, - text: string, - data: Map, - nodes: List, - getMarks: Function, - getBlocks: Function, - getParent: Function, - getInlines: Function, - getInlinesAtRange: Function, - setBlock: Function, -}; - -export type Block = Node & { - type: string, -}; - -export type Document = Node; - -export type State = { - document: Document, - selection: Selection, - startBlock: Block, - endBlock: Block, - startText: Node, - endText: Node, - marks: Set<*>, - blocks: List, - fragment: Document, - lines: List, - tests: List, - startBlock: Block, - transform: Function, - isBlurred: Function, -}; - -export type Props = { - node: Node, - parent?: Node, - attributes?: Object, - state: State, - editor: Editor, - readOnly?: boolean, - children?: React$Element, -}; diff --git a/package.json b/package.json index d80f7a16..9d0cfb21 100644 --- a/package.json +++ b/package.json @@ -105,6 +105,7 @@ "history": "3.0.0", "html-webpack-plugin": "2.17.0", "http-errors": "1.4.0", + "immutable": "^3.8.2", "imports-loader": "0.6.5", "invariant": "^2.2.2", "isomorphic-fetch": "2.2.1", @@ -160,14 +161,17 @@ "sequelize": "^4.3.1", "sequelize-cli": "^2.7.0", "sequelize-encrypted": "0.1.0", - "slate": "^0.21.4", - "slate-collapse-on-escape": "^0.2.1", - "slate-edit-code": "^0.10.2", - "slate-edit-list": "^0.7.0", - "slate-md-serializer": "0.5.6", - "slate-paste-linkify": "^0.2.1", - "slate-prism": "^0.2.2", - "slate-trailing-block": "^0.2.4", + "slate": "^0.29.0", + "slate-collapse-on-escape": "^0.6.0", + "slate-edit-code": "^0.13.2", + "slate-edit-list": "^0.10.1", + "slate-md-serializer": "1.0.1", + "slate-paste-linkify": "^0.5.0", + "slate-plain-serializer": "^0.4.12", + "slate-prism": "^0.4.0", + "slate-prop-types": "^0.4.12", + "slate-react": "^0.10.19", + "slate-trailing-block": "^0.4.0", "slug": "0.9.1", "string-hash": "^1.1.0", "string-replace-to-array": "^1.0.3", diff --git a/yarn.lock b/yarn.lock index 2d541e7d..97467779 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2664,7 +2664,7 @@ es6-iterator@2, es6-iterator@^2.0.1, es6-iterator@~2.0.1: es5-ext "^0.10.14" es6-symbol "^3.1" -es6-map@^0.1.3, es6-map@^0.1.4: +es6-map@^0.1.3: version "0.1.5" resolved "https://registry.yarnpkg.com/es6-map/-/es6-map-0.1.5.tgz#9136e0503dcc06a301690f0bb14ff4e364e949f0" dependencies: @@ -3467,7 +3467,7 @@ get-caller-file@^1.0.1: get-document@1: version "1.0.0" - resolved "https://registry.yarnpkg.com/get-document/-/get-document-1.0.0.tgz#4821bce66f1c24cb0331602be6cb6b12c4f01c4b" + resolved "https://registry.npmjs.org/get-document/-/get-document-1.0.0.tgz#4821bce66f1c24cb0331602be6cb6b12c4f01c4b" get-stdin@^4.0.1: version "4.0.1" @@ -3479,7 +3479,7 @@ get-stream@^3.0.0: get-window@^1.1.1: version "1.1.1" - resolved "https://registry.yarnpkg.com/get-window/-/get-window-1.1.1.tgz#0750f8970c88a54ac1294deb97add9568b3db594" + resolved "https://registry.npmjs.org/get-window/-/get-window-1.1.1.tgz#0750f8970c88a54ac1294deb97add9568b3db594" dependencies: get-document "1" @@ -4125,9 +4125,9 @@ immediate@~3.0.5: version "3.0.6" resolved "https://registry.yarnpkg.com/immediate/-/immediate-3.0.6.tgz#9db1dbd0faf8de6fbe0f5dd5e56bb606280de69b" -immutable@^3.8.1: - version "3.8.1" - resolved "https://registry.yarnpkg.com/immutable/-/immutable-3.8.1.tgz#200807f11ab0f72710ea485542de088075f68cd2" +immutable@^3.8.2: + version "3.8.2" + resolved "https://registry.npmjs.org/immutable/-/immutable-3.8.2.tgz#c2439951455bb39913daf281376f1530e104adf3" imports-loader@0.6.5: version "0.6.5" @@ -4366,6 +4366,10 @@ is-hexadecimal@^1.0.0: version "1.0.1" resolved "https://registry.npmjs.org/is-hexadecimal/-/is-hexadecimal-1.0.1.tgz#6e084bbc92061fbb0971ec58b6ce6d404e24da69" +is-hotkey@^0.1.1: + version "0.1.1" + resolved "https://registry.npmjs.org/is-hotkey/-/is-hotkey-0.1.1.tgz#b279a2fd108391be9aa93c6cb317f50357da549a" + is-image@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/is-image/-/is-image-1.0.1.tgz#6fd51a752a1a111506d060d952118b0b989b426e" @@ -4374,7 +4378,7 @@ is-image@^1.0.1: is-in-browser@^1.1.3: version "1.1.3" - resolved "https://registry.yarnpkg.com/is-in-browser/-/is-in-browser-1.1.3.tgz#56ff4db683a078c6082eb95dad7dc62e1d04f835" + resolved "https://registry.npmjs.org/is-in-browser/-/is-in-browser-1.1.3.tgz#56ff4db683a078c6082eb95dad7dc62e1d04f835" is-lower-case@^1.1.0: version "1.1.3" @@ -4435,7 +4439,7 @@ is-plain-obj@^1.0.0, is-plain-obj@^1.1.0: version "1.1.0" resolved "https://registry.yarnpkg.com/is-plain-obj/-/is-plain-obj-1.1.0.tgz#71a50c8429dfca773c92a390a4a03b39fcd51d3e" -is-plain-object@^2.0.1, is-plain-object@^2.0.3: +is-plain-object@^2.0.1, is-plain-object@^2.0.3, is-plain-object@^2.0.4: version "2.0.4" resolved "https://registry.yarnpkg.com/is-plain-object/-/is-plain-object-2.0.4.tgz#2c163b3fafb1b606d9d17928f05c2a1c38e07677" dependencies: @@ -4531,7 +4535,7 @@ is-whitespace-character@^1.0.0: is-window@^1.0.2: version "1.0.2" - resolved "https://registry.yarnpkg.com/is-window/-/is-window-1.0.2.tgz#2c896ca53db97de45d3c33133a65d8c9f563480d" + resolved "https://registry.npmjs.org/is-window/-/is-window-1.0.2.tgz#2c896ca53db97de45d3c33133a65d8c9f563480d" is-windows@^0.2.0: version "0.2.0" @@ -4571,6 +4575,10 @@ isobject@^3.0.0, isobject@^3.0.1: version "3.0.1" resolved "https://registry.yarnpkg.com/isobject/-/isobject-3.0.1.tgz#4e431e92b11a9731636aa1f9c8d1ccbcfdab78df" +isomorphic-base64@^1.0.2: + version "1.0.2" + resolved "https://registry.npmjs.org/isomorphic-base64/-/isomorphic-base64-1.0.2.tgz#f426aae82569ba8a4ec5ca73ad21a44ab1ee7803" + isomorphic-fetch@2.2.1, isomorphic-fetch@^2.1.1: version "2.2.1" resolved "https://registry.yarnpkg.com/isomorphic-fetch/-/isomorphic-fetch-2.2.1.tgz#611ae1acf14f5e81f729507472819fe9733558a9" @@ -5054,7 +5062,7 @@ jws@^3.0.0, jws@^3.1.4: keycode@^2.1.2: version "2.1.9" - resolved "https://registry.yarnpkg.com/keycode/-/keycode-2.1.9.tgz#964a23c54e4889405b4861a5c9f0480d45141dfa" + resolved "https://registry.npmjs.org/keycode/-/keycode-2.1.9.tgz#964a23c54e4889405b4861a5c9f0480d45141dfa" keygrip@~1.0.2: version "1.0.2" @@ -5670,6 +5678,10 @@ lodash.templatesettings@^3.0.0: lodash._reinterpolate "^3.0.0" lodash.escape "^3.0.0" +lodash.throttle@^4.1.1: + version "4.1.1" + resolved "https://registry.npmjs.org/lodash.throttle/-/lodash.throttle-4.1.1.tgz#c23e91b710242ac70c37f1e1cda9274cc39bf2f4" + lodash.toarray@^4.4.0: version "4.4.0" resolved "https://registry.yarnpkg.com/lodash.toarray/-/lodash.toarray-4.4.0.tgz#24c4bfcd6b2fba38bfd0594db1179d8e9b656561" @@ -7403,6 +7415,10 @@ react-helmet@^5.2.0: prop-types "^15.5.4" react-side-effect "^1.1.0" +react-immutable-proptypes@^2.1.0: + version "2.1.0" + resolved "https://registry.npmjs.org/react-immutable-proptypes/-/react-immutable-proptypes-2.1.0.tgz#023d6f39bb15c97c071e9e60d00d136eac5fa0b4" + react-keydown@^1.7.3: version "1.9.4" resolved "https://registry.yarnpkg.com/react-keydown/-/react-keydown-1.9.4.tgz#22718ac95edb64dd840dfc4350abf7e693ea0b7f" @@ -7431,8 +7447,8 @@ react-modal@^3.1.2: prop-types "^15.5.10" react-portal@^3.1.0: - version "3.1.0" - resolved "https://registry.yarnpkg.com/react-portal/-/react-portal-3.1.0.tgz#865c44fb72a1da106c649206936559ce891ee899" + version "3.2.0" + resolved "https://registry.npmjs.org/react-portal/-/react-portal-3.2.0.tgz#4224e19b2b05d5cbe730a7ba0e34ec7585de0043" dependencies: prop-types "^15.5.8" @@ -7993,7 +8009,7 @@ select@^1.1.2: selection-is-backward@^1.0.0: version "1.0.0" - resolved "https://registry.yarnpkg.com/selection-is-backward/-/selection-is-backward-1.0.0.tgz#97a54633188a511aba6419fc5c1fa91b467e6be1" + resolved "https://registry.npmjs.org/selection-is-backward/-/selection-is-backward-1.0.0.tgz#97a54633188a511aba6419fc5c1fa91b467e6be1" semver-diff@^2.0.0: version "2.1.0" @@ -8189,64 +8205,99 @@ slash@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/slash/-/slash-1.0.0.tgz#c41f2f6c39fc16d1cd17ad4b5d896114ae470d55" -slate-collapse-on-escape@^0.2.1: - version "0.2.1" - resolved "https://registry.yarnpkg.com/slate-collapse-on-escape/-/slate-collapse-on-escape-0.2.1.tgz#988f474439f0a21f94cc0016da52ea3c1a061100" +slate-base64-serializer@^0.2.14: + version "0.2.14" + resolved "https://registry.npmjs.org/slate-base64-serializer/-/slate-base64-serializer-0.2.14.tgz#9970bfddde069f76ba78a5ac644a1de352e8ba42" + dependencies: + isomorphic-base64 "^1.0.2" + +slate-collapse-on-escape@^0.6.0: + version "0.6.0" + resolved "https://registry.npmjs.org/slate-collapse-on-escape/-/slate-collapse-on-escape-0.6.0.tgz#668f2318770608a09a25a95623f5fb4329a277bf" dependencies: to-pascal-case "^1.0.0" -slate-edit-code@^0.10.2: - version "0.10.3" - resolved "https://registry.yarnpkg.com/slate-edit-code/-/slate-edit-code-0.10.3.tgz#c8211a050a127cdccc9174209f778fe489659801" +slate-dev-logger@^0.1.25, slate-dev-logger@^0.1.36: + version "0.1.36" + resolved "https://registry.npmjs.org/slate-dev-logger/-/slate-dev-logger-0.1.36.tgz#ecdb37dbf944dfc742bab23b6a20d5a0472db95e" + +slate-edit-code@^0.13.2: + version "0.13.2" + resolved "https://registry.npmjs.org/slate-edit-code/-/slate-edit-code-0.13.2.tgz#682a7640da076906e5b4a4c73ec0e46d31d92c62" dependencies: detect-indent "^4.0.0" detect-newline "^2.1.0" ends-with "^0.2.0" - immutable "^3.8.1" + is-hotkey "^0.1.1" -slate-edit-list@^0.7.0: - version "0.7.1" - resolved "https://registry.yarnpkg.com/slate-edit-list/-/slate-edit-list-0.7.1.tgz#84ee960d2d5b5a20ce267ad9df894395a91b93d5" +slate-edit-list@^0.10.1: + version "0.10.1" + resolved "https://registry.npmjs.org/slate-edit-list/-/slate-edit-list-0.10.1.tgz#9c6a142a314b0ff22a327f1b50c8f5c85468cb17" -slate-md-serializer@0.5.6: - version "0.5.6" - resolved "https://registry.npmjs.org/slate-md-serializer/-/slate-md-serializer-0.5.6.tgz#88048ae62757ce3aaf1096ebd4200c58fdd1e86c" +slate-md-serializer@1.0.1: + version "1.0.1" + resolved "https://registry.npmjs.org/slate-md-serializer/-/slate-md-serializer-1.0.1.tgz#10fb8118bf0b97addaf9d7fd77c1b19f3d767309" -slate-paste-linkify@^0.2.1: - version "0.2.1" - resolved "https://registry.yarnpkg.com/slate-paste-linkify/-/slate-paste-linkify-0.2.1.tgz#4647b5207b910d2d084f7d5d256384869b0a9c75" +slate-paste-linkify@^0.5.0: + version "0.5.0" + resolved "https://registry.npmjs.org/slate-paste-linkify/-/slate-paste-linkify-0.5.0.tgz#fbb52216ae4c02475b42b3de3609de0ad6b07fd1" dependencies: is-url "^1.2.2" to-pascal-case "^1.0.0" -slate-prism@^0.2.2: - version "0.2.2" - resolved "https://registry.yarnpkg.com/slate-prism/-/slate-prism-0.2.2.tgz#0c9d5c2bee0e94a6df5fc564b7a99f6b8e1ea492" +slate-plain-serializer@^0.4.12: + version "0.4.12" + resolved "https://registry.npmjs.org/slate-plain-serializer/-/slate-plain-serializer-0.4.12.tgz#802c246bbb7f5c03170a6b3b862251ec51d39cb6" + dependencies: + slate-dev-logger "^0.1.36" + +slate-prism@^0.4.0: + version "0.4.0" + resolved "https://registry.npmjs.org/slate-prism/-/slate-prism-0.4.0.tgz#9d43b1fafa4c3a8e3bceaa8dbc41dd5ca39445a9" dependencies: prismjs "^1.6.0" -slate-trailing-block@^0.2.4: - version "0.2.4" - resolved "https://registry.yarnpkg.com/slate-trailing-block/-/slate-trailing-block-0.2.4.tgz#6ce9525fa15f9f098d810d9312a4267799cd0e12" +slate-prop-types@^0.4.12: + version "0.4.12" + resolved "https://registry.npmjs.org/slate-prop-types/-/slate-prop-types-0.4.12.tgz#a600030e8083fbc4a195ed98657e0d4e45caf93b" + dependencies: + slate-dev-logger "^0.1.36" -slate@^0.21.4: - version "0.21.4" - resolved "https://registry.yarnpkg.com/slate/-/slate-0.21.4.tgz#ae6113379cd838b7ec68ecd94834ce9741bc36f3" +slate-react@^0.10.19: + version "0.10.19" + resolved "https://registry.npmjs.org/slate-react/-/slate-react-0.10.19.tgz#917dac40634aeb0dc973100d492e11fc450c80ee" dependencies: debug "^2.3.2" - direction "^0.1.5" - es6-map "^0.1.4" - esrever "^0.2.0" get-window "^1.1.1" - immutable "^3.8.1" - is-empty "^1.0.0" + is-hotkey "^0.1.1" is-in-browser "^1.1.3" is-window "^1.0.2" keycode "^2.1.2" - lodash "^4.17.4" + lodash.throttle "^4.1.1" prop-types "^15.5.8" + react-immutable-proptypes "^2.1.0" react-portal "^3.1.0" selection-is-backward "^1.0.0" + slate-base64-serializer "^0.2.14" + slate-dev-logger "^0.1.36" + slate-plain-serializer "^0.4.12" + slate-prop-types "^0.4.12" + +slate-trailing-block@^0.4.0: + version "0.4.0" + resolved "https://registry.npmjs.org/slate-trailing-block/-/slate-trailing-block-0.4.0.tgz#92573d7729e4c2a05c45521616ae2db28197476c" + +slate@^0.29.0: + version "0.29.1" + resolved "https://registry.npmjs.org/slate/-/slate-0.29.1.tgz#a9df98158e67f92456b9b8f38fb6d279ba8f9f7e" + dependencies: + debug "^2.3.2" + direction "^0.1.5" + esrever "^0.2.0" + is-empty "^1.0.0" + is-plain-object "^2.0.4" + lodash "^4.17.4" + slate-dev-logger "^0.1.25" type-of "^2.0.1" slice-ansi@0.0.4: