Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VantCalendar

VantCalendar 日历组件

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

allowSameDay

allowSameDay: boolean

是否允许日期范围的起止时间为同一天

arrowDirection

arrowDirection: arrowDirectionType
箭头方向，可选值为 left up down

border

border: boolean

是否显示内边框

calendarColor

calendarColor: String

主题色

calendarReadonly

calendarReadonly: boolean

是否为只读状态

calendarTitle

calendarTitle: String

日历标题

clearable

clearable: boolean

是否启用清除图标，点击清除图标后会清空输入框

colon

colon: boolean

是否在 label 后面添加冒号

confirmText

confirmText: string

确认按钮的文字

css

css: VantCalendarStyle

dateFormat

dateFormat: CalendaeDateType

时间显示格式

defaultDate

defaultDate: string

默认选中的日期

firstDayOfWeek

firstDayOfWeek: number

设置周起始日

inputAlign

inputAlign: TextAlign

输入框对齐方式，可选值为 center right

inputId

inputId: string

input的id

isLink

isLink: boolean

是否展示右侧箭头并开启点击跳转

isShowLabel

isShowLabel: boolean

是否显示label

labelAlign

labelAlign: TextAlign

左侧文本对齐方式，可选值为 center right

labelCaption

labelCaption: string

label标题

labelWidth

labelWidth: Number

左侧文本宽度，默认单位为px

leftIcon

leftIcon: String

左侧图标名称或图片链接

maxDate

maxDate: string

可选择的最大日期

maxRange

maxRange: string

日期区间最多可选天数

minDate

minDate: string

可选择的最小日期

onClearScript

onClearScript: string

在点击由 clearable 属性生成的清空按钮时触发

onCloseScript

onCloseScript: string

关闭弹出层时触发

onConfirmScript

onConfirmScript: string

日期选择完成后触发，若show-confirm为true，则点击确认按钮后触发

onOpenScript

onOpenScript: string

打开弹出层时触发

onSelectScript

onSelectScript: string

点击并选中任意日期时触发

onUnselectScript

onUnselectScript: string

当日历组件的 type 为 multiple 时，取消选中日期时触发

placeholder

placeholder: string

输入框占位文本

poppable

poppable: boolean

是否以弹层的形式展示日历

position

position: PositionType

弹出位置

rangePrompt

rangePrompt: string

范围选择超过最多可选天数时的提示文案

readonly

readonly: boolean

只读

required

required: boolean

是否必填

rightIcon

rightIcon: String

右侧图标名称或图片链接

round

round: boolean

是否显示圆角弹窗

rowHeight

rowHeight: String

日期行高

showCalendarId

showCalendarId: string

picker的id

showConfirm

showConfirm: boolean

是否展示确认按钮

size

size: SizeType

控件大小。注：标准表单内的输入框大小限制为 large

type

type: CalendarType

日历类型

verify

verify: string

校验规则

verifyText

verifyText: string

Methods

doGetClassName

  • doGetClassName(): any

  • Returns any

doGetCss

  • doGetCss(): VantCalendarStyle

  • Returns VantCalendarStyle

doGetMethods

  • doGetMethods(): {} & { handleChange: any } & { handleClear: any; handleConfirm: any; handleUpdate: any }

  • 事件

    Returns {} & { handleChange: any } & { handleClear: any; handleConfirm: any; handleUpdate: any }

Protected doGetVerifyElem

  • doGetVerifyElem(): JQuery<HTMLElement>

  • 提示校验信息的jquery 对象 子类可以覆盖该函数实现提交时候的"危险"的样式的挂接到组件的那个jquery对象

    Returns JQuery<HTMLElement>

Protected doGetVerifyTextElem

  • doGetVerifyTextElem(verifyText: any): string

  • 展示校验信息的dom节点 子类可以覆盖该函数实现提交时候的"危险"的样式的挂接到组件的那个jquery对象

    Parameters

    • verifyText: any

      提示的文字

    Returns string

