National Patience Month

    react-monaco-hooks

    0.28.5 • Public • Published

    react-monaco-hooks

    WIP! Created for internal use in my projects.

    For now it's in Pre-Alpha stage. May be broken :)

    Monaco Editor for React.

    Based on "react-monaco-editor"

    react-monaco-editor

    Examples

    To build the examples locally, run:

    yarn
    cd example
    yarn
    yarn start

    Then open http://localhost:8886 in a browser.

    Installation

    yarn add react-monaco-hooks

    Using with Webpack

    import React, {useState} from 'react';
    import ReactDOM from 'react-dom';
    import MonacoEditor from 'react-monaco-hooks';
     
    function App(props) {
      const [code, setCode] = useState('// type your code...');
       
      const editorDidMount = (editor, monaco) => {
        console.log('editorDidMount', editor);
        editor.focus();
      };
      
      const onChange = (newValue, e) => {
        console.log('onChange', newValue, e);
      };
      
      const options = {
        selectOnLineNumbers: true
      };
      
      return (
        <MonacoEditor
          width="800"
          height="600"
          language="javascript"
          theme="vs-dark"
          value={code}
          options={options}
          onChange={onChange}
          editorDidMount={editorDidMount}
        />
       );
    }
     
    ReactDOM.render(
      <App />,
      document.getElementById('root')
    );

    Add the Monaco Webpack plugin monaco-editor-webpack-plugin to your webpack.config.js:

    const MonacoWebpackPlugin = require('monaco-editor-webpack-plugin');
    module.exports = {
      plugins: [
        new MonacoWebpackPlugin({
          // available options are documented at https://github.com/Microsoft/monaco-editor-webpack-plugin#options
          languages: ['json']
        })
      ]
    };

    Sidenote: Monaco Editor uses CSS imports internally, so if you're using CSS Modules in your project - you're likely to get conflict by default. In order to avoid that - separate css-loader for app and monaco-editor package:

    // Specify separate paths
    const path = require('path');
    const APP_DIR = path.resolve(__dirname, './src');
    const MONACO_DIR = path.resolve(__dirname, './node_modules/monaco-editor');
     
    {
      test: /\.css$/,
      include: APP_DIR,
      use: [{
        loader: 'style-loader',
      }, {
        loader: 'css-loader',
        options: {
          modules: true,
          namedExport: true,
        },
      }],
    }, {
      test: /\.css$/,
      include: MONACO_DIR,
      use: ['style-loader', 'css-loader'],
    }

    Properties

    All the properties below are optional.

    • width width of editor. Defaults to 100%.
    • height height of editor. Defaults to 100%.
    • value value of the auto created model in the editor.
    • defaultValue the initial value of the auto created model in the editor.
    • language the initial language of the auto created model in the editor.
    • theme the theme of the editor
    • options refer to Monaco interface IEditorConstructionOptions.
    • onChange(newValue, event) an event emitted when the content of the current model has changed.
    • editorWillMount(monaco) an event emitted before the editor mounted (similar to componentWillMount of React).
    • editorDidMount(editor, monaco) an event emitted when the editor has been mounted (similar to componentDidMount of React).
    • context allow to pass a different context then the global window onto which the monaco instance will be loaded. Useful if you want to load the editor in an iframe.

    Events & Methods

    Refer to Monaco interface IEditor.

    Q & A

    I don't get syntax highlighting / autocomplete / validation.

    Make sure to use the Monaco Webpack plugin or follow the instructions on how to load the ESM version of Monaco.

    How to interact with the MonacoEditor instance

    Using the first parameter of editorDidMount, or using a ref (e.g. <MonacoEditor ref="monaco">) after editorDidMount event has fired.

    Then you can invoke instance methods via this.refs.monaco.editor, e.g. this.refs.monaco.editor.focus() to focuses the MonacoEditor instance.

    How to get value of editor

    Using this.refs.monaco.editor.getValue() or via method of Model instance:

    const model = this.refs.monaco.editor.getModel();
    const value = model.getValue();

    Do something before editor mounted

    For example, you may want to configure some JSON schemas before editor mounted, then you can go with editorWillMount(monaco):

    function App(props) {
        const editorWillMount = (monaco) => {
            monaco.languages.json.jsonDefaults.setDiagnosticsOptions({
                schemas: [{
                    uri: "http://myserver/foo-schema.json",
                    schema: {
                        type: "object",
                        properties: {
                            p1: {
                                enum: [ "v1", "v2"]
                            },
                            p2: {
                                $ref: "http://myserver/bar-schema.json"
                            }
                        }
                    }
                }]
            });
        }
        return <MonacoEditor language="json" editorWillMount={editorWillMount} />;
    }

    Available (built-in) themes:

    "vs",
    "vs-dark",
    "hc-black"
    

    More themes can be found here

    How to use the diff editor

    import React from 'react';
    import { MonacoDiffEditor } from 'react-monaco-hooks';
     
    function App(props) {
        const code1 = "// your original code...";
        const code2 = "// a different version...";
        const options = {
          //renderSideBySide: false
        };
        return (
          <MonacoDiffEditor
            width="800"
            height="600"
            language="javascript"
            original={code1}
            value={code2}
            options={options}
          />
        );
    }

    Install

    npm i react-monaco-hooks

    DownloadsWeekly Downloads

    62

    Version

    0.28.5

    License

    MIT

    Unpacked Size

    10.1 MB

    Total Files

    27

    Last publish

    Collaborators

    • ozonep