WIP: styling forms

Gemfile

@@ -30,6 +30,7 @@ gem 'rollbar'
 gem 'rss'
 gem 'rubyzip', '~> 2.3'
 gem 'sidekiq'
+gem 'simple_form'
 gem 'sprockets-rails'
 gem 'stimulus-rails'
 gem 'stripe', '~> 10.5'

Gemfile.lock

@@ -363,6 +363,9 @@ GEM
       connection_pool (>= 2.3.0)
       rack (>= 2.2.4)
       redis-client (>= 0.19.0)
+    simple_form (5.3.1)
+      actionpack (>= 5.2)
+      activemodel (>= 5.2)
     sprockets (4.2.0)
       concurrent-ruby (~> 1.0)
       rack (>= 2.2.4, < 4)
@@ -456,6 +459,7 @@ DEPENDENCIES
   rubyzip (~> 2.3)
   selenium-webdriver
   sidekiq
+  simple_form
   sprockets-rails
   stimulus-rails
   stripe (~> 10.5)

app/assets/stylesheets/css/components/form.css

@@ -0,0 +1,42 @@
+.jam-form-group {
+  --space: var(--s-1);
+}
+
+.simple_form .input {
+  --space: var(--s-2);
+  margin-block-end: var(--s1);
+}
+
+.simple_form .field_with_errors input {
+  outline: 0;
+  border: 1px solid var(--colour-red-jam-500);
+}
+
+.simple_form .error {
+  color: var(--colour-red-jam-500);
+}
+
+.simple_form label {
+  font-size: var(--font-size-m);
+  font-weight: 600;
+}
+
+input {
+  padding: var(--s-2);
+  border: 1px solid var(--colour-slate-300);
+}
+
+input:focus {
+  outline: 0;
+  border: 1px solid var(--colour-slate-600);
+}
+
+input[type=submit] {
+  border: none;
+  color: var(--colour-white);
+  background-color: var(--colour-red-jam-500);
+}
+
+input[type=submit]:hover {
+  background-color: var(--colour-link-hover);
+}

app/views/artists/_form.html.erb

@@ -1,20 +1,14 @@
-<%= form_with(model: artist, class: "contents", builder: TailwindFormBuilder) do |form| %>
-  <%= render('shared/errors', model: artist) %>
-  <%= form.text_field :name, class: 'w-full mb-3' %>
-  <%= form.text_field :location, class: 'w-full mb-3' %>
-  <%= form.text_field :description, class: 'w-full mb-3' %>
-  <% if form.object.profile_picture.attached? %>
-    <%= form.label :profile_picture, "Profile picture (#{form.object.profile_picture.filename})" %>
-  <% else %>
-    <%= form.label :profile_picture, "Profile picture" %>
-  <% end %>
-  <%= form.file_field :profile_picture, class: 'mb-3 block border border-slate-200 mb-6 file:mr-3 file:px-3 file:py-3 w-full file:border-0 file:bg-amber-600 hover:file:bg-amber-500 file:text-white' %>
+<%= simple_form_for(artist) do |form| %>
+  <%= form.input :name %>
+  <%= form.input :location %>
+  <%= form.input :description %>
+  <%= form.input :profile_picture %>
 
-  <p class="mb-3">By creating an artist profile on jam.coop and
+  <p>By creating an artist profile on jam.coop and
     uploading your music you confirm you have read and agree to our
     <%= text_link_to "Terms of use", terms_path %>. In particular you
     must own the rights to, or have permission from the rights-holder
     for any music or other content you upload.</p>
 
-  <%= form.submit "Save", class: 'mt-3 w-full'%>
+  <%= form.button :submit %>
 <% end %>

