Skip to content

Flatpickr's plugin that provides users an alternative way to interact with the datetime picker.

License

Notifications You must be signed in to change notification settings

jcsmorais/shortcut-buttons-flatpickr

Repository files navigation

Shortcut buttons

CircleCI Coverage Status npm version flatpickr License

Shortcut buttons is a plugin for flatpickr that provides users an alternative way to interact with the datetime picker.

material_blue material_green confetti material_red light dark

Motivation

Shortcut buttons development has been motivated by the need of having a fast, flexible and seemless alternative way for users to select specific date(s) without being forced to navigate through their calendars and individually select those date(s).

Installation

Installing as a module:

yarn add shortcut-buttons-flatpickr

Installing on non-module environments:

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/themes/light.min.css">
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/shortcut-buttons-flatpickr.min.js"></script>

API

Params Type Description
button Object, Object[] Button(s).
[button.attributes] Object Button's attributes.
Supported attributes: accesskey, aria-label, class and tabindex.
button.label string Button's label.
[label] string Label including a word/sentence stating that the user can use the calendar or one of the buttons.
onClick Function, Function[] Callback(s) invoked when plugin's buttons are clicked. Each callback is fed with two parameters:
index - the index of the clicked button.
fp - flatpickr's instance.
[theme] string Flatpickr's theme, defaults to light if none supplied.

Usage Examples

About

Flatpickr's plugin that provides users an alternative way to interact with the datetime picker.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 6