simple_form.rb revision 25f979bdee494bf6a6aeb54d753352832212dd24
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger# Use this setup block to configure all options available in SimpleForm.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # Wrappers are used by the form builder to generate a
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # complete input. You can remove any component from the
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # wrapper, change the order or even add your own to the
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # stack. The options given below are used to wrap the
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # whole input.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger config.wrappers :default, :class => :input,
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger :hint_class => :field_with_hint, :error_class => :field_with_errors do |b|
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger ## Extensions enabled by default
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # Any of these extensions can be disabled for a
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # given input by passing: `f.input EXTENSION_NAME => false`.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # You can make any of these extensions optional by
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # renaming `b.use` to `b.optional`.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # Determines whether to use HTML5 (:email, :url, ...)
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # and required attributes
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # Calculates placeholders automatically from I18n
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # You can also pass a string as f.input :placeholder => "Placeholder"
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger ## Optional extensions
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # They are disabled unless you pass `f.input EXTENSION_NAME => :lookup`
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # to the input. If so, they will retrieve the values from the model
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # if any exists. If you want to enable the lookup for any of those
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # extensions by default, you can change `b.optional` to `b.use`.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # Calculates maxlength from length validations for string inputs
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # Calculates pattern from format validations for string inputs
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # Calculates min and max from length validations for numeric inputs
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # Calculates readonly automatically from readonly attributes
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger b.use :hint, :wrap_with => { :tag => :span, :class => :hint }
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger b.use :error, :wrap_with => { :tag => :span, :class => :error }
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # The default wrapper to be used by the FormBuilder.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # Define the way to render check boxes / radio buttons with labels.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # Defaults to :nested for bootstrap config.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # Method used to tidy up errors. Specify any Rails Array method.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # :first lists the first message for each field.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # Use :to_sentence to list all errors for each field.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # Default tag used for error notification helper.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # CSS class to add for error notification helper.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger config.error_notification_class = 'alert alert-error'
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # ID to add for error notification helper.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # Series of attempts to detect a default label method for collection.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # config.collection_label_methods = [ :to_label, :name, :title, :to_s ]
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # Series of attempts to detect a default value method for collection.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # config.collection_value_methods = [ :id, :to_s ]
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # You can wrap a collection of radio/check boxes in a pre-defined tag, defaulting to none.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # You can define the class to use on all collection wrappers. Defaulting to none.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # You can wrap each item in a collection of radio/check boxes with a tag,
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # defaulting to :span. Please note that when using :boolean_style = :nested,
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # SimpleForm will force this option to be a label.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # You can define a class to use in all item wrappers. Defaulting to none.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # How the label text should be generated altogether with the required text.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # config.label_text = lambda { |label, required| "#{required} #{label}" }
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # You can define the class to use on all labels. Default is nil.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger config.label_class = 'col-lg-2 control-label'
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # You can define the class to use on all forms. Default is simple_form.
24e0ce1d4adb31179cda93fa612c3df8268bf63bhenning mueller config.form_class = 'simple_form form-horizontal'
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # You can define which elements should obtain additional classes
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # config.generate_additional_classes_for = [:wrapper, :label, :input]
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # Whether attributes are required by default (or not). Default is true.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # Tell browsers whether to use default HTML5 validations (novalidate option).
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # Collection of methods to detect if a file type was given.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # config.file_methods = [ :mounted_as, :file?, :public_filename ]
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # Custom mappings for input types. This should be a hash containing a regexp
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # to match as key, and the input type that will be used when the field name
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # config.input_mappings = { /count/ => :integer }
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # Custom wrappers for input types. This should be a hash containing an input
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # type as key and the wrapper that will be used for all inputs with specified type.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # config.wrapper_mappings = { :string => :prepend }
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # When false, do not use translations for labels.
0d59c6dbb8feb77c3e318463d080a080f7e0d045Julian Kornberger # Automatically discover new inputs in Rails' autoload path.