JSPM

  • Created
  • Published
  • Downloads 157117
  • Score
    100M100P100Q155829F
  • License MIT

Theme github for CodeMirror.

Package Exports

    Readme

    Github Theme

    Buy me a coffee npm version

    codemirror-theme-github dark codemirror-theme-github light

    Install

    npm install @uiw/codemirror-theme-github --save
    import { EditorState } from '@codemirror/state';
    import { javascript } from '@codemirror/lang-javascript';
    import { githubLight, githubDark } from '@uiw/codemirror-theme-github';
    
    const state = EditorState.create({
      doc: 'my source code',
      extensions: [githubDark, javascript({ jsx: true })],
    });

    Using in React:

    import { githubLight, githubLightInit, githubDark, githubDarkInit } from '@uiw/codemirror-theme-github';
    
    <CodeMirror theme={githubLight} />
    <CodeMirror
      theme={githubLightInit({
        settings: {
          caret: '#c6c6c6',
          fontFamily: 'monospace',
        }
      })}
    />

    API

    import { CreateThemeOptions } from '@uiw/codemirror-themes';
    export declare const defaultSettingsGithubLight: CreateThemeOptions['settings'];
    export declare const githubLightInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
    export declare const githubLight: import('@codemirror/state').Extension;
    export declare const defaultSettingsGithubDark: CreateThemeOptions['settings'];
    export declare const githubDarkInit: (options?: Partial<CreateThemeOptions>) => import('@codemirror/state').Extension;
    export declare const githubDark: import('@codemirror/state').Extension;

    Usage

    import CodeMirror from '@uiw/react-codemirror';
    import { githubLight, githubDark } from '@uiw/codemirror-theme-github';
    import { javascript } from '@codemirror/lang-javascript';
    
    function App() {
      return (
        <CodeMirror
          value="console.log('hello world!');"
          height="200px"
          theme={githubLight}
          extensions={[javascript({ jsx: true })]}
          onChange={(value, viewUpdate) => {
            console.log('value:', value);
          }}
        />
      );
    }
    export default App;
    import { EditorView } from '@codemirror/view';
    import { EditorState } from '@codemirror/state';
    import { javascript } from '@codemirror/lang-javascript';
    import { githubLight, githubDark } from '@uiw/codemirror-theme-github';
    
    const state = EditorState.create({
      doc: 'my source code',
      extensions: [githubDark, javascript({ jsx: true })],
    });
    
    const view = new EditorView({
      parent: document.querySelector('#editor'),
      state,
    });

    Contributors

    As always, thanks to our amazing contributors!

    Made with action-contributors.

    License

    Licensed under the MIT License.