flatpickr

What is flatpickr?

Flatpickr is a lightweight and powerful datetime picker library. It allows users to easily select dates, times, or date ranges with a simple and customizable interface. It is highly configurable and supports a wide range of options and plugins to enhance its functionality.

What are flatpickr's main functionalities?

Basic Date Picker

This initializes a basic date picker on an input element with the ID 'datePicker'.

const flatpickr = require('flatpickr');
flatpickr('#datePicker', {});

Date Range Picker

This sets up a date range picker, allowing users to select a start and end date.

const flatpickr = require('flatpickr');
flatpickr('#dateRangePicker', { mode: 'range' });

Time Picker

This initializes a time picker without a calendar, allowing users to select a time.

const flatpickr = require('flatpickr');
flatpickr('#timePicker', { enableTime: true, noCalendar: true, dateFormat: 'H:i' });

Custom Date Format

This sets up a date picker with a custom date format (day-month-year).

const flatpickr = require('flatpickr');
flatpickr('#customFormatPicker', { dateFormat: 'd-m-Y' });

Disabling Specific Dates

This initializes a date picker that disables specific dates, preventing users from selecting them.

const flatpickr = require('flatpickr');
flatpickr('#disableDatesPicker', { disable: ['2023-10-10', '2023-10-20'] });

Other packages similar to flatpickr

react-datepicker

React DatePicker is a simple and reusable datepicker component for React. It offers similar functionalities to flatpickr but is specifically designed for React applications. It provides a more seamless integration with React's state management and lifecycle methods.

pikaday

Pikaday is a lightweight JavaScript datepicker with no dependencies. It offers a minimalist approach to date picking and is highly customizable. Compared to flatpickr, Pikaday is more focused on simplicity and ease of use, but it may lack some of the advanced features and plugins available in flatpickr.

air-datepicker

Air Datepicker is a lightweight, customizable, and dependency-free datepicker. It provides a wide range of options and configurations similar to flatpickr. However, it may not have as extensive plugin support as flatpickr.

README

flatpickr - javascript datetime picker

Motivation

Almost every large SPA or project involves date and time input. Browser's native implementations of those are inconsistent and limited in functionality. Most other libraries require you to pull in heavy dependencies like jQuery, Bootstrap, and moment.js. I wanted something that was good-looking out of the box, dependency-free, powerful, and extensible.

Feature overview:

• Dependency-free (no bloated bundles)
• Simple, polished UX
• Date + time input
• Range selections
• Ability to select multiple dates
• Can be used as just a time picker
• Display dates in a human-friendly format
• Easily disable specific dates, date ranges, or any date using arbitrary logic
• Week numbers
• 50 locales
• 8 colorful themes (incl. dark and material)
• Numerous plugins
• Libraries available for React, Angular, Vue, Ember, and more

flatpickr provides more functionality at a fraction of the size of other libraries.

Compatibility

IE9 and up, Edge, iOS Safari 6+, Chrome 8+, Firefox 6+

Install & Use

Demos and documentation: https://flatpickr.github.io/

See also:

• React Component
• ember-flatpickr addon
• angularJS-flatpickr addon
• angular2+-flatpickr addon
• vue-flatpickr component
• Stimulus.js Controller

Supporting flatpickr

flatpickr will never change its license, pester users for donations, or engage in other user-hostile behavior.

Nevertheless, if you enjoyed working with this library or if its made your life easier, you can buy me a cup of coffee :)