StardewValley
/
jsoneditor
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed embedded version of jsoneditor ace theme not being loaded in minimalist version. Added docs and example on loading a custom Ace editor (see #55)

This commit is contained in:
jos 2017-01-03 20:23:03 +01:00
parent 4bc339f6fe
commit 8dc4752872
6 changed files with 89 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
HISTORY.md
View File

@ -3,6 +3,13 @@
https://github.com/josdejong/jsoneditor https://github.com/josdejong/jsoneditor
## (not yet released), version 5.5.11
- Fixed embedded version of jsoneditor ace theme not being loaded in
minimalist version (see #55).
- Added docs and example on how to use a custom version of Ace editor.
## 2016-11-02, version 5.5.10 ## 2016-11-02, version 5.5.10
- Fixed #85: pressing enter in an input in a form containing a JSONEditor too - Fixed #85: pressing enter in an input in a form containing a JSONEditor too

2
docs/api.md
View File

@ -35,6 +35,8 @@ Constructs a new JSONEditor.
Provide a custom version of the [Ace editor](http://ace.c9.io/) and use this instead of the version that comes embedded with JSONEditor. Only applicable when `mode` is `code`. Provide a custom version of the [Ace editor](http://ace.c9.io/) and use this instead of the version that comes embedded with JSONEditor. Only applicable when `mode` is `code`.
Note that when using the minimalist version of JSONEditor (which has Ace excluded), JSONEditor will try to load the Ace plugins `ace/mode/json` and `ace/ext/searchbox`. These plugins must be loaded beforehand or be available in the folder of the Ace editor.
- `{Object} ajv` - `{Object} ajv`
Provide a custom instance of [ajv](https://github.com/epoberezkin/ajv), the Provide a custom instance of [ajv](https://github.com/epoberezkin/ajv), the

72
examples/08_custom_ace.html Normal file
View File

@ -0,0 +1,72 @@
<!DOCTYPE HTML>
<html>
<head>
<title>JSONEditor | Custom Ace</title>
<!-- load a custom version of Ace editor -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/ace/1.2.6/ace.js"></script>
<!-- load the minimalist version of JSONEditor, which doesn't have Ace embedded -->
<link href="../dist/jsoneditor.css" rel="stylesheet" type="text/css">
<script src="../dist/jsoneditor-minimalist.js"></script>
<style type="text/css">
#jsoneditor {
width: 500px;
height: 500px;
}
body, html {
font-family: "DejaVu Sans", sans-serif;
}
p, li {
width: 500px;
font-size: 10.5pt;
}
code {
background: #f5f5f5;
}
</style>
</head>
<body>
<h1>Custom Ace editor</h1>
<p>
This example demonstrates how to load a custom version of Ace editor into JSONEditor.
</p>
<p>
By default, JSONEditor <code>code</code> mode loads the following Ace plugins:
</p>
<ul>
<li>ace/mode/json</li>
<li>ace/ext/searchbox</li>
<li>ace/theme/jsoneditor</li>
</ul>
<p>
The jsoneditor theme comes embedded with JSONEditor. The other two plugins (json and searchbox) must be available in the folder of the custom Ace editor, or already be loaded via a script tag.
</p>
<div id="jsoneditor"></div>
<script>
// create the editor
var container = document.getElementById('jsoneditor');
var options = {
modes: ['text', 'code', 'tree', 'form', 'view'],
mode: 'code',
ace: ace
};
var json = {
'array': [1, 2, 3],
'boolean': true,
'null': null,
'number': 123,
'object': {'a': 'b', 'c': 'd'},
'string': 'Hello World'
};
var editor = new JSONEditor(container, options, json);
</script>
</body>
</html>

4
gulpfile.js
View File

@ -84,7 +84,7 @@ function minify(name) {
gutil.log('Mapped ' + fileMap); gutil.log('Mapped ' + fileMap);
} }
// make dist and dist/img folders // make dist folder structure
gulp.task('mkdir', function () { gulp.task('mkdir', function () {
mkdirp.sync(DIST); mkdirp.sync(DIST);
mkdirp.sync(DIST + '/img'); mkdirp.sync(DIST + '/img');
@ -144,7 +144,7 @@ gulp.task('bundle-css', ['mkdir'], function () {
// create a folder img and copy the icons // create a folder img and copy the icons
gulp.task('copy-img', ['mkdir'], function () { gulp.task('copy-img', ['mkdir'], function () {
gulp.src(IMAGE) gulp.src(IMAGE)
.pipe(gulp.dest(DIST +'/img')); .pipe(gulp.dest(DIST + '/img'));
gutil.log('Copied images'); gutil.log('Copied images');
}); });

1
src/js/ace/index.js
View File

@ -4,6 +4,5 @@ var ace = require('brace');
// load required ace modules // load required ace modules
require('brace/mode/json'); require('brace/mode/json');
require('brace/ext/searchbox'); require('brace/ext/searchbox');
require('./theme-jsoneditor');
module.exports = ace; module.exports = ace;

7
src/js/textmode.js
View File

@ -16,6 +16,8 @@ var textmode = {};
var MAX_ERRORS = 3; // maximum number of displayed errors at the bottom var MAX_ERRORS = 3; // maximum number of displayed errors at the bottom
var DEFAULT_THEME = 'ace/theme/jsoneditor';
/** /**
* Create a text editor * Create a text editor
* @param {Element} container * @param {Element} container
@ -63,7 +65,10 @@ textmode.create = function (container, options) {
} }
// determine theme // determine theme
this.theme = options.theme || 'ace/theme/jsoneditor'; this.theme = options.theme || DEFAULT_THEME;
if (this.theme === DEFAULT_THEME) {
require('./ace/theme-jsoneditor');
}
var me = this; var me = this;
this.container = container; this.container = container;