carbon-custom-elements
Version:
A Carbon Design System variant that's as easy to use as native HTML elements, with no framework tax, no framework silo.
47 lines (45 loc) • 1.56 kB
TypeScript
/**
* @license
*
* Copyright IBM Corp. 2019
*
* This source code is licensed under the Apache-2.0 license found in the
* LICENSE file in the root directory of this source tree.
*/
import { Instance as FlatpickrInstance } from 'flatpickr/dist/types/instance';
import { Plugin } from 'flatpickr/dist/types/options';
import Handle from '../../globals/internal/handle';
import BXDatePickerInput from './date-picker-input';
/**
* The configuration for the Flatpickr plugin to fix Flatpickr's behavior of certain events.
*/
export interface DatePickerFixEventsPluginConfig {
/**
* The input box to enter starting date.
*/
inputFrom: BXDatePickerInput;
/**
* The input box to enter end date.
*/
inputTo?: BXDatePickerInput;
}
/**
* `FlatpickrInstance` with additional properties used for `carbonFlatpickrFixEventsPlugin`.
*/
export interface ExtendedFlatpickrInstanceFixEventsPlugin extends FlatpickrInstance {
/**
* The handle for `keydown` event handler in the `<input>` for the starting date.
*/
_hBXCEDatePickerFixEventsPluginKeydownFrom?: Handle | null;
/**
* The handle for `keydown` event handler in the `<input>` for the end date.
*/
_hBXCEDatePickerFixEventsPluginKeydownTo?: Handle | null;
}
declare const _default: (config: DatePickerFixEventsPluginConfig) => Plugin<{}>;
/**
* @param config Plugin configuration.
* @returns A Flatpickr plugin to fix Flatpickr's behavior of certain events.
*/
export default _default;
//# sourceMappingURL=fix-events-plugin.d.ts.map