Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Yii extension which adds WYMeditor plugin.
JavaScript PHP
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
assets
EWYMeditor.php
README.markdown

README.markdown

EWYMeditor

EWYMeditor is an extension for Yii framework. This extension is a wrapper for WYMeditor which is a web-based WYSIWYM (What You See Is What You Mean) XHTML editor (not WYSIWYG).

Requirements

  • Yii 1.1 or above (tested on 1.1.8)
  • jQuery
  • jQuery UI (for resizable plugin)

Installation

Move EWYMeditor folder in your applications extensions folder (default: protected/extensions).

Using extension

There are three ways to use this extension.

Least obstructive (great if you want to test this extension, you don't want change your view file or you have more than one input to apply this extension to) way is:

<?php $this->widget( 'ext.EWYMeditor.EWYMeditor', array(
  'target' => 'textarea',
)); ?>

Or you can use a model to create textarea:

<?php $this->widget( 'ext.EWYMeditor.EWYMeditor', array(
  'model' => $model, // Your model
  'attribute' => 'description', // Attribute for textarea
)); ?>

Or if you want to add textarea without model:

<?php $this->widget( 'ext.EWYMeditor.EWYMeditor', array(
  'name' => 'nameOfYourInput',
)); ?>

You will also need to add wymupdate class to your submit button or change the update selector. Update selector can be changed by providing updateSelector and updateEvent parameters to options array. For example you can create a submit button like this:

<?php echo CHtml::submitButton($model->isNewRecord ? 'Submit' : 'Save', array('class' => 'wymupdate')); ?>

Configuration

You can change some default settings:

<?php $this->widget( 'ext.EWYMeditor.EWYMeditor', array(
  'target' => 'textarea',
  'plugins' => array( 'fullscreen', 'hovertools', 'tidy', 'resizable' ),
  'options' => array(
    'skin' => 'silver',
    // Check http://trac.wymeditor.org/trac/wiki/0.5/Customization for available options
  ),
)); ?>
  • target is jQuery selector for which elements to apply WYMeditor.
  • plugins a list of plugins to add to WYMeditor. Allowed options: fullscreen, hovertools, tidy, resizable. You can provided an array or comma delimited string (requires additional processing to convert to an array) for plugins parameter. If you use plugins and provide your own postInit through options, you will need to initialize plugins yourself.
  • options sets the options for WYMeditor. All available options can be found on WYMeditor customization.

Resources

Notes

  • Extension uses a modified JavaScript file which replaces the window popups with inline popups. If you want to use the original WYMeditor you will need to provide jQuery and other paths through options (not tested).
Something went wrong with that request. Please try again.