README.md

Wysia

A WYSIWYG for textarea to work with Rails 3 FormBuilders

This Gem uses

• WYSIHTML5 <- this actually does all the hard work
• Font Awesome <- used for scaling icons wich are AWESOME

Installation

In your Gemfile, add the following dependencies:

From rubygems

gem 'wysia'

Or use the last version

gem 'wysia', :git => 'https://github.com/jhny/wysia.git'

Run:

$ bundle install

Usage

Include the Javascript (wysihtm5) into your application.js:

//= require wysia.js

Include de css into your applications.css

@import "wysia.scss";

In your forms use the wysia_text_area helper

default usage

= form_for @user do |f|
  = f.wysia_text_area :about

Configuration

Available options:

• All the usual options for a text_area can be used.
• size: normal, small or mini. Affects the button size of the toolbar. normal is default.
• js: inline or yield. Yields the javascript to a block called :javascript or its placed inline. inline is default.

using the options:

= f.wysia_text_area :about, {:class => "shaded comment grey remark", :rows => 3, :id => "about_#{@user.id}_remark", :size => "small"}

1. If you use js: "yield" as option, the javascript is yielded to a block called :javascript. In your layout or view use:

yield :javascript

2. If you have multiple wysia_text_area elements in a single page, you need to provide a ID to the options to make sure they are distinguisable for the javascript.

Contribute

Edit gem

Instead of pointing to the git repo, point to the local source #gem 'wysia', :path => "/home/user/src/wysia"

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. When submitting a bug report, please include a [Gist][] that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.

Additional information

Authors

• Johnny Eradus (https://github.com/jhny)
• Benjamin Udink ten Cate (https://github.com/hezus)