Protected doGetVerifyTipsElem

  • doGetVerifyTipsElem(): JQuery<HTMLElement>

  • 设置数据校验的标志的jquery 对象 如 子类可以覆盖该函数 实现提交校验没有通过会把改jquery 对象变成"红色的框框"

    Returns JQuery<HTMLElement>

Protected doGetVueCaledarEvent

  • doGetVueCaledarEvent(): string

  • 定义一些日期默认的事件

    reutrn

    返回事件定义的字符串

    Returns string

Protected doGetVueCalendarVModel

  • doGetVueCalendarVModel(): string

  • 定义一些默认的日期vmodel字符串

    reutrn

    返回vmodel字符串

    Returns string

doGetVueData

  • doGetVueData(): object

Protected doGetVueEvent

  • doGetVueEvent(): string

  • 定义一些默认的事件

    reutrn

    返回事件定义的字符串

    Returns string

Protected doGetVueHtml

  • doGetVueHtml(): string

  • Returns string

Protected doGetVueVModel

  • doGetVueVModel(): string

  • 定义一些默认的vmodel字符串

    reutrn

    返回vmodel字符串

    Returns string

Protected doRenderCallback

  • doRenderCallback(): void

Protected doRenderComponentWidth

  • doRenderComponentWidth(): void

Protected doRenderLabel

  • doRenderLabel(): void

Protected doRenderPlaceholder

  • doRenderPlaceholder(): void

doVerify

  • doVerify(): boolean

  • 校验数据是否通过设置的校验规则

    Returns boolean

    true通过,则反之

getAttrEditors

  • getAttrEditors(): AttributeEditorBase[]

getCalendarElem

  • getCalendarElem(): JQuery<HTMLElement>

  • Returns JQuery<HTMLElement>

Protected getCanEdit

  • getCanEdit(): boolean

  • 组件是否可以编辑

    Returns boolean

getDate

  • getDate(time: any): Date

  • 得到日期的时间戳

    Parameters

    • time: any

    Returns Date

    返回字符串日期

getElemtHtml

  • getElemtHtml(): string

getFormatDate

  • getFormatDate(date: Date, str?: String): string

  • 得到日期，格式化为字符串

    Parameters

    • date: Date

      日期时间

    • Optional str: String

      日期时间间隔符号

    Returns string

    返回字符串日期

getFormatStrTime

  • getFormatStrTime(date: any): string

  • 得到日期，根据选择的日期格式化转为字符串赋值给input框

    Parameters

    • date: any

      日期时间

    Returns string

    返回字符串日期

getInputElem

  • getInputElem(): JQuery<HTMLElement>

getTime

  • getTime(time: any): number[]

  • Parameters

    • time: any

    Returns number[]

getValue

  • getValue(): any

  • 得到组件的值

    Returns any

    返回值

getVueAttrStr

  • getVueAttrStr(): string

getVueCalendarAttrStr

  • getVueCalendarAttrStr(): string

  • 获取组件的html

    Returns string

raiseOnClearScript

  • raiseOnClearScript(): void

  • 注册点击并选中任意日期时触发

    Returns void

raiseOnCloseScript

  • raiseOnCloseScript(val: Date): void

  • Parameters

    • val: Date

    Returns void

raiseOnConfirmScript

  • raiseOnConfirmScript(val: Date | Date[]): void

  • Parameters

    • val: Date | Date[]

    Returns void

raiseOnOpenScript

  • raiseOnOpenScript(val: Date): void

  • Parameters

    • val: Date

    Returns void

raiseOnSelectScript

  • raiseOnSelectScript(e: Event): void

  • Parameters

    • e: Event

    Returns void

raiseOnUnselectScript

  • raiseOnUnselectScript(val: Date): void

  • Parameters

    • val: Date

    Returns void

setDefaultDate

  • setDefaultDate(time: string): any

  • 设置默认值

    Parameters

    • time: string

      日期时间

    Returns any

    返回日期时间Date | Date[] | null

verifyTips

  • verifyTips(): void

  • 显示的提示校验信息 当 verifyText 非空时候显示"危险"的样式, 空则去除"危险"的样式

    Returns void

Generated using TypeDoc