@instructure/ui-source-code-editor 8.25.1-snapshot-19

package/es/SourceCodeEditor/index.js

@@ -0,0 +1,587 @@
+import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
+const _excluded = ["label", "styles"];
+
+var _dec, _dec2, _dec3, _dec4, _class, _class2;
+
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+/** @jsx jsx */
+import { Component } from 'react';
+import { merge, cloneDeep, isEqual } from 'lodash';
+import { EditorState, StateEffect } from '@codemirror/state';
+import { EditorView, highlightSpecialChars, highlightActiveLine, drawSelection, dropCursor, rectangularSelection, crosshairCursor, lineNumbers, highlightActiveLineGutter, keymap } from '@codemirror/view';
+import { autocompletion, completionKeymap, closeBrackets, closeBracketsKeymap } from '@codemirror/autocomplete';
+import { highlightSelectionMatches // Search feature is turned off for now, see note at keymaps
+// searchKeymap
+} from '@codemirror/search';
+import { indentSelection, defaultKeymap, indentWithTab, history, historyKeymap } from '@codemirror/commands';
+import { lintKeymap } from '@codemirror/lint';
+import { indentOnInput, indentUnit, StreamLanguage, bracketMatching, foldGutter, foldKeymap, defaultHighlightStyle, syntaxHighlighting, HighlightStyle } from '@codemirror/language';
+import { javascript } from '@codemirror/lang-javascript';
+import { html } from '@codemirror/lang-html';
+import { css } from '@codemirror/lang-css';
+import { markdown } from '@codemirror/lang-markdown';
+import { json } from '@codemirror/lang-json';
+import { shell } from '@codemirror/legacy-modes/mode/shell';
+import { yaml } from '@codemirror/legacy-modes/mode/yaml'; // import { oneDarkTheme, oneDarkHighlightStyle } from '@codemirror/theme-one-dark'
+
+import { testable } from '@instructure/ui-testable';
+import { omitProps, passthroughProps, withDeterministicId } from '@instructure/ui-react-utils';
+import { requestAnimationFrame } from '@instructure/ui-dom-utils';
+import { ScreenReaderContent } from '@instructure/ui-a11y-content';
+import { textDirectionContextConsumer } from '@instructure/ui-i18n';
+import { withStyle, jsx } from '@instructure/emotion';
+import generateStyle from './styles';
+import generateComponentTheme from './theme';
+import { rtlHorizontalArrowKeymap } from './customKeybinding';
+import { propTypes, allowedProps } from './props';
+
+/**
+---
+category: components
+---
+@tsProps
+**/
+let SourceCodeEditor = (_dec = withDeterministicId(), _dec2 = withStyle(generateStyle, generateComponentTheme), _dec3 = textDirectionContextConsumer(), _dec4 = testable(), _dec(_class = _dec2(_class = _dec3(_class = _dec4(_class = (_class2 = class SourceCodeEditor extends Component {
+  addAnimationFrame(callback) {
+    if (typeof callback === 'function') {
+      this._raf.push(requestAnimationFrame(callback));
+    }
+  }
+
+  cancelAnimationFrames() {
+    this._raf.forEach(request => request.cancel());
+
+    this._raf = [];
+  }
+
+  focus() {
+    this.addAnimationFrame(() => {
+      var _this$_editorView;
+
+      (_this$_editorView = this._editorView) === null || _this$_editorView === void 0 ? void 0 : _this$_editorView.focus();
+    });
+  }
+
+  get hasFocus() {
+    var _this$_editorView2;
+
+    return (_this$_editorView2 = this._editorView) === null || _this$_editorView2 === void 0 ? void 0 : _this$_editorView2.hasFocus;
+  }
+
+  selectAll() {
+    if (this._editorView) {
+      this.addAnimationFrame(() => {
+        var _this$currentDocValue;
+
+        this.dispatchViewSelection({
+          anchor: 0,
+          head: (_this$currentDocValue = this.currentDocValue) === null || _this$currentDocValue === void 0 ? void 0 : _this$currentDocValue.length
+        });
+      });
+    }
+  }
+
+  deselectAll() {
+    if (this._editorView) {
+      this.addAnimationFrame(() => {
+        this.dispatchViewSelection({
+          anchor: 0,
+          head: 0
+        });
+      });
+    }
+  }
+
+  indentCurrentSelection() {
+    this.addAnimationFrame(() => {
+      if (this._editorView) {
+        indentSelection({
+          state: this._editorView.state,
+          dispatch: transaction => {
+            var _this$_editorView3;
+
+            (_this$_editorView3 = this._editorView) === null || _this$_editorView3 === void 0 ? void 0 : _this$_editorView3.update([transaction]);
+          }
+        });
+      }
+    });
+  }
+
+  indentAll() {
+    this.addAnimationFrame(() => {
+      this.selectAll();
+      this.indentCurrentSelection();
+      this.deselectAll();
+    });
+  } // Attach state effects
+
+
+  dispatchViewEffects(effects) {
+    if (!this._editorView || !effects) return;
+
+    this._editorView.dispatch({
+      effects
+    });
+  } // Dispatch changes to the document
+
+
+  dispatchViewChanges(_ref) {
+    let changes = _ref.changes,
+        selection = _ref.selection,
+        userEvent = _ref.userEvent;
+    if (!this._editorView || !changes) return;
+
+    this._editorView.dispatch({
+      changes,
+      ...(selection ? {
+        selection
+      } : void 0),
+      ...(userEvent ? {
+        userEvent
+      } : void 0)
+    });
+  } // Select a portion of the document
+
+
+  dispatchViewSelection(selection) {
+    if (!this._editorView || !selection) return;
+
+    this._editorView.dispatch({
+      selection
+    });
+  }
+
+  get currentDocValue() {
+    var _this$_editorView4;
+
+    return (_this$_editorView4 = this._editorView) === null || _this$_editorView4 === void 0 ? void 0 : _this$_editorView4.state.doc;
+  } // when value is passed, the editor should be controlled
+
+
+  get isControlled() {
+    return typeof this.props.value === 'string';
+  }
+
+  constructor(props) {
+    super(props);
+    this._id = void 0;
+    this.ref = null;
+    this._containerRef = void 0;
+    this._editorView = void 0;
+    this._raf = [];
+    this._newSelectionAfterValueChange = void 0;
+
+    this.handleRef = el => {
+      const elementRef = this.props.elementRef;
+      this.ref = el;
+
+      if (typeof elementRef === 'function') {
+        elementRef(el);
+      }
+    };
+
+    this.handleContainerRef = el => {
+      const containerRef = this.props.containerRef;
+      this._containerRef = el || void 0;
+
+      if (typeof containerRef === 'function') {
+        containerRef(el);
+      }
+    };
+
+    this._id = props.deterministicId();
+  }
+
+  componentDidMount() {
+    var _this$props$makeStyle, _this$props2;
+
+    const _this$props = this.props,
+          value = _this$props.value,
+          defaultValue = _this$props.defaultValue,
+          autofocus = _this$props.autofocus,
+          indentOnLoad = _this$props.indentOnLoad;
+    (_this$props$makeStyle = (_this$props2 = this.props).makeStyles) === null || _this$props$makeStyle === void 0 ? void 0 : _this$props$makeStyle.call(_this$props2);
+    const state = EditorState.create({
+      doc: value || defaultValue,
+      extensions: this.extensions
+    });
+    this._editorView = new EditorView({
+      state,
+      parent: this._containerRef
+    });
+
+    if (autofocus) {
+      this.focus();
+    }
+
+    if (indentOnLoad) {
+      this.indentAll();
+    }
+  }
+
+  componentWillUnmount() {
+    this._editorView = void 0;
+    this.cancelAnimationFrames();
+  }
+
+  componentDidUpdate(prevProps) {
+    var _this$props$makeStyle2, _this$props3;
+
+    (_this$props$makeStyle2 = (_this$props3 = this.props).makeStyles) === null || _this$props$makeStyle2 === void 0 ? void 0 : _this$props$makeStyle2.call(_this$props3);
+
+    if (this._editorView) {
+      if (this.props.value !== prevProps.value) {
+        this.refreshEditorValue();
+      }
+
+      if (this.shouldUpdateExtensions(prevProps)) {
+        this.refreshExtensions();
+      }
+    }
+  }
+
+  shouldUpdateExtensions(prevProps) {
+    const propsToObserve = ['styles', // needed for theme update
+    'themeOverride', 'language', 'readOnly', 'editable', 'lineNumbers', 'highlightActiveLineGutter', 'foldGutter', 'lineWrapping', 'autofocus', 'spellcheck', 'direction', 'dir', 'rtlMoveVisually', 'indentOnLoad', 'indentWithTab', 'indentUnit', 'highlightActiveLine', 'attachment'];
+
+    for (const prop of propsToObserve) {
+      if (!isEqual(this.props[prop], prevProps[prop])) {
+        return true;
+      }
+    }
+
+    return false;
+  }
+
+  get direction() {
+    // comes from the `direction` prop and
+    // falls back to the `dir` prop coming from the bidirectional decorator
+    return this.props.direction || this.props.dir;
+  }
+
+  get extensions() {
+    const extensions = [...this.baseExtensions, // our custom extensions
+    this.languageExtension, this.onChangeExtension, this.focusListenerExtension, this.announceLineNumberExtension];
+
+    if (this.themeExtension) {
+      extensions.push(this.themeExtension);
+    }
+
+    if (this.props.lineNumbers) {
+      extensions.push(lineNumbers());
+    }
+
+    if (this.props.highlightActiveLine) {
+      extensions.push(highlightActiveLine());
+    }
+
+    if (this.props.highlightActiveLineGutter) {
+      extensions.push(highlightActiveLineGutter());
+    }
+
+    if (this.props.foldGutter) {
+      extensions.push(foldGutter());
+    }
+
+    if (this.props.lineWrapping) {
+      extensions.push(EditorView.lineWrapping);
+    }
+
+    if (this.props.editable === false) {
+      extensions.push(EditorView.editable.of(false));
+    }
+
+    if (this.props.readOnly) {
+      extensions.push(EditorState.readOnly.of(true));
+    }
+
+    if (this.props.spellcheck) {
+      extensions.push(EditorView.contentAttributes.of({
+        spellcheck: 'true'
+      }));
+    }
+
+    if (this.direction) {
+      extensions.push(EditorView.contentAttributes.of({
+        dir: this.direction
+      }));
+    }
+
+    if (this.props.indentUnit) {
+      extensions.push(indentUnit.of(this.props.indentUnit));
+    }
+
+    return extensions;
+  }
+
+  get baseExtensions() {
+    return [// The extensions are based on codemirrors basic setup from 'codemirror'.
+    // It is recommended by CodeMirror, that if we want to configure
+    // our editor more precisely, we have to copy the source
+    // and adjust it as desired.
+    highlightSpecialChars(), history(), drawSelection(), dropCursor(), EditorState.allowMultipleSelections.of(true), syntaxHighlighting(defaultHighlightStyle, {
+      fallback: true
+    }), bracketMatching(), closeBrackets(), autocompletion(), rectangularSelection(), crosshairCursor(), highlightSelectionMatches(), indentOnInput(), keymap.of(this.keymaps)];
+  }
+
+  get keymaps() {
+    // TODO: if more keymaps are added, list them in the docs as well (#Command keybinding)
+    const keymaps = [...closeBracketsKeymap, ...this.commandKeybinding, ...historyKeymap, ...foldKeymap, ...completionKeymap, ...lintKeymap // TODO: style and include search & replace toolbar feature
+    // Note: the search & replace toolbar is not styled.
+    // If this feature is needed in the future, we need a decision about the styling.
+    // For now we turned the feature off, since RCE doesn't need it.
+    // ...searchKeymap
+    ];
+
+    if (this.props.indentWithTab) {
+      keymaps.push(indentWithTab);
+    }
+
+    return keymaps;
+  }
+
+  get commandKeybinding() {
+    const rtlMoveVisually = this.props.rtlMoveVisually;
+
+    if (this.direction === 'rtl' && !rtlMoveVisually) {
+      // we need to clone the original so that it doesn't get overridden
+      return merge(cloneDeep(defaultKeymap), rtlHorizontalArrowKeymap);
+    }
+
+    return defaultKeymap;
+  }
+
+  get themeExtension() {
+    const styles = this.props.styles;
+
+    if (!(styles !== null && styles !== void 0 && styles.theme) || !styles.highlightStyle) {
+      return;
+    }
+
+    const theme = EditorView.theme(styles === null || styles === void 0 ? void 0 : styles.theme);
+    const highlightStyle = syntaxHighlighting(HighlightStyle.define(styles === null || styles === void 0 ? void 0 : styles.highlightStyle)); // see notes in props.ts
+    // if (darkTheme) {
+    //   theme = oneDarkTheme
+    //   highlightStyle = syntaxHighlighting(oneDarkHighlightStyle)
+    // }
+
+    return [theme, highlightStyle];
+  }
+
+  get languageExtension() {
+    const language = this.props.language;
+
+    switch (language) {
+      case 'json':
+        return json();
+
+      case 'js':
+      case 'jsx':
+      case 'javascript':
+        return javascript({
+          jsx: true,
+          typescript: true
+        });
+
+      case 'html':
+        return html({
+          matchClosingTags: true,
+          autoCloseTags: true
+        });
+
+      case 'css':
+        return css();
+
+      case 'markdown':
+        return markdown();
+
+      case 'sh':
+      case 'shell':
+      case 'bash':
+        // ????
+        return StreamLanguage.define(shell);
+
+      case 'yml':
+      case 'yaml':
+        return StreamLanguage.define(yaml);
+
+      default:
+        return javascript({
+          jsx: true,
+          typescript: true
+        });
+    }
+  }
+
+  callOnChangeHandler(newValue) {
+    const _this$props4 = this.props,
+          onChange = _this$props4.onChange,
+          value = _this$props4.value;
+    this.addAnimationFrame(() => {
+      if (typeof onChange === 'function' && newValue !== value) {
+        onChange(newValue);
+      }
+    });
+  }
+
+  get onChangeExtension() {
+    return EditorState.changeFilter.of(transaction => {
+      if (!this._editorView) {
+        return false;
+      }
+
+      if (transaction.docChanged) {
+        const newDoc = transaction.newDoc.toString();
+
+        if (this.isControlled) {
+          // the value will be changed by the onChange handler,
+          // refreshEditorValue has to run first
+          if (newDoc !== this.props.value) {
+            this._newSelectionAfterValueChange = transaction.selection;
+            this.cancelAnimationFrames();
+            this.callOnChangeHandler(newDoc);
+            return false;
+          } else {
+            return true;
+          }
+        } else {
+          this.callOnChangeHandler(newDoc);
+        }
+      }
+
+      return true;
+    });
+  }
+
+  get focusListenerExtension() {
+    const _this$props5 = this.props,
+          onFocus = _this$props5.onFocus,
+          onBlur = _this$props5.onBlur;
+    return EditorView.updateListener.of(update => {
+      if (update.focusChanged && this._editorView) {
+        if (this.hasFocus) {
+          if (typeof onFocus === 'function') {
+            onFocus();
+          }
+        } else {
+          if (typeof onBlur === 'function') {
+            onBlur();
+          }
+        }
+      }
+    });
+  }
+
+  get announceLineNumberExtension() {
+    return EditorState.transactionExtender.of(tr => {
+      const selection = tr.selection;
+      const oldSelection = tr.startState.selection.main;
+
+      if (selection && selection.main.empty && oldSelection.empty) {
+        const oldLine = tr.startState.doc.lineAt(oldSelection.head);
+        const newLine = tr.newDoc.lineAt(selection.main.head);
+        if (oldLine.number != newLine.number) return {
+          effects: EditorView.announce.of(tr.startState.phrase('line ') + newLine.number + '.')
+        };
+      }
+
+      return null;
+    });
+  }
+
+  refreshExtensions() {
+    this.dispatchViewEffects(StateEffect.reconfigure.of(this.extensions));
+  }
+
+  refreshEditorValue() {
+    if (!this._editorView) return;
+    const value = this.props.value;
+
+    const currentValue = this._editorView.state.doc.toString();
+
+    if (value && currentValue !== value) {
+      let userEvent;
+      const lengthDiff = value.length - currentValue.length; // setting user events are needed for the autocomplete to work
+      // (only these 2 events, autocomplete doesn't work on paste, etc.)
+
+      if (lengthDiff === 1) {
+        userEvent = 'input.type';
+      } else if (lengthDiff === -1) {
+        userEvent = 'delete.backward';
+      }
+
+      this.dispatchViewChanges({
+        changes: {
+          from: 0,
+          to: currentValue.length,
+          insert: value || ''
+        },
+        selection: this._newSelectionAfterValueChange,
+        userEvent: userEvent
+      });
+      this._newSelectionAfterValueChange = void 0;
+    }
+
+    if (this.props.indentOnLoad) {
+      this.indentAll();
+    }
+  }
+
+  render() {
+    const _this$props6 = this.props,
+          label = _this$props6.label,
+          styles = _this$props6.styles,
+          restProps = _objectWithoutProperties(_this$props6, _excluded);
+
+    return jsx("div", Object.assign({
+      ref: this.handleRef,
+      css: styles === null || styles === void 0 ? void 0 : styles.codeEditor
+    }, passthroughProps(omitProps(restProps, SourceCodeEditor.allowedProps))), jsx("label", {
+      htmlFor: this._id
+    }, jsx(ScreenReaderContent, null, label), jsx("div", {
+      ref: this.handleContainerRef,
+      css: styles === null || styles === void 0 ? void 0 : styles.codeEditorContainer
+    })));
+  }
+
+}, _class2.displayName = "SourceCodeEditor", _class2.componentId = 'SourceCodeEditor', _class2.propTypes = propTypes, _class2.allowedProps = allowedProps, _class2.defaultProps = {
+  language: 'jsx',
+  readOnly: false,
+  editable: true,
+  lineNumbers: false,
+  foldGutter: false,
+  highlightActiveLine: false,
+  highlightActiveLineGutter: false,
+  lineWrapping: false,
+  autofocus: false,
+  spellcheck: false,
+  rtlMoveVisually: true,
+  indentOnLoad: false,
+  indentWithTab: false,
+  defaultValue: ''
+}, _class2)) || _class) || _class) || _class) || _class);
+export default SourceCodeEditor;
+export { SourceCodeEditor };

