0.2.3 • Published 8 months ago

monaco-editor-solidjs v0.2.3

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

Monaco Editor for SolidJS.

NPM version bun

Quick start

Install it:

npm i monaco-editor-solidjs
# or
yarn add monaco-editor-solidjs
# or
pnpm add monaco-editor-solidjs
# or
bun add monaco-editor-solidjs

MonacoEditor

Basic Usage:

You can import and use the MonacoEditor component in your Solid Application:

import { MonacoEditor } from 'monaco-editor-solidjs';

function Editor() {
    return <MonacoEditor language="javascript" defaultValue="console.log('Hello World!');" />;
}

Props

The MonacoEditor component accepts the following props:

PropTypeDefaultDescription
languagestring-The programming language for the editor. E.g., "javascript", "typescript".
defaultValuestring-Default value for the content of the editor.
valuestring-Content of the editor.
loadingStateJSX.Element"Loading…"JSX element to be displayed during the loading state.
classstring-CSS class for the editor container.
themeBuiltinTheme or string"vs"The theme to be applied to the editor.
pathstring""Path used for Monaco model management for multiple files.
overrideServicesobject-Services to override the default ones provided by Monaco.
widthstring"100%"Width of the editor container.
heightstring"100%"Height of the editor container.
optionsobject-Additional options for the Monaco editor.
saveViewStatestringtrueWhether to save the model view state for a given path of the editor.
onChange(value: string, event: editor.IModelContentChangedEvent) => void-Callback triggered when the content of the editor changes.
onBeforeMount() => void-Callback triggered before the editor mounts.
onMount(monaco: Monaco, editor: editor.IStandaloneCodeEditor) => void-Callback triggered when the editor mounts.
onBeforeUnmount(monaco: Monaco, editor: editor.IStandaloneCodeEditor) => void-Callback triggered before the editor unmounts.

Getting Monaco and Editor Instances

You can get instances of both monaco and the editor by using the onMount callback:

import { MonacoEditor } from 'monaco-editor-solidjs';

function Editor() {
  const handleMount = (monaco, editor) => {
    // Use monaco and editor instances here
  };

  return (
    <MonacoEditor
      language="javascript"
      defaultValue="console.log('Hello World!);"
      onMount={handleMount}
    />
  );
}

License

MIT

0.2.3

8 months ago

0.2.2

8 months ago

0.2.1

8 months ago

0.2.0

8 months ago

0.1.8

8 months ago

0.1.7

8 months ago

0.1.6

8 months ago

0.1.5

8 months ago

0.1.4

8 months ago

0.1.3

8 months ago

0.1.2

8 months ago

0.1.1

8 months ago

0.1.0

8 months ago