kendo-multi-date-select
TypeScript icon, indicating that this package has built-in type declarations

2.0.13 • Public • Published

kendo-multi-date-select

npm version Build Status codecov Dependency Status devDependency Status typings included npm

Build Status

This plugin is a composition of Kendo UI MultiSelect and kendo-multi-calendar.

This widget is designed for multiple dates selection from drop-down calendar the same way as drop-down list items are selected with MultiSelect. Demo

Installation

$ npm i kendo-multi-date-select

kendo-multi-date-select(.min).js script should be included in your project along with kendo-multi-calendar(.min).js and kendo-ui-core or kendo-ui.

Usage

$("#multiDateSelect").kendoMultiDateSelect({
    // specify configuration and event handlers here
});

Reference

Configuration


autoClose

boolean (default: true)
If true calendar will be closed on date selection.

popup

Object (default: {})
Options for calendar popup initialization.

animation

Object | false (default: {})
Options for calendar popup animation.

enable

boolean (default: true)
If false user input won't be allowed.

maxSelectedItems

number (default: null)
Defines the limit of selected items unless null.

cleanSelectedItemsOnTodayClick

boolean (default: true)
If true - only today date will be selected after click on date in calendar footer,
otherwise - today date will be added to selected dates.

placeholder

string (default: '')
Placeholder for empty input.

tagTemplate

string | ((data: Date) => string) (default: '')
Template for rendering tags, if not specified 'format' option will be used to render tags.

format

string (default: 'M/d/yyyy')
Defines format for parsing user input and displaying tags if 'tagTemplate' option is not specified.

values

Date[] (default: null)
Initial selected dates.

footer

string | false | ((data: Date) => string) (default: '')
Template for rendering calendar footer.

culture

string (default: '')
Calendar culture ('en-US', 'de-DE', etc.).

min

Date (default: new Date(1900, 0, 1))
Minimum date that can be selected.

max

Date (default: new Date(2099, 11, 31))
Maximum date that can be selected.

start

string (default: 'month')
Specifies calendar start view.

depth

string (default: 'month')
Specifies calendar navigation depth.

month

Object (default: {})
Specifies calendar templates for the cells.

dates

Date[] (default: [])
Special calendar dates, which will be passed to month template.

Methods


close

() => void
Closes calendar popup.

open

() => void
Opens calendar popup.

toggle

() => void
Toggles calendar popup.

destroy

() => void
Destroys the widget with underlying calendar and multi-select widgets.

enable

(enable: boolean) => void
Enables or disables multi-select.

readonly

(enable: boolean) => void
Changes multi-select 'readonly' state.

min

(min: Date) => Date
Gets/sets the min value of the calendar.

max

(max: Date) => Date
Gets/sets the max value of the calendar.

values

(values: Date[]) => Date[]
Gets/sets selected values.

multiSelect

() => MultiSelect
Gets underlying multi-select widget.

multiCalendar

() => MultiCalendar
Gets underlying calendar widget.

Events


navigate

Fires when calendar view is changed.

change

Fires when the selected dates are changed.

open

Fires when calendar popup opens.

close

Fires when calendar popup closes.

Typescript

This module also contains type declarations.

// use 'reference' directive
/// <reference path="node_modules/kendo-multi-date-select/dist/kendo-multi-date-select.d.ts" />
 
// or add types to 'compilerOptions' in your tsconfig.json:
// ...
// "types": [ "kendo-multi-date-select" ],
// ...
 
const multiDateSelect = new kendoExt.MultiDateSelect('#multiDateSelect');

Package Sidebar

Install

npm i kendo-multi-date-select

Weekly Downloads

7

Version

2.0.13

License

MIT

Unpacked Size

43.6 kB

Total Files

9

Last publish

Collaborators

  • iyegoroff