mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
405a85a92d
* chore(bootstrap-datepicker): add missing types * fix: use DatePickerViewMode for startView option * fix: daysOfWeekDisabled option typing * test(bootstrap-datepicker): add tests for new property
124 lines
4.3 KiB
TypeScript
124 lines
4.3 KiB
TypeScript
// Type definitions for bootstrap-datepicker
|
|
// Project: https://github.com/eternicode/bootstrap-datepicker
|
|
// Definitions by: Boris Yankov <https://github.com/borisyankov>
|
|
// Jannik Keye <https://github.com/jannikkeye>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.3
|
|
|
|
/// <reference types="jquery"/>
|
|
|
|
type DatepickerEvents = "show"|"hide"|"clearDate"|"changeDate"|"changeMonth"|"changeYear"|"changeDecade"|"changeCentury";
|
|
|
|
type DatepickerViewModes = 0|"days"|1|"months"|2|"years"|3|"decades"|4|"centuries"|"millenium";
|
|
|
|
type DatepickerOrientations =
|
|
"auto"
|
|
| "left top"
|
|
| "left bottom"
|
|
| "right top"
|
|
| "right bottom"
|
|
| "top auto"
|
|
| "bottom auto"
|
|
| "auto left"
|
|
| "top left"
|
|
| "bottom left"
|
|
| "auto right"
|
|
| "top right"
|
|
| "bottom right"
|
|
|
|
/**
|
|
* All options that take a “Date” can handle a Date object; a String
|
|
* formatted according to the given format; or a timedelta relative
|
|
* to today, eg “-1d”, “+6m +1y”, etc, where valid units are “d” (day),
|
|
* “w” (week), “m” (month), and “y” (year).
|
|
*
|
|
* See online docs for more info:
|
|
* https://bootstrap-datepicker.readthedocs.io/en/latest/options.html
|
|
*/
|
|
interface DatepickerOptions {
|
|
autoclose?: boolean;
|
|
assumeNearbyYear?: boolean | number;
|
|
beforeShowDay?: (date: Date) => undefined | string | boolean | DatepickerBeforeShowDayResponse;
|
|
beforeShowMonth?: (date: Date) => undefined | string | boolean | DatepickerBeforeShowResponse;
|
|
beforeShowYear?: (date: Date) => undefined | string | boolean | DatepickerBeforeShowResponse;
|
|
beforeShowDecade?: (date: Date) => undefined | string | boolean | DatepickerBeforeShowResponse;
|
|
beforeShowCentury?: (date: Date) => undefined | string | boolean | DatepickerBeforeShowResponse;
|
|
calendarWeeks?: boolean;
|
|
clearBtn?: boolean;
|
|
container?: string;
|
|
datesDisabled?: string | string[];
|
|
daysOfWeekDisabled?: string | number[];
|
|
daysOfWeekHighlighted?: string | number[];
|
|
defaultViewDate?: Date | string | DatepickerViewDate;
|
|
enableOnReadonly?: boolean;
|
|
endDate?: Date | string;
|
|
forceParse?: boolean;
|
|
format?: string | DatepickerCustomFormatOptions;
|
|
immediateUpdates?: boolean;
|
|
inputs?: any[];
|
|
keepEmptyValues?: boolean;
|
|
keyboardNavigation?: boolean;
|
|
language?: string;
|
|
maxViewMode?: DatepickerViewModes;
|
|
minViewMode?: DatepickerViewModes;
|
|
multidate?: boolean | number;
|
|
multidateSeparator?: string;
|
|
orientation?: DatepickerOrientations;
|
|
showOnFocus?: boolean;
|
|
startDate?: Date | string;
|
|
startView?: DatepickerViewModes;
|
|
templates?: any;
|
|
showWeekDays?: boolean;
|
|
title?: string;
|
|
todayBtn?: boolean | "linked";
|
|
todayHighlight?: boolean;
|
|
updateViewDate?: boolean;
|
|
weekStart?: number;
|
|
zIndexOffset?: number;
|
|
}
|
|
|
|
interface DatepickerViewDate {
|
|
year:number;
|
|
/** Month starting with 0 */
|
|
month:number;
|
|
/** Day of the month starting with 1 */
|
|
day:number;
|
|
}
|
|
|
|
interface DatepickerBeforeShowResponse {
|
|
enabled?:boolean;
|
|
classes?: string;
|
|
tooltip?: string;
|
|
}
|
|
|
|
interface DatepickerBeforeShowDayResponse extends DatepickerBeforeShowResponse {
|
|
content?: string;
|
|
}
|
|
|
|
interface DatepickerCustomFormatOptions {
|
|
toDisplay?(date: string, format: any, language: any): string;
|
|
toValue?(date: string, format: any, language: any): Date;
|
|
}
|
|
|
|
interface DatepickerEventObject extends JQueryEventObject {
|
|
date: Date;
|
|
dates: Date[];
|
|
format(ix?:number): string;
|
|
format(format?: string): string;
|
|
format(ix?:number, format?: string): string;
|
|
}
|
|
|
|
interface JQuery {
|
|
datepicker(): JQuery;
|
|
datepicker(methodName: string): any;
|
|
datepicker(methodName: string, params: any): any;
|
|
datepicker(options: DatepickerOptions): JQuery;
|
|
|
|
off(events: DatepickerEvents, selector?: string, handler?: (eventObject: DatepickerEventObject) => any): JQuery;
|
|
off(events: DatepickerEvents, handler: (eventObject: DatepickerEventObject) => any): JQuery;
|
|
|
|
on(events: DatepickerEvents, selector: string, data: any, handler?: (eventObject: DatepickerEventObject) => any): JQuery;
|
|
on(events: DatepickerEvents, selector: string, handler: (eventObject: DatepickerEventObject) => any): JQuery;
|
|
on(events: DatepickerEvents, handler: (eventObject: DatepickerEventObject) => any): JQuery;
|
|
}
|