@sagold/rje-code-widgets v0.33.8

Additional code widgets for @sagold/react-json-editor to edit code formatted strings, json and json with json-schema validation using CodeMirror and @uiw/react-codemirror.

install

yarn add @sagold/rje-code-widgets

include css

@import "@sagold/rje-code-widgets/rje-code-widgets.css";

Json Widget

Specific code editor supporting json syntax highlighting, linting and inline json-schema validation. The editor supports all kinds of data and json as strings.

To add the plugin to available widgets you have to pass it to the widget plugin registry:

import { defaultWidgets } from "@sagold/react-json-editor";
import { JsonWidgetPlugin } from "@sagold/rje-code-widgets";

<JsonForm widgets={[JsonWidgetPlugin, ...defaultWidgets]} />

To use the plugin for a specific json-schema use "format": "json:

{
  "type": "object",
  "format": "json",
  "properties": {}
}

Or use the inline option to trigger the editor by widget: "json":

import { Widget } from "@sagold/react-json-editor";

<Widget node={node} editor={editor} options={{ widget: "json" }} />

For information on widgets see @sagold/react-json-editor#widgets

Widget Options

You can configure your editor within your json-schema using the options property. JsonWidget supports all defaultOptions where approriate. What follows is a list of additionally supported options by JsonWidget:

liveUpdate: boolean

With "liveUpdate": true JsonWidget will commit every changed character back to the editor. Default behaviour is to send data in blur, which can also be set explicetly by "liveUpdate": false, e.g.

{
  "type": "array",
  "format": "json",
  "options": { 
    "liveUpdate": true
  }
}

height: number

Set the height of the code editor to a specific value

indentWithTab: boolean

Set to true, if the editor should indent using tabs instead of spaces

minHeight: number

Set the minimum height of the code editor to a specific value

maxHeight: number

Set the maximum height of the code editor to a specific value

schema: JSONSchema

JsonWidget exclusive json-schema for a json type string which consists of stringified json-data. Pass either a valid json-schema or a reference to your local schema, e.g.

{
  "type": "string",
  "format": "json",
  "default": "{}",
  "options": { 
    "schema": { "$ref": "#/$defs/inline-json" } 
  },
  "$defs": {
    "inline-json": {
      "type": "object"
    }
  }
}

setup: ReactCodeMirrorProps['basicSetup']

JsonWidget passes all basicSetup options to react-codemirror, e.g.

{
  "type": "object",
  "format": "json",
  "options": { 
    "setup": {
      "lineNumbers": false,
      "highlightActiveLineGutter": true,
      "closeBrackets": true,
      "autocompletion": false
    }
  }
}

For more details see the props documentation of @uiw/react-codemirror.

theme: "light" | "dark"

Renders the editor in a light or dark theme, where light is the default.

Custom Code Widgets

Code widgets have to be created manually for your specific languages. For this, a createCodeWidget helper is exposed.

• extensions documentation: https://github.com/uiwjs/react-codemirror#support-language

create a custom code widget

import { JsonForm, defaultWidgets } from "@sagold/react-json-editor";
import { createCodeWidgetPlugin } from "@sagold/rje-code-widgets";
import { linter, lintGutter } from '@codemirror/lint';
import { css } from "@codemirror/lang-css";

const CssCodeWidgetPlugin = createCodeWidgetPlugin({
  extensions: [css(), lintGutter()],
  format: "css"
});

function Form(schema, data) {
  return <JsonForm
    schema={schema}
    data={data} 
    widgets={[CssCodeWidgetPlugin, ...defaultWidgets]}
  />;
}