Skip to content

Latest commit

 

History

History
94 lines (56 loc) · 2.46 KB

README.md

File metadata and controls

94 lines (56 loc) · 2.46 KB
Raw

FlatpickrRails

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/flatpickr_rails. To experiment with that code, run bin/console for an interactive prompt.

lightweight, powerful datetimepicker. zero dependencies

https://chmln.github.io/flatpickr

Installation

Add this line to your application's Gemfile:

gem 'flatpickr_rails'

And then execute:

$ bundle

Or install it yourself as:

$ gem install flatpickr_rails

Usage

Add this line to app/assets/stylesheets/application.css

 *= require flatpickr

To use one of the themes, add:

*= require flatpickr/material_red

Available themes are: airbnb, base16_flat, confetti, dark, material_blue, material_green, material_orange, material_red.

Add this line to app/assets/javascripts/application.js

//= require flatpickr

If you need locales, add them like this:

//= require flatpickr/l10n/es

Using flatpickr-rails

<input type="text" id="flatpickr-input">
<script type="text/javascript">
  $(document).ready(function(){
    flatpickr('#flatpickr-input');
  });
</script>

or with jQuery:

$('#flatpickr-input').flatpickr();

Examples:

https://github.com/chmln/flatpickr

There are a lot of options you can pass to flatpickr(). They are documented at https://chmln.github.io/flatpickr/

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake rspec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/flatpickr_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.