When you need to incorporate a datetime picker in a Rails 5 application, you can use the
flatpickr_rails gem. It’s based around flatpickr, a project with 10,000+ stars on GitHub, requires no dependencies, and has well-documented configuration options. Not to mention a polished design and multiple themes.
Here’s how to incorporate it in your Rails 5 application:
If you haven’t already, run a migration to generate a field with the type of
datetime. Then run
flatpickr_railsto your Gemfile.
- Add this line to app/assets/stylesheets/application.css.1
*= require flatpickr
//= require flatpickr
Restart your server.
- Add your input field to the form. Change
footo the name of your input, and change
barto the ID you want to use to create flatpickr’s instance in the next step:
<%= form.label :foo %><br> <%= form.text_field :foo, id: 'bar' %> <!-- If you're retrieving a value from your controller: <%= form.text_field :foo, value: @date, id: 'bar' %> -->
- Add your JS. Change
barto your ID from Step 7.
- If you want to configure flatpickr, pass a configuration object as the second param:
- The Rails database saves in the UTC format (i.e.
2020-01-01 15:00:00 -0400), but your users would punch you in the face if you used that, so let’s make it easier to read. Let’s also apply a minimum date of
todayand a default minute/hour.2
Congratulations, you now have a working datetime picker! If you enjoyed this post, you should follow me on Twitter here.
altInputis the key to all of this magic. It tells flatpickr to create a formatted “fake” input for humans and a plain, hidden, UTC one that can be processed by your server. ↩︎