);\r\n}\r\n\r\nexport default Editor;\r\n```\r\n\r\n\r\n## Configuration\r\nThis configuration object is accessible/changeable via YASHE.defaults and yashe.options, and you can pass these along when initializing YASHE as well. Other than the configuration we describe here, check the CodeMirror documentation for even more options you can set, such as disabling line numbers, or changing keyboard shortcut keys.\r\n\r\n```js\r\nvar yashe = YASHE(document.getElementById('domId'), {\r\n value:'Starting value of the editor',\r\n mode:'shex',\r\n theme:'wiki', //dark\r\n lineNumbers: true,\r\n lineWrapping: true,\r\n fontSize: 14, \r\n cursorHeight:15,\r\n firstLineNumber:1,\r\n readOnly:false,\r\n showCursorWhenSelecting:fasle,\r\n tabMode: 'indent',\r\n collapsePrefixesOnLoad: false,\r\n matchBrackets: true,\r\n fixedGutter: true,\r\n syntaxErrorCheck: true,\r\n showTooltip: true,\r\n showUploadButton: true,\r\n showDownloadButton: true,\r\n showCopyButton: true,\r\n showDeleteButton: true,\r\n showThemeButton: true,\r\n showFullScreenButton: true,\r\n persistent: null,\r\n extraKeys: {\r\n \"Ctrl-Space\": YASHE.autoComplete,\r\n \"Cmd-Space\": YASHE.autoComplete,\r\n \"Ctrl-D\": YASHE.deleteLine,\r\n \"Cmd-K\": YASHE.deleteLine,\r\n \"Ctrl-/\": YASHE.commentLines,\r\n \"Cmd-/\": YASHE.commentLines,\r\n \"Ctrl-Down\": YASHE.copyLineDown,\r\n \"Ctrl-Up\": YASHE.copyLineUp,\r\n \"Cmd-Down\": YASHE.copyLineDown,\r\n \"Cmd-Up\": YASHE.copyLineUp,\r\n \"Shift-Ctrl-F\": YASHE.doAutoFormat,\r\n \"Shift-Cmd-F\": YASHE.doAutoFormat,\r\n \"Ctrl-S\": YASHE.storeContent,\r\n \"Cmd-S\": YASHE.storeConten,\r\n \"Ctrl-Enter\": YASHE.executeQuery,\r\n \"Cmd-Enter\": YASHE.executeQuery,\r\n }\r\n});\r\n```\r\n## Events\r\nHere are some events provided by YASHE (check the [Codemirror Documentation](https://codemirror.net/doc/manual.html#events) for more info ):\r\n\r\n Event | Objects | Action\r\n ---------------- | ---------------------| ------------------------ \r\n change | yashe: CodeMirror, changeObj: object | Fires every time the content of the editor is changed\r\n cursorActivity | yashe: CodeMirror | Will be fired when the cursor or selection moves, or any change is made to the editor content. \r\n keyHandled | yashe: CodeMirror,name: string,event: Event | Fired after a key is handled through a key map\r\n focus | yashe: CodeMirror, event: Event | Fires whenever the editor is focused\r\n blur | yashe: CodeMirror, event: Event | Fires whenever the editor is unfocused\r\n scroll | yashe: CodeMirror | Fires whenever the editor is scrolled\r\n refresh | yashe: CodeMirror | Fires when the editor is refreshed or resized\r\n optionChange | yashe: CodeMirror, option: string | Dispatched every time an option is changed with setOption\r\n upload | yashe: CodeMirror | Fires after uploading a file by the upload button\r\n download | yashe: CodeMirror | Fires after downloading a file by the download button\r\n copy | yashe: CodeMirror | Fires after copying the editor content using the copy button \r\n themeChange | yashe: CodeMirror | Fires after changing the editor theme using the change theme button \r\n delete | yashe: CodeMirror | Fires after deleting the editor content by the delete buttton\r\n expandScreen | yashe: CodeMirror | Fires after expanding screen\r\n collapseScreen | yashe: CodeMirror | Fires after collapsing screen\r\n \r\n \r\n### Event Handlers\r\n`cm.on(type: string, func: (...args))`\r\n\r\nRegister an event handler for the given event type (a string) on the editor instance. There is also a CodeMirror.on(object, type, func) version that allows registering of events on any object.\r\n\r\n```js\r\nyashe.on('blur', function(yashe) {\r\n console.log('The editor has been unfocused!');\r\n});\r\n```\r\n\r\n`cm.off(type: string, func: (...args))`\r\n\r\nRemove an event handler on the editor instance. An equivalent CodeMirror.off(object, type, func) also exists.\r\n\r\n```js\r\nyashe.off('blur');\r\n```\r\n### Fire your own events\r\n`CodeMirror.signal(target, name, args...)`\r\n```js\r\nCodemirror.signal(yashe,'myOwnEvent'args...);\r\n```\r\n\r\n## Shortcuts provided by YASHE:\r\n \r\n Shortcut | Action\r\n ------------- | -------------\r\n Ctrl/Cmd-Space | Trigger Autocompletion\r\n Ctrl/Cmd-D | Delete current/selected line(s)\r\n Ctrl/Cmd-/ | Comment or uncomment current/selected line(s)\r\n Ctrl/Cmd-Down | Copy line down\r\n Ctrl/Cmd-Up | Copy line up\r\n Ctrl/Cmd-Shift-F | Auto-format/indent selected lines\r\n Ctrl/Cmd-S | Save current content in local storage\r\n Ctrl/Cmd-Z | Undo\r\n Ctrl/Cmd-Y | Redo\r\n F11 | Set query editor full-screen (or leave full-screen)\r\n Esc | Leave full-screen\r\n\r\n\r\n## API\r\nAPI methods accessible via the yashe instance ( check the [Codemirror Manual](https://codemirror.net/doc/manual.html#api) for more info:\r\n\r\n```js\r\n// Get query value from editor\r\nyashe.getValue() → query: String\r\n\r\n//Set query value in editor\r\nyashe.setValue(query: String)\r\n\r\n// Get the content of line n.\r\nyashe.getLine(n: integer) → string\r\n\r\n// Get the number of lines in the editor.\r\nyashe.lineCount() → integer\r\n\r\n// Get the number of first line in the editor. \r\nyashe.firstLine() → integer\r\n\r\n// Get the number of last line in the editor. \r\nyashe.lastLine() → integer\r\n\r\n// Get the currently selected code. \r\n// Optionally pass a line separator to put between the lines in the output. \r\n// When multiple selections are present, they are concatenated with instances \r\n// of lineSep in between.\r\nyashe.getSelection(?lineSep: string) → string\r\n\r\n\r\n// Replace the selection(s) with the given string. By default, the new selection \r\n// ends up after the inserted text. The optional select argument can be used to \r\n// change this—passing \"around\" will cause the new text to be selected, passing \r\n// \"start\" will collapse the selection to the start of the inserted text.\r\nyashe.replaceSelection(replacement: string, ?select: string)\r\n\r\n// Retrieve one end of the primary selection. start is an optional string indicating \r\n// which end of the selection to return. It may be \"from\", \"to\", \"head\" (the side of \r\n// the selection that moves when you press shift+arrow), or \"anchor\" (the fixed side \r\n// of the selection). Omitting the argument is the same as passing \"head\". A {line, ch} \r\n// object will be returned.\r\nyashe.getCursor(?start: string) → {line, ch}\r\n\r\n// Return true if any text is selected\r\nyashe.somethingSelected() → boolean\r\n\r\n// Set the cursor position. You can either pass a single {line, ch} object, or the line \r\n// and the character as two separate parameters. Will replace all selections with a single, \r\n// empty selection at the given position\r\nyashe.setCursor(pos: {line, ch}|number, ?ch: number, ?options: object)\r\n\r\n// Tells you whether the editor currently has focus.\r\nyashe.hasFocus() → boolean\r\n\r\n// Returns the start and end of the 'word' (the stretch of letters, whitespace, or \r\n// punctuation) at the given position.\r\nyashe.findWordAt(pos: {line, ch}) → {anchor: {line, ch}, head: {line, ch}}\r\n\r\n\r\n// Retrieves the current value of the given option for this editor instance.\r\nyashe.getOption(option: string) → any\r\n\r\n// Change the configuration of the editor. option should the name of an option, \r\n// and value should be a valid value for that option.\r\nyashe.setOption(option: string, value: any)\r\n\r\n// Retrieve the currently active document from an editor.\r\nyashe.getDoc() → Doc\r\n\r\n// Retrieve the editor associated with a document. May return null.\r\nyashe.getEditor() → CodeMirror\r\n\r\n// Undo one edit (if any undo events are stored).\r\nyashe.undo()\r\n\r\n// Redo one undone edit.\r\nyashe.redo()\r\n\r\n// Programmatically set the size of the editor (overriding the applicable CSS rules). \r\n// width and height can be either numbers (interpreted as pixels) or CSS units (e.g \"100%\"). \r\n// You can pass null for either of them to indicate that that dimension should not be changed.\r\nyashe.setSize(width: number|string, height: number|string)\r\n\r\n// Scroll the editor to a given (pixel) position. Both arguments may be left as null \r\n// or undefined to have no effect.\r\nyashe.scrollTo(x: number, y: number)\r\n\r\n// If your code does something to change the size of the editor element (window resizes \r\n// are already listened for), or unhides it, you should probably follow up by calling \r\n// this method to ensure CodeMirror is still looking as intended.\r\nyashe.refresh()\r\n\r\n//Retrieves information about the token the current mode found before the given \r\n// position (a {line, ch} object). The returned object has the following properties:\r\n// start -> The character (on the given line) at which the token starts\r\n// end -> The character at which the token ends.\r\n// string->The token's string.\r\n// type -> The token type the mode assigned to the token, such as \"keyword\" or \r\n// \"comment\" (may also be null).\r\n// state -> The mode's state at the end of this token.\r\nyashe.getTokenAt(pos: {line, ch}, ?precise: boolean) → object\r\n\r\n// Fetch defined prefixes\r\nyashe.getDefinedPrefixes() → object:\r\n\r\n// Add prefixes to the query. The prefixes are defined as \r\n// {\"rdf: \"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"}\r\nyashe.addPrefixes(prefixes: object)\r\n\r\n// Remove prefixes from query. The prefixes are defined as \r\n// {\"rdf\": \"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"}\r\nyashe.removePrefixes(prefixes: object)\r\n\r\n// Set size. Use null value to leave width or height unchanged. \r\n// To resize the editor to fit its content, see //http://codemirror.net/demo/resize.html\r\nyashe.setSize(width: Number|string, height: Number|string)\r\n\r\n// Enable an autocompleter with this name. Only makes sense if you've programatically \r\n// disabled this completer before, as a plugin is automatically enabled when registering it \r\n// (see this function)\r\nyashe.enableCompleter(completerName: String)\r\n\r\n// Disable an autocompleter with this name.\r\nyashe.disableCompleter(completerName: String)\r\n\r\n// Store bulk completions in memory as trie, and in localstorage as well (if enabled). \r\n// The argument should be a key from the //autocompletion settings\r\nyashe.storeBulkCompletions(type: String)\r\n\r\n// Collapsing prefixes if there are any. Use false to expand them.\r\nyashe.collapsePrefixes(collapse: boolean)\r\n\r\n```\r\n\r\n## Statics\r\nStatic functions YASHE\r\n```js\r\n// Register an autocompleter in YASHE. This automatically enables the completer as well\r\nYASHE.registerAutocompleter(name: String, autocompleter: function)\r\n\r\n// When typing a shape, this shape is sometimes syntactically invalid, \r\n// causing the current tokens to be incorrect.\r\n// This causes problem for autocompletion. http://bla might result in two tokens: http:// and bla. \r\n// We'll want to combine these\r\nYASHE.getCompleteToken(doc: yashe, token: Object, cursor: Object) //→ token: Object\r\n\r\n```\r\n\r\n## Developing YASHE :construction:\r\nFeel free to fork and develop this tool. You can submit your\r\ncontributions as Github pull requests. To develop *YASHE* locally:\r\n\r\n* `npm install`\r\n* `npm run dev` for local development\r\n\r\n## Used By: :link:\r\n\r\n* [ShExAuthor](https://github.com/weso/shex-author): ShEx Graphic Assistant\r\n* [RDFShape](http://rdfshape.weso.es/): RDF service for conversion and validation using ShEX and SHACL\r\n* [WikiShape](http://wikishape.weso.es/): Shape Expressions playground customized for Wikidata\r\n* [ShExML](http://shexml.herminiogarcia.com/) Playground to convert ShExML to RDF and RML offering diferent syntaxes\r\n\r\n## Forked By: :link:\r\n* [YASME](https://github.com/weso/YASME) Yet Another Shape Map Editor\r\n* [ShExML Editor](http://shexml.herminiogarcia.com/) ShExML is a language based on ShEx to map and merge heterogeneous data sources. It is designed with usability in mind trying to make the script creation easier to the user\r\n\r\n## Thanks!\r\nA big thanks goes out to:\r\n* Laurens Rietveld for his great work on the [YASQE library](https://github.com/Triply-Dev/YASGUI.YASQE-deprecated)\r\n* Maxime Lefrançois for his tips at the beginning of the project and for his work on the [YATE library](https://github.com/perfectkb/yate) in which I could be inspired\r\n\r\nA big thanks transitively goes out to:\r\n* The people behind the MediaWiki API which I use for autocompleting Wikidata entities and properties.\r\n* Marijn Haverbeke for his great work on the CodeMirror library syntax highlighting library\r\n* Richard Cyganiak for his simple but effective Prefix.cc service, which I use for autocompleting prefixes.\r\n\r\n\r\n
\r\n![\"contributors\"/](\"https://contributors-img.web.app/image?repo=weso/YASHE\")
\r\n
\r\n","readmeFilename":"README.md"}
![\"travis\"/](\"https://travis-ci.com/weso/YASHE.svg?branch=gh-pages\")
\r\n ![\"YASHE](\"https://github.com/weso/YASHE/blob/gh-pages/doc/imgs/yasheGIF.gif\")
\r\n![\"YASHE](\"https://github.com/mistermboy/YASHE/blob/gh-pages/doc/imgs/wikiGIF.gif\")
\r\n