package/es/SourceCodeEditor/props.js

@@ -0,0 +1,55 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import PropTypes from 'prop-types';
+import { controllable } from '@instructure/ui-prop-types';
+const propTypes = {
+  label: PropTypes.string.isRequired,
+  language: PropTypes.oneOf(['sh', 'js', 'json', 'javascript', 'jsx', 'shell', 'css', 'html', 'markdown', 'yaml', 'yml', 'bash']),
+  readOnly: PropTypes.bool,
+  editable: PropTypes.bool,
+  lineNumbers: PropTypes.bool,
+  foldGutter: PropTypes.bool,
+  highlightActiveLineGutter: PropTypes.bool,
+  highlightActiveLine: PropTypes.bool,
+  lineWrapping: PropTypes.bool,
+  autofocus: PropTypes.bool,
+  spellcheck: PropTypes.bool,
+  direction: PropTypes.oneOf(['ltr', 'rtl']),
+  rtlMoveVisually: PropTypes.bool,
+  indentOnLoad: PropTypes.bool,
+  indentWithTab: PropTypes.bool,
+  indentUnit: PropTypes.string,
+  defaultValue: PropTypes.string,
+  value: controllable(PropTypes.string, 'onChange', 'defaultValue'),
+  onChange: PropTypes.func,
+  onFocus: PropTypes.func,
+  onBlur: PropTypes.func,
+  attachment: PropTypes.oneOf(['bottom', 'top']),
+  // darkTheme: PropTypes.bool,
+  elementRef: PropTypes.func,
+  containerRef: PropTypes.func
+};
+const allowedProps = ['label', 'language', 'readOnly', 'editable', 'lineNumbers', 'foldGutter', 'highlightActiveLineGutter', 'highlightActiveLine', 'lineWrapping', 'autofocus', 'spellcheck', 'direction', 'rtlMoveVisually', 'indentOnLoad', 'indentWithTab', 'indentUnit', 'defaultValue', 'value', 'onChange', 'onFocus', 'onBlur', 'attachment', // 'darkTheme',
+'elementRef', 'containerRef'];
+export { propTypes, allowedProps };