Skip to main content

CodeExtension

Summary

Add a code mark to the editor. This is used to mark inline text as a code snippet.

Usage

Installation

This extension is installed for you when you install the main remirror package.

You can use the imports in the following way:

import { CodeExtension } from 'remirror/extensions';

The extension is provided by the @remirror/extension-code package.

Examples

Source code
import 'remirror/styles/all.css';
import './styles.css';

import { cx, htmlToProsemirrorNode } from 'remirror';
import { CodeExtension } from 'remirror/extensions';
import { Remirror, ThemeProvider, useActive, useCommands, useRemirror } from '@remirror/react';

const extensions = () => [new CodeExtension()];

const CodeButton = () => {
const commands = useCommands();
const active = useActive(true);
return (
<button
onMouseDown={(event) => event.preventDefault()}
onClick={() => commands.toggleCode()}
className={cx(active.code() && 'active')}
>
Code
</button>
);
};

const Basic = (): JSX.Element => {
const { manager, state, onChange } = useRemirror({
extensions: extensions,
content: '<p>Text as <code>code</code>.</p>',
stringHandler: htmlToProsemirrorNode,
});

return (
<ThemeProvider>
<Remirror
manager={manager}
autoFocus
onChange={onChange}
initialContent={state}
autoRender='end'
>
<CodeButton />
</Remirror>
</ThemeProvider>
);
};

export default Basic;

API