Liking cljdoc? Tell your friends :D

Clojars Project GitHub issues License

Reagent wrapper for Jos de Jong’s JSON Editor

A sophisticated Reagent wrapper around the jsoneditor library.

Quick Start

Step 1. Add Dependency

Add the following project dependency:

Clojars Project

Requires that you have reagent and re-com as dependencies of your project:

Clojars Project Clojars Project

If you use shadow-cljs, the jsoneditor npm library dependency will be pulled automatically via src/deps.cljs :npm-deps.

If you use another build system, it is not currently supported so switch to shadow-cljs.

Step 2. Add Styles

Add JSON Editor stylesheet to your index.html or equivalent; e.g.:

https://cdnjs.cloudflare.com/ajax/libs/jsoneditor/9.5.0/jsoneditor.css

Step 3. Use the Component

(ns my-app
  (:require
    [re-jsoneditor.core :refer [jsoneditor]]))
(defn panel
  []
  [jsoneditor ...])

Features

See the demo.

Outstanding Features

  • ace and ajv customisation

  • port JSON editor stylesheet to inline Garden

  • :schema and :schema-refs arguments

  • :templates argument

  • :auto-complete argument

  • :on-text-selection-change argument

  • :on-selection-change argument

  • :on-event argument

  • :on-focus argument

  • :on-blur argument

  • :color-picker? argument

  • :timestamp-tag? argument

  • :timestamp-format argument

  • :language argument

  • :languages argument

  • :modal-anchor argument

  • :popup-anchor argument

  • :sort? argument

  • :transform? argument

  • :max-visible-children argument

  • :create-query, :execute-query and :query-description arguments

  • :theme argument and auto-loading of ace themes etc.

License

The Apache License Version 2.0

Copyright © 2018-2021 Isaac Johnston

Portions based on JSON Editor Copyright © Jos de Jong under the terms of the Apache License Version 2.0

Can you improve this documentation?Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcutsReport a problemcljdoc on GitHub
× close