https://github.com/burakson/fseditor

jQuery Fullscreen Editor
https://github.com/burakson/fseditor

Last synced: 12 days ago
JSON representation

jQuery Fullscreen Editor

• Host: GitHub
• URL: https://github.com/burakson/fseditor
• Owner: burakson
• License: mit
• Created: 2013-08-26T21:14:55.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2013-09-29T10:32:34.000Z (about 11 years ago)
• Last Synced: 2024-08-01T22:53:59.151Z (3 months ago)
• Language: JavaScript
• Size: 393 KB
• Stars: 178
• Watchers: 11
• Forks: 26
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
jQuery Fullscreen Editor

=========

A lightweight jQuery plugin that prettifies and transforms text fields into fullscreen text editors with two different transition options.

Demo

------------

 * [Click here to see the demo and documentation page](http://burakson.github.io/fseditor)

Installation

------------

Add jQuery (1.7 or above), [jquery.fseditor.min.js] and [fseditor.css] to your project.

Basic usage

-----------

Simply initialize the plugin with the selector of your textfield.

```javascript

$(".mytextarea").fseditor();

```

Options

----------

The following is a list of available options. The values are their defaults within the plugin.

```javascript

$(".mytextarea").fseditor({

  overlay: true,

  expandOnFocus: false,

  transition: '', // 'fade', 'slide-in',

  placeholder: '',

  maxWidth: '', // maximum width of the editor on fullscreen mode

  maxHeight: '', // maximum height of the editor on fullscreen mode,

  onExpand: function() {}, // on switch to fullscreen mode callback

  onMinimize: function() {} // on switch to inline mode callback

});

```

Public Methods

---------

Following methods will help you to call function inside the plugin.

**expand()** : Triggers fullscreen mode

**minimize()** : Minimize the editor (inline mode)

**destroy()** : Removes the plugin completely and brings the native textfield back.

Example usage:

```javascript

$(".mytextarea").fseditor('expand');

```

What's next?

---------

 * Semi-rich WYSIWYG functionality

 * Syntax highlighting

Acknowledgements

----------------

© 2013, Burak Son. Released under the [MIT License](http://opensource.org/licenses/mit-license.php).

 * [Github](http://github.com/burakson) (@burakson)

 * [Twitter](http://twitter.com/burakson) (@burakson)