ForgeComponents
en

Components

j-CloudEditor

jComponent 20 · jcomponent@20 component Example loaded with jComponent 20
  • it works in the iframe
  • supports multiple cursors (shift + cmd + arrow-down/up)
  • supports finding selected text (cmd + d)
  • supports custom scrollbars
  • supports diff tracker
  • supports a simple emmet plugin
  • supports real-time collaboration
  • source-code: https://github.com/totaljs/editor
  • it uses editor: CodeMirror
  • very small code

Configuration:

  • parent {String} a selector for the main container (default: auto)
  • autosave {Boolean} auto rebinds value from the editor to the component's path (default: true)
  • event {String} a path to the function(name, value)
    • click
    • errors
    • shortcut
    • cursor contains cursor position
    • change contains partial changes for real-time collaboration (config.realtime must be true)
  • contextmenu {String} a path to the function(opt)
  • realtime {Boolean} enables realtime sending changes to the event method (event name is change)
  • keywords {String} custom keywords in the form e.g. ID,PATH
  • minheight {Number} optional, a minimal height (default: 0)
  • margin {Number} optional, a vertical margin (default: 0)
  • NEW: url {String} optional, a link to the editor (default: //cdn.componentator.com/editor/1.min.html)

Method:

  • component.insert('some text')
  • component.replace('text', 'newvalue')
  • component.search('text', callback(output))
  • component.select(from, [to])
  • component.goto(pos)
  • component.focus()
  • component.save(callback(value))
  • component.marker(name, [from], [to], [color]) adds + modifies (with from) and removes (without from argument) marker
  • component.change(changes) for the real-time collaboration (changes can be generated in the config.event function)
  • component.clear() clears all changes
  • component.replaceselections(selections)
  • component.replaceselection(selection)
  • component.replacerange(value, from, [to])
  • component.command(cmd) executes codemirror.execCommand() method
  • component.exec(a, [b], [c]) executes document.execCommand(a, b, c) method

IMPORTANT:

from, to, pos arguments must be in the form: { line: Number, ch: Number }.

Use it with <ui-component name="cloudeditor">. When the component is not loaded yet, jComponent downloads it on first use from the address in DEF.fallback (the Componentator CDN by default). Author: Peter Širka. Source: the Componentator components repository, MIT license.

example.html
<ui-component name="LAZY menu"></ui-component>

<div style="width:600px;height:200px;border:1px solid #E0E0E0">
	<ui-component name="cloudeditor" path="editormodel" config="contextmenu:editor_contextmenu;event:editor_event;realtime:1"></ui-component>
</div>
<br />
<div style="width:600px;height:200px;border:1px solid #E0E0E0">
	<ui-component name="cloudeditor" path="editormirrored" config="readonly:1;$id:mirrored"></ui-component>
</div>

<div class="clearfix"></div>

<script>

	var editorbody = '\n\n<h1>HELLO WORLD</h1>\n\n';
	var editormodel = { mode: 'clientside', body: editorbody, keywords: 'WORLD' };
	var editormirrored = { mode: 'clientside', body: editorbody };

	function editor_event(type, value) {
		switch (type) {
			case 'change':
				SETTER('#mirrored/change', value);
				break;
			case 'cursor':
				SETTER('#mirrored/marker', 'Peter', value.from);
				break;
		}
		SETTER('!menu/hide');
	}

	function editor_contextmenu(obj) {
		var opt = {};
		opt.x = obj.x;
		opt.y = obj.y;
		opt.items = [];
		opt.items.push({ id: '1', name: 'Test item 1' });
		opt.items.push({ id: '2', name: 'Test item 2' });
		opt.items.push({ id: '3', name: 'Test item 3' });
		opt.items.push({ id: '4', name: 'Test item 4' });
		opt.callback = function(selected) {
			console.log(selected);
		};
		SETTER('menu/show', opt);
	}

</script>