2.2.7-b1 • Published 6 years ago

@granite-elements/ace-widget v2.2.7-b1

Weekly downloads
97
License
MIT
Repository
github
Last release
6 years ago

Published on Vaadin  Directory Stars on vaadin.com/directory Published on webcomponents.org

ace-widget

Even more embeddable code editor Custom Element - just one tag, and no JS needed to provide Ace - The High Performance Code Editor

Originally based on pjako's fork of PolymerLabs ace-element.

Polymer 3.x. element The legacy Polymer 2.x version is available here

Doc and demo

https://lostinbrittany.github.io/ace-widget/

Usage example

  <ace-widget placeholder="Write something... Anything..." initial-focus>
  </ace-widget>

Install

Install the component using npm:

$ npm i @granite-elements/ace-widget --save

Once installed, import it in your application:

import '@granite-elements/ace-widget/ace-widget.js';

Running demos and tests in browser

  1. Fork the ace-widget repository and clone it locally.

  2. Make sure you have npm and the Polymer CLI installed.

  3. When in the ace-widget directory, run npm install to install dependencies.

  4. Serve the project using Polyumer CLI:

    polymer serve --npm

  5. Open the demo in the browser

Attributes

AttributeTypeDefaultDescription
themeString | Editor#setTheme at Ace API
modeString | EditSession#setMode at Ace API
font-sizeString | Editor#setFontSize at Ace API
softtabsBoolean | EditSession#setUseSoftTabs() at Ace API
tab-sizeBoolean | Session#setTabSize() at Ace API
readonlyBoolean | Editor#setReadOnly() at Ace API
wrapBoolean | Session#setWrapMode() at Ace API
autoCompleteObject | Callback for langTools.addCompleter like the example at Ace API
minlinesNumber15Editor.setOptions({minlines: minlines})
maxlinesNumber30Editor.setOptions({minlines: maxlines})
initialFocusBoolean | If true, Editor.focus() is called upon initialisation
placeholderString | A placeholder text to show when the editor is empty

Properties

NameDescription
editorAce editor object.
valueeditor.get-/setValue()

Events

NameDescription
editor-contentTriggered when editor content gets changed
editor-readyTriggered once Ace editor instance is created.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

License

MIT License