Giter Club home page Giter Club logo

syntactor's Introduction

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

syntactor's People

Contributors

gregoor avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

syntactor's Issues

Better Focus

Only retain focus, when it was given. Also, stop catching focus event and instead use tabindex on focusable elements.

Failed to Compile

I constantly get the following error message:

multi ./node_modules/react-scripts/config/polyfills.js ./node_modules/react-dev-utils/webpackHotDevClient.js ./src/index.js
Module not found: SyntaxD:\Git\syntactor\src\package.json (directory description file): SyntaxError: D:\Git\syntactor\src\package.json (directory description file): SyntaxError: Unexpected token . in JSON at position 0

I tried different machines with different settings. Overall I'm not quite sure what to do about it. The file package.json seems fine in my opinion. Maybe someone has a hint how to approach/solve this problem.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.