document that hints are disabled by default

This commit is contained in:
Brian Alexander 2012-11-04 14:16:49 -07:00
parent 93e34e8dc8
commit ff5435c645
2 changed files with 6 additions and 0 deletions

View File

@ -53,6 +53,8 @@ To generate wrappers that are compatible with [Zurb Foundation 3](http://foundat
`rails generate simple_form:install --foundation`
Please note that the Foundation wrapper does not support the `:hint` option by default. In order to enable hints, please uncomment the appropriate line in `config/initializers/simple_form_foundation.rb`. You will need to provide your own CSS styles for hints.
Please see the [instructions on how to install Foundation in a Rails app](http://foundation.zurb.com/docs/rails.php).
## Usage

View File

@ -9,6 +9,10 @@ SimpleForm.setup do |config|
b.optional :readonly
b.use :label_input
b.use :error, :wrap_with => { :tag => :small }
# Uncomment the following line to enable hints. The line is commented out by default since Foundation
# does't provide styles for hints. You will need to provide your own CSS styles for hints.
# b.use :hint, :wrap_with => { :tag => :span, :class => :hint }
end
# CSS class to add for error notification helper.