Skip to content
This repository has been archived by the owner on Dec 22, 2020. It is now read-only.
/ syntactor Public archive

A JSON editor for editing data instead of syntax.

License

Notifications You must be signed in to change notification settings

Gregoor/syntactor

Repository files navigation

Build Status

Syntactor

An editor with two basic goals:

  1. Only allow valid code to be entered (no syntax errors)
  2. Common code transformations in just as many or less keystrokes, compared to other editors

For now, it's only a JSON editor.

Usage

In your commandline:

yarn add syntactor
#or
npm install syntactor --save

In your code:

const Syntactor = require('syntactor');
Syntactor.render(document.querySelector('#container'), {
  initiallyShowKeymap: true,
  defaultValue: {answer: 42}
});

Or if you're using React (and ES2015):

import {Editor} from 'syntactor';

const SomeComponent = () => (
  <div>
    <Editor initiallyShowKeymap defaultValue={{answer: 42}}/>
  </div>
);

Props

These can be either passed as React props or as the 2nd argument into the Syntactor.render function.

Name Type Default Value
initiallyShowKeymap boolean true
defaultValue JSON {}

Contributing/Running the demo page

First clone this repo, then:

yarn

And start it with

yarn start