|
| 1 | +# Use this setup block to configure all options available in SimpleForm. |
| 2 | +SimpleForm.setup do |config| |
| 3 | + # Wrappers are used by the form builder to generate a |
| 4 | + # complete input. You can remove any component from the |
| 5 | + # wrapper, change the order or even add your own to the |
| 6 | + # stack. The options given below are used to wrap the |
| 7 | + # whole input. |
| 8 | + config.wrappers :default, class: :input, |
| 9 | + hint_class: :field_with_hint, error_class: :field_with_errors do |b| |
| 10 | + ## Extensions enabled by default |
| 11 | + # Any of these extensions can be disabled for a |
| 12 | + # given input by passing: `f.input EXTENSION_NAME => false`. |
| 13 | + # You can make any of these extensions optional by |
| 14 | + # renaming `b.use` to `b.optional`. |
| 15 | + |
| 16 | + # Determines whether to use HTML5 (:email, :url, ...) |
| 17 | + # and required attributes |
| 18 | + b.use :html5 |
| 19 | + |
| 20 | + # Calculates placeholders automatically from I18n |
| 21 | + # You can also pass a string as f.input placeholder: "Placeholder" |
| 22 | + b.use :placeholder |
| 23 | + |
| 24 | + ## Optional extensions |
| 25 | + # They are disabled unless you pass `f.input EXTENSION_NAME => true` |
| 26 | + # to the input. If so, they will retrieve the values from the model |
| 27 | + # if any exists. If you want to enable any of those |
| 28 | + # extensions by default, you can change `b.optional` to `b.use`. |
| 29 | + |
| 30 | + # Calculates maxlength from length validations for string inputs |
| 31 | + b.optional :maxlength |
| 32 | + |
| 33 | + # Calculates pattern from format validations for string inputs |
| 34 | + b.optional :pattern |
| 35 | + |
| 36 | + # Calculates min and max from length validations for numeric inputs |
| 37 | + b.optional :min_max |
| 38 | + |
| 39 | + # Calculates readonly automatically from readonly attributes |
| 40 | + b.optional :readonly |
| 41 | + |
| 42 | + ## Inputs |
| 43 | + b.use :label_input |
| 44 | + b.use :hint, wrap_with: { tag: :span, class: :hint } |
| 45 | + b.use :error, wrap_with: { tag: :span, class: :error } |
| 46 | + |
| 47 | + ## full_messages_for |
| 48 | + # If you want to display the full error message for the attribute, you can |
| 49 | + # use the component :full_error, like: |
| 50 | + # |
| 51 | + # b.use :full_error, wrap_with: { tag: :span, class: :error } |
| 52 | + end |
| 53 | + |
| 54 | + # The default wrapper to be used by the FormBuilder. |
| 55 | + config.default_wrapper = :default |
| 56 | + |
| 57 | + # Define the way to render check boxes / radio buttons with labels. |
| 58 | + # Defaults to :nested for bootstrap config. |
| 59 | + # inline: input + label |
| 60 | + # nested: label > input |
| 61 | + config.boolean_style = :nested |
| 62 | + |
| 63 | + # Default class for buttons |
| 64 | + config.button_class = 'btn' |
| 65 | + |
| 66 | + # Method used to tidy up errors. Specify any Rails Array method. |
| 67 | + # :first lists the first message for each field. |
| 68 | + # Use :to_sentence to list all errors for each field. |
| 69 | + # config.error_method = :first |
| 70 | + |
| 71 | + # Default tag used for error notification helper. |
| 72 | + config.error_notification_tag = :div |
| 73 | + |
| 74 | + # CSS class to add for error notification helper. |
| 75 | + config.error_notification_class = 'error_notification' |
| 76 | + |
| 77 | + # ID to add for error notification helper. |
| 78 | + # config.error_notification_id = nil |
| 79 | + |
| 80 | + # Series of attempts to detect a default label method for collection. |
| 81 | + # config.collection_label_methods = [ :to_label, :name, :title, :to_s ] |
| 82 | + |
| 83 | + # Series of attempts to detect a default value method for collection. |
| 84 | + # config.collection_value_methods = [ :id, :to_s ] |
| 85 | + |
| 86 | + # You can wrap a collection of radio/check boxes in a pre-defined tag, defaulting to none. |
| 87 | + # config.collection_wrapper_tag = nil |
| 88 | + |
| 89 | + # You can define the class to use on all collection wrappers. Defaulting to none. |
| 90 | + # config.collection_wrapper_class = nil |
| 91 | + |
| 92 | + # You can wrap each item in a collection of radio/check boxes with a tag, |
| 93 | + # defaulting to :span. |
| 94 | + # config.item_wrapper_tag = :span |
| 95 | + |
| 96 | + # You can define a class to use in all item wrappers. Defaulting to none. |
| 97 | + # config.item_wrapper_class = nil |
| 98 | + |
| 99 | + # How the label text should be generated altogether with the required text. |
| 100 | + # config.label_text = lambda { |label, required, explicit_label| "#{required} #{label}" } |
| 101 | + |
| 102 | + # You can define the class to use on all labels. Default is nil. |
| 103 | + # config.label_class = nil |
| 104 | + |
| 105 | + # You can define the default class to be used on forms. Can be overriden |
| 106 | + # with `html: { :class }`. Defaulting to none. |
| 107 | + # config.default_form_class = nil |
| 108 | + |
| 109 | + # You can define which elements should obtain additional classes |
| 110 | + # config.generate_additional_classes_for = [:wrapper, :label, :input] |
| 111 | + |
| 112 | + # Whether attributes are required by default (or not). Default is true. |
| 113 | + # config.required_by_default = true |
| 114 | + |
| 115 | + # Tell browsers whether to use the native HTML5 validations (novalidate form option). |
| 116 | + # These validations are enabled in SimpleForm's internal config but disabled by default |
| 117 | + # in this configuration, which is recommended due to some quirks from different browsers. |
| 118 | + # To stop SimpleForm from generating the novalidate option, enabling the HTML5 validations, |
| 119 | + # change this configuration to true. |
| 120 | + config.browser_validations = false |
| 121 | + |
| 122 | + # Collection of methods to detect if a file type was given. |
| 123 | + # config.file_methods = [ :mounted_as, :file?, :public_filename ] |
| 124 | + |
| 125 | + # Custom mappings for input types. This should be a hash containing a regexp |
| 126 | + # to match as key, and the input type that will be used when the field name |
| 127 | + # matches the regexp as value. |
| 128 | + # config.input_mappings = { /count/ => :integer } |
| 129 | + |
| 130 | + # Custom wrappers for input types. This should be a hash containing an input |
| 131 | + # type as key and the wrapper that will be used for all inputs with specified type. |
| 132 | + # config.wrapper_mappings = { string: :prepend } |
| 133 | + |
| 134 | + # Namespaces where SimpleForm should look for custom input classes that |
| 135 | + # override default inputs. |
| 136 | + # config.custom_inputs_namespaces << "CustomInputs" |
| 137 | + |
| 138 | + # Default priority for time_zone inputs. |
| 139 | + # config.time_zone_priority = nil |
| 140 | + |
| 141 | + # Default priority for country inputs. |
| 142 | + # config.country_priority = nil |
| 143 | + |
| 144 | + # When false, do not use translations for labels. |
| 145 | + # config.translate_labels = true |
| 146 | + |
| 147 | + # Automatically discover new inputs in Rails' autoload path. |
| 148 | + # config.inputs_discovery = true |
| 149 | + |
| 150 | + # Cache SimpleForm inputs discovery |
| 151 | + # config.cache_discovery = !Rails.env.development? |
| 152 | + |
| 153 | + # Default class for inputs |
| 154 | + # config.input_class = nil |
| 155 | + |
| 156 | + # Define the default class of the input wrapper of the boolean input. |
| 157 | + config.boolean_label_class = 'checkbox' |
| 158 | + |
| 159 | + # Defines if the default input wrapper class should be included in radio |
| 160 | + # collection wrappers. |
| 161 | + # config.include_default_input_wrapper_class = true |
| 162 | + |
| 163 | + # Defines which i18n scope will be used in Simple Form. |
| 164 | + # config.i18n_scope = 'simple_form' |
| 165 | +end |
0 commit comments