lombiq / orchard-json-editor

Orchard Core module for displaying a JSON Editor like on jsoneditoronline.org.

Lombiq JSON Editor for Orchard Core

About

Orchard Core module for displaying a JSON Editor like on jsoneditoronline.org. Watch a demo video of it from the Orchard Community Meeting here.

Do you want to quickly try out this project and see it in action? Check it out in our Open-Source Orchard Core Extensions full Orchard Core solution and also see our other useful Orchard Core-related open-source projects!

Documentation

JSON Editor

You can use the JSON editor either as a content field by adding a Json Field to your content type, or by invoking the "JsonEditor" shape with the below tag helper:

<json-editor 
    content="@viewModel.SomeObjectOrJToken"
    options="@viewModel.JsonEditorOptions"
    name="@Html.NameFor(model => model.SomeObjectOrJToken)"></json-editor>

or

<json-editor 
    json="@viewModel.SerializedJsonString"
    options="@viewModel.JsonEditorOptions"
    name="@Html.NameFor(model => model.SerializedJsonString)"></json-editor>

The properties are:

• Content ("content"): An object or JToken that will be serialized via Newtonsoft Json.Net.
• SerializedJson ("json"): An already serialized string that can be used as an alternative to Content. Both shouldn't be used, but in case they are, Content takes precedence.
• Options ("options"): A JsonEditorOptions object that contains configuration for the JSON editor. See the XML documentation of the JsonEditorOptions for more information.
• InputName ("name"): The HTML name of the associated hidden <input> element.

All attributes are optional. If neither content nor json is set, an empty object is taken as the content.

JSON Content Editor

The module also provides an editor for content items. This can be used to directly edit a content item as JSON data. This tool can be useful to inspect how the content item is serialized in the YesSql database without directly accessing the database or exporting the content item via deployment. It can also be used to edit properties that currently don't have an editor.

When the module is enabled, a new Edit as JSON entry is added to the actions dropdown in the admin dashboard's content item listing:

Clicking on it encodes the content item as JSON and displays it in the JSON editor:

This still requires edit permission to the content item, so the security is the same as the regular content item editor. Clicking Publish deserializes the received JSON into a ContentItem and publishes it.

Dependencies

This module has the following dependencies:

• Lombiq Helpful Libraries for Orchard Core
• Lombiq Node.js Extensions

Contributing and support

Bug reports, feature requests, comments, questions, code contributions and love letters are warmly welcome. You can send them to us via GitHub issues and pull requests. Please adhere to our open-source guidelines while doing so.

This project is developed by Lombiq Technologies. Commercial-grade support is available through Lombiq.

orchard-json-editor's Issues

json editor not building - compiling (OSOE-772)

cannot compile because of unknown class ResourceManagerContentSecurityPolicyProvider here :

Orchard-JSON-Editor/Lombiq.JsonEditor/Services/JsonEditorContentSecurityPolicyProvider.cs

Line 17 in 1bad573

public class JsonEditorContentSecurityPolicyProvider : ResourceManagerContentSecurityPolicyProvider

Jira issue

Add UI test project (OSOE-650)

...to test the basics of the module.

• Note that this necessitates moving the module project into a subfolder.
• Be sure to also publish this on NuGet.

Jira issue