Trix
Want to include Basecamp's awesome Trix WYSIWYG editor in your Ruby on Rails application? You've come to the right place!
Please see the appropriate guide for your environment of choice:
- Ruby on Rails.
a. Ruby on Rails
trix
is easy to drop into Rails with the asset pipeline.
In your Gemfile you need to add the trix
gem.
gem 'trix'
bundle install
and restart your server to make the files available through the pipeline.
Import Trix styles in app/assets/stylesheets/application.css
:
*= require trix
Require Trix Javascript magic in app/assets/javascripts/application.js
:
//= require trix
Finally, any place where you would like to use the Trix editor in your
forms, just use the trix_editor
helper:
f.trix_editor :body
If you are using the Formtastic gem or the Simple Form gem, you can do this:
f.input :body, as: :trix_editor
Trix
For the official Trix Github repository, go here.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/maclover7/trix.
Upgrading Trix
- Copy and paste Trix's
trix.js
tovendor/assets/javascripts/trix.js
- Copy and paste Trix's
trix.css
tovendor/assets/stylesheets/trix.css
- Update
lib/trix/version.rb
with the correct version number git commit -am 'Bump to vVERSION'
bundle exec rake release
License
The gem is available as open source under the terms of the MIT License.