config/initializers/simple_form.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+#
+# Uncomment this and change the path if necessary to include your own
+# components.
+# See https://github.com/heartcombo/simple_form#custom-components to know
+# more about custom components.
+# Dir[Rails.root.join('lib/components/**/*.rb')].each { |f| require f }
+#
+# Use this setup block to configure all options available in SimpleForm.
+SimpleForm.setup do |config|
+  # Wrappers are used by the form builder to generate a
+  # complete input. You can remove any component from the
+  # wrapper, change the order or even add your own to the
+  # stack. The options given below are used to wrap the
+  # whole input.
+  config.wrappers :default,
+                  class: %i[input stack],
+                  hint_class: :field_with_hint,
+                  error_class: :field_with_errors,
+                  valid_class: :field_without_errors do |b|
+    ## Extensions enabled by default
+    # Any of these extensions can be disabled for a
+    # given input by passing: `f.input EXTENSION_NAME => false`.
+    # You can make any of these extensions optional by
+    # renaming `b.use` to `b.optional`.
+
+    # Determines whether to use HTML5 (:email, :url, ...)
+    # and required attributes
+    b.use :html5
+
+    # Calculates placeholders automatically from I18n
+    # You can also pass a string as f.input placeholder: "Placeholder"
+    b.use :placeholder
+
+    ## Optional extensions
+    # They are disabled unless you pass `f.input EXTENSION_NAME => true`
+    # to the input. If so, they will retrieve the values from the model
+    # if any exists. If you want to enable any of those
+    # extensions by default, you can change `b.optional` to `b.use`.
+
+    # Calculates maxlength from length validations for string inputs
+    # and/or database column lengths
+    b.optional :maxlength
+
+    # Calculate minlength from length validations for string inputs
+    b.optional :minlength
+
+    # Calculates pattern from format validations for string inputs
+    b.optional :pattern
+
+    # Calculates min and max from length validations for numeric inputs
+    b.optional :min_max
+
+    # Calculates readonly automatically from readonly attributes
+    b.optional :readonly
+
+    ## Inputs
+    # b.use :input, class: 'input', error_class: 'is-invalid', valid_class: 'is-valid'
+    b.use :label_input
+    b.use :hint,  wrap_with: { tag: :span, class: :hint }
+    b.use :error, wrap_with: { tag: :span, class: :error }
+
+    ## full_messages_for
+    # If you want to display the full error message for the attribute, you can
+    # use the component :full_error, like:
+    #
+    # b.use :full_error, wrap_with: { tag: :span, class: :error }
+  end
+
+  # The default wrapper to be used by the FormBuilder.
+  config.default_wrapper = :default
+
+  # Define the way to render check boxes / radio buttons with labels.
+  # Defaults to :nested for bootstrap config.
+  #   inline: input + label
+  #   nested: label > input
+  config.boolean_style = :nested
+
+  # Default class for buttons
+  config.button_class = 'btn'
+
+  # Method used to tidy up errors. Specify any Rails Array method.
+  # :first lists the first message for each field.
+  # Use :to_sentence to list all errors for each field.
+  # config.error_method = :first
+
+  # Default tag used for error notification helper.
+  config.error_notification_tag = :div
+
+  # CSS class to add for error notification helper.
+  config.error_notification_class = 'error_notification'
+
+  # Series of attempts to detect a default label method for collection.
+  # config.collection_label_methods = [ :to_label, :name, :title, :to_s ]
+
+  # Series of attempts to detect a default value method for collection.
+  # config.collection_value_methods = [ :id, :to_s ]
+
+  # You can wrap a collection of radio/check boxes in a pre-defined tag, defaulting to none.
+  # config.collection_wrapper_tag = nil
+
+  # You can define the class to use on all collection wrappers. Defaulting to none.
+  # config.collection_wrapper_class = nil
+
+  # You can wrap each item in a collection of radio/check boxes with a tag,
+  # defaulting to :span.
+  # config.item_wrapper_tag = :span
+
+  # You can define a class to use in all item wrappers. Defaulting to none.
+  # config.item_wrapper_class = nil
+
+  # How the label text should be generated altogether with the required text.
+  # config.label_text = lambda { |label, required, explicit_label| "#{required} #{label}" }
+
+  # You can define the class to use on all labels. Default is nil.
+  # config.label_class = nil
+
+  # You can define the default class to be used on forms. Can be overridden
+  # with `html: { :class }`. Defaulting to none.
+  # config.default_form_class = nil
+
+  # You can define which elements should obtain additional classes
+  # config.generate_additional_classes_for = [:wrapper, :label, :input]
+
+  # Whether attributes are required by default (or not). Default is true.
+  # config.required_by_default = true
+
+  # Tell browsers whether to use the native HTML5 validations (novalidate form option).
+  # These validations are enabled in SimpleForm's internal config but disabled by default
+  # in this configuration, which is recommended due to some quirks from different browsers.
+  # To stop SimpleForm from generating the novalidate option, enabling the HTML5 validations,
+  # change this configuration to true.
+  config.browser_validations = false
+
+  # Custom mappings for input types. This should be a hash containing a regexp
+  # to match as key, and the input type that will be used when the field name
+  # matches the regexp as value.
+  # config.input_mappings = { /count/ => :integer }
+
+  # Custom wrappers for input types. This should be a hash containing an input
+  # type as key and the wrapper that will be used for all inputs with specified type.
+  # config.wrapper_mappings = { string: :prepend }
+
+  # Namespaces where SimpleForm should look for custom input classes that
+  # override default inputs.
+  # config.custom_inputs_namespaces << "CustomInputs"
+
+  # Default priority for time_zone inputs.
+  # config.time_zone_priority = nil
+
+  # Default priority for country inputs.
+  # config.country_priority = nil
+
+  # When false, do not use translations for labels.
+  # config.translate_labels = true
+
+  # Automatically discover new inputs in Rails' autoload path.
+  # config.inputs_discovery = true
+
+  # Cache SimpleForm inputs discovery
+  # config.cache_discovery = !Rails.env.development?
+
+  # Default class for inputs
+  # config.input_class = nil
+
+  # Define the default class of the input wrapper of the boolean input.
+  config.boolean_label_class = 'checkbox'
+
+  # Defines if the default input wrapper class should be included in radio
+  # collection wrappers.
+  # config.include_default_input_wrapper_class = true
+
+  # Defines which i18n scope will be used in Simple Form.
+  # config.i18n_scope = 'simple_form'
+
+  # Defines validation classes to the input_field. By default it's nil.
+  # config.input_field_valid_class = 'is-valid'
+  # config.input_field_error_class = 'is-invalid'
+end

