Skip to content

Latest commit

 

History

History
60 lines (35 loc) · 1.63 KB

README.md

File metadata and controls

60 lines (35 loc) · 1.63 KB

Build Status Greenkeeper badge

UAST Viewer

uast-viewer is the simplest way to visualize Universal Abstract Syntax Trees (UASTs).

Features

  • Drop-in component to display a UAST. Example
  • Get full control of the tree. Example
  • Integration with online source code editor Example

Documentation

See the documentation with live examples.

Installation

  1. Install UAST Viewer as a dependency

    # Yarn
    $ yarn add uast-viewer
    
    # NPM
    $ npm install uast-viewer
  2. Import uast-viewer component

    import UASTViewer from 'uast-viewer';
  3. Import styles by including default-theme.css

    import 'uast-viewer/dist/default-theme.css';
  4. Render component with UAST JSON

    <UASTViewer uast={uastJSON} />

Contribute

Contributions are more than welcome, if you are interested please take a look to our Contributing Guidelines.

Code of Conduct

All activities under source{d} projects are governed by the source{d} code of conduct.

License

Apache License Version 2.0, see LICENSE