ACE Editor as ExtJS Component

Status: alpha

This project packages the ACE Editor as an ExtJS component.

The PINF JavaScript Loader is used to provide a development environment and package releases for this project.

NOTE: It is assumed you have the PINF JavaScript Loader mapped to the commonjs command and are using the node platform by default as explained here.

Demo

commonjs -v https://github.com/cadorn/ace-extjs

Development

git clone git://github.com/cadorn/ace-extjs.git
cd ace-extjs
commonjs -v ./

TODO

Toolbar for editor component
Footer for editor component (line wrapping, caret position, read only, charset, ...)
Persist editor styling to survive reload
Better API Docs
ACE Command-line support
Fix ACE worker logic (see: https://github.com/pinf/loader-js/tree/master/demos/ACE)

Production

When using this component in production a build containing static files only should be used.

Assuming Development setup (see above).

commonjs --script build ./

This will bundle the component and store static files in ./build/.

To use on a page:

// TODO: Include ExtJS CSS and JS files
<script type="text/javascript">
    bravojs = {
        url: window.location.protocol + "//" + window.location.host + "/.../extjs3-ace/Component.js"
    };
    document.write('<script type="text/javascript" src="' + bravojs.url + '"><' + '/script>');
</script>

NOTE: The bravojs.url must be set to the same URL as used for the SCRIPT tag.

See ./www/extjs3-ace/index.html for example.

API

See implementation: ./packages/extjs3-ace/lib/component.js

Usage example: ./www/extjs3-ace/index.html

Support & Feedback

Please use github features for now.

Contribute

Collaboration Platform: https://github.com/cadorn/ace-extjs/

Collaboration Process:

Send message to discuss your change
Write a patch on your own
Send pull request on github
Discuss pull request on github to refine

You must explicitly license your patch by adding the following to the top of any file you modify in order for your patch to be accepted:

//  - <GithubUsername>, First Last <Email>, Copyright YYYY, MIT License

Author

This project is maintained by Christoph Dorn.

Credits

This project would not be possible without the following:

Documentation License

Creative Commons Attribution-NonCommercial-ShareAlike 3.0

Code License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

ceka39/ace-extjs