config/locales/simple_form.en.yml

@@ -0,0 +1,31 @@
+en:
+  simple_form:
+    "yes": 'Yes'
+    "no": 'No'
+    required:
+      text: 'required'
+      mark: '*'
+      # You can uncomment the line below if you need to overwrite the whole required html.
+      # When using html, text and mark won't be used.
+      # html: '<abbr title="required">*</abbr>'
+    error_notification:
+      default_message: "Please review the problems below:"
+    # Examples
+    # labels:
+    #   defaults:
+    #     password: 'Password'
+    #   user:
+    #     new:
+    #       email: 'E-mail to sign in.'
+    #     edit:
+    #       email: 'E-mail.'
+    # hints:
+    #   defaults:
+    #     username: 'User name to sign in.'
+    #     password: 'No special characters, please.'
+    # include_blanks:
+    #   defaults:
+    #     age: 'Rather not say'
+    # prompts:
+    #   defaults:
+    #     age: 'Select your age'

test/components/previews/form_preview.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class FormPreview < Lookbook::Preview
+  def default
+    artist = Artist.create(location: 'London')
+    render template: 'templates/example_form', locals: { artist: }
+  end
+end

test/components/previews/templates/example_form.html.erb

@@ -0,0 +1,5 @@
+<%= simple_form_for(artist) do |form| %>
+  <%= form.input :name %>
+  <%= form.input :location %>
+  <%= form.button :submit %>
+<% end %>