Skip to content

Latest commit

 

History

History
315 lines (264 loc) · 20.9 KB

api.md

File metadata and controls

315 lines (264 loc) · 20.9 KB
Raw

API

Theme Styles

Style Target Area Default
wrapper Wrapper for both single and double-paned calendars. { backgroundColor: '#fafafa', border: '1px solid #dadada' }
verticalDivider Vertical divider that appears when calendar is-double-paned. { borderLeft: '1px solid #dadada' }
horizontalDivider Horizontal divider that appears when calendar is-double-paned and is-vertical. { borderTop: '1px solid #dadada' }
header Header section that encapsulates arrows and title. [1] null
headerTitle Header title. [1] null
headerArrows Header arrows that can be styled just like a font. [1] null
headerHorizontalDivider Horizontal divider that appears just below header section. null
weekdays Weekday section that encapsulates all the weekday labels. [1] null
weekdaysHorizontalDivider Horizontal divider that appears just below weekdays section. null
weeks Weeks section that encapsulate all the days of the month. [1] null
dayCell Day cell that contains day content and any associated attributes. null
dayCellNotInMonth When a day does not lie in the month on which it is displayed (belongs to previous or next month), this style is merged with dayCell. { opacity: 0.4 }
dayContent Content area within the day cell that contains the day of the month number. [2] null
dayPopoverContent Popover container for attribute popover labels and slot content. { color: '#333333', fontSize: '.8rem', whiteSpace: 'nowrap' }
dots Container for dot indicators. null
bars Container for bar indicators. null
navHeader Navigation pane header. null
navHeaderArrows Navigation header arrows. null
navHeaderTitle Navigation header title. null
navMonthCell Navigation month cells. [3] null
navYearCell Navigation year cells. [3] null

[1] As of v0.9.0, you can use functions to define the header, headerTitle, headerArrows, weekdays and weeks styles. Functions should accept a page object and return a configured style.

[2] As of v0.8.0, the dayContentHover style has been deprecated and you can optionally use a function to define the dayContent style. This function should accept an object parameter with the following properties (isHovered, isFocused, day). This function should return the configured style.

[3] As of v0.9.0, you can use functions to define the navMonthCell and navYearCell styles. Functions should accept a nav-month-item object and nav-year-item object, respectively.

nav-month-item Properties

Name Type Description
month Number Month number of the cell.
label String Formatted month label per the formats prop.
is-active Boolean Month is selected, or active.
is-disabled Boolean Month is disabled (ie. not selectable).

nav-year-item Properties

Name Type Description
year Number Year number of the cell.
is-active Boolean Year is selected, or active.
is-disabled Boolean Year is disabled (ie. not selectable).

Date Patterns

Property Type Description Range
days Number, Array Day number from the start or end of the month. 1 to 31, -1 to -31
weekdays Number, Array Day of the week. 1: Sun to 7: Sat
ordinalWeekdays Object (key: Number / value: Number, Array) Weekday ordinal position from the start or end of the month. key: 1 to 6, -1 to -6 / value: 1: Sun to 7: Sat
weeks Number, Array Week number from the start or end of the month. 1 to 6, -1 to -6
months Number, Array Months of the year. 1 to 12
years Number, Array Year numbers. 4-digit integer
dailyInterval Number Interval number of days from the start date (or today when no start date provided). n > 0
weeklyInterval Number Interval number of weeks from the start date (or today). n > 0
monthlyInterval Number Interval number of months from the start date (or today). n > 0
yearlyInterval Number Interval number of years from the start date (or today). n > 0

Calendar

Props {#calendar-props}

Name Type Description Default
formats Object Formats to use when display and parsing dates for various calendar sections Reference code
nav-visibility String Visibility state of the navigation panel. Use "hover" to automatically show when title is hovered on non-touch devices or tapped on touch devices. Use "focus" to automatically show when title enters or leaves focus. Use "visible" and "hidden" for manual control. "focus"
from-page Object Active page for single paned calendar or the left pane for double paned calendar. Use the .sync modifier for two-way binding. { month: *thisMonth*, year: *thisYear* }
to-page Object Active page for the right pane for double paned calendar. Use the .sync modifier for two-way binding. { month: *nextMonth*, year: *nextMonthYear* }
min-page Object Earliest page (month, year) that the user can navigate to. undefined
max-page Object Latest page (month, year) that the user can navigate to. undefined
min-date Date Date that is used to compute min-page. undefined
max-date Date Date that is used to compute max-page. undefined
is-double-paned Boolean Puts two calendars side by side. When window is constrained only a single calendar is displayed. false
is-linked Boolean When is-double-paned, navigation panes are linked to consecutive months. false
is-vertical Boolean When is-double-paned, panes are in vertical orientation. false
is-expanded Boolean Expands calendar to fill the full width of its container. false
pane-width Number Width of a single pane, in pixels. 256
theme-styles Object A variety of styles that are used to customize different components of the calendar. Reference theme styles
title-position String Position of the header title ("left", "center", "right"). "center"
title-transition String Transition type for title when navigating to a new page ("slide-h", "slide-v", "fade", "none"). "slide-h"
weeks-transition String Transition type for weeks when navigating to a new page ("slide-h", "slide-v", "fade", "none"). "slide-h"
attributes Array[Object] List of attributes to display in the calendar. []

Events {#calendar-events}

Name Description Params
update:frompage Calendar left/single pane moved to a different page. page
update:topage Calendar right pane moved to a different page. page
dayclick Forwarded from the mouseclick event for the day content element. day
daymouseenter Forwarded from the mouseenter event for the day content element. day
daymouseover Forwarded from the mouseover event for the day content element. day
daymouseleave Forwarded from the mouseleave event for the day content element. day

Slots {#calendar-slots}

Name Description Props (If Scoped)
header Calendar header. Use slots below for specific header sections. page props
header-title Calendar header title. This slot is animated if title-transition is assigned. page props
header-left-button Calendar header button on the left side. page props
header-right-button Calendar header button on the right side. page props
day-content Calendar day content cell. day, attributes: Array, contentStyle: Object
day-popover-header If popover content is visible, this slot displays as the header. day props
day-popover-footer If popover content is visible, this slot displays as the footer. day props
custom-name Any number of custom named slots that are referenced by attribute popovers. attribute: Object, day, customData: Any

Page Object

Property Type Description
position Number Position of the the pane that contains this page (0: single-paned, 1: double-paned, left side, 2: double-paned, right side).
month Number Page month number.
year Number Page year number.
monthLabel String Page month label as specified by the monthLabels prop or locale settings.
shortMonthLabel String Shortened month label as specified by the shortMonthLabels prop or locale settings.
yearLabel String Page year label in YYYY format.
shortYearLabel String Page year label in YY format.
monthComps Object Components of the current page month.
prevMonthComps Object Components of the previous page month.
nextMonthComps Object Components of the next page page.
canMove(Object) => Boolean Function Function that determines if calendar can move to a desired page (due to min-page or max-page setting).
move(Object) Function Function that moves to the specified page.
moveThisMonth() Function Function that moves to the page for today's month.
movePrevMonth() Function Function that moves to the page for the previous month.
moveNextMonth() Function Function that moves to the page for the next month.

Day Object

Property Type Description
day Number Day number (1 - 31).
dayFromEnd Number Day number from the end of the month (1 - 31).
weekday Number Day weekday number (1:Sun - 7:Sat).
weekdayOrdinal Number Weekday ordinal position from the start of the month (1 - 6).
weekdayOrdinalFromEnd Number Weekday ordinal position from the end of the month (1 - 6).
week Number Week number form the start of the month (1 - 6).
weekFromEnd Number Week number from the end of the month (1 - 6).
month Number Month number (1 - 12).
year Number Year number.
date Date Date for this day.
dateTime Number Result of calling date.getTime() for this day.
inMonth Boolean Day lies in the currently active month.
inPrevMonth Boolean Day lies in the month before the currently active month.
inNextMonth Boolean Day lies in the month after the currently active month.
attributes Array List of attributes for the day involved with the event.
attributesMap Object Object map of the attributes using their designated key.
event Object Original event that triggered the event.

Date Picker

Props {#date-picker-props}

Note: Accepts all props accepted by v-calendar

Name Type Description Default
value Date, Array[Date], Object Selected date, dates or date range. null
mode String Selection mode: "single", "multiple", "range" "single"
is-required Boolean Prevents the user from clearing the selected value. Setting value = null still allowed through code. false
is-inline Boolean Displays calendar inline instead of as a popover. false
min-date Date Minimum date selectable by the user. undefined
max-date Date Maximum date selectable by the user. undefined
disabled-dates Array, Date, Object Disabled dates or date range objects. undefined
available-dates Array, Date, Object Available dates or date range objects. All other dates are disabled. undefined
input-props Object Object with props to apply to the input element. Not applicable for inline date pickers. Reference code
update-on-input Update the picker value after every input event. false
date-formatter Function Converts a date object into text. date => date.toLocaleDateString()
date-parser Function Function used to parse text into a date. text => new Date(Date.parse(text))
tint-color String Background color of the selected and dragged highlighted regions (opacity: 0.5 for dragged). This setting is overridden by select-attribute and drag-attribute if specified. "#66B3CC"
select-attribute Object Attribute to use for the date selection in all modes. Reference code
drag-attribute Object Attribute to use for the dragged selection in "range" mode. Reference code
show-caps Boolean Show caps and the end of the highlighted and dragged regions when mode === "range" false
show-popover Boolean Show popover when selected or dragged date regions are hovered. true
popover-expanded Boolean Popover wrapper for input or slot is expanded to the full width of it's container. false
popover-direction String Direction that popover displays relative to input or slot element: "bottom", "top", "left", "right" "bottom"
popover-align String How the popover is aligned relative to input or slot element: "left", "right", "top", "bottom" "left"
popover-visibility Number Visibility state of the popover: "hover", "focus", "hidden", "visible" "hover"
popover-content-offset String Distance that the popover content is offset from the input or slot element. "10px"
popover-keep-visible-on-input Boolean Keep the popover visible after a valid input has been selected false

Events {#date-picker-events}

Note: Forwards all events emmitted by v-calendar

Name Description Params
input New date was selected. value: Date, Array[Date], Object
drag Dragged selection was updated. Only valid when mode === "range" range: Object
popover-will-appear Just before popover appears undefined
popover-did-appear Just after popover appears undefined
popover-will-disappear Just before popover disappears. Check param to see if appear was cancelled. cancelled: Boolean
popover-did-disappear Just after popover disappears. Check param to see if appear was cancelled. cancelled: Boolean

Slots {#date-picker-slots}

Note: Forwards all slots supported by v-calendar

Name Description Props (If Scoped)
default Default slot to use as the popover anchor for v-date-picker. [1] Not applicable to inline date pickers. inputValue: String, updateValue: Function

[1] Most likely will contain a variant of the following:

<!--Normal slot input example. Update value on input *change* event.-->
<v-date-picker
  v-model='myDate'>
  <input
    type='text'
    slot-scope='{ inputValue, updateValue }'
    :value='inputValue'
    @change='updateValue(inputValue, { formatInput: true, hidePopover: false })'>
  <!--Also, update value as the user types-->
  <input
    type='text'
    slot-scope='{ inputValue, updateValue }'
    :value='inputValue'
    @input='updateValue($event.target.value, { formatInput: false, hidePopover: false })'
    @change='updateValue($event.target.value, { formatInput: true, hidePopover: false })'>
  <!--Also, revert value and hide popover when user types the *escape* key-->
  <input
    type='text'
    slot-scope='{ inputValue, updateValue }'
    :value='inputValue'
    @input='updateValue($event.target.value, { formatInput: false, hidePopover: false })'
    @change='updateValue($event.target.value, { formatInput: true, hidePopover: false })'
    @keyup.esc='updateValue(myDate, { formatInput: true, hidePopover: true })'>
</v-date-picker>

Attribute

Property Type Description Default
key String Keys uniquely identify an attribute and may determine how animations are applied. index
highlight Object, Function Highlight to associate with attribute. undefined
dot Object, Function Dot to associate with attribute. undefined
bar Object, Function Bar to associate with attribute. undefined
popover Object, Function Popover to associate with attribute. undefined
contentStyle Object, Function Day content style to associate with the attribute. undefined
dates Date, Object, Array[Date, Object] Date or date range objects (patterns supported) to include for the attribute. undefined
excludeDates Date, Object, Array[Date, Object] Date or date range objects (patterns supported) to exclude. All other dates are included. undefined
customObject Any Assign any custom data to this property for easy access within event handlers. undefined
order Number Order that the attribute should be displayed. Higher numbers take precedence in appearance. 0

Highlight

Property Type Description Default
animated Boolean Highlight is animated on appearing, disappearing or range change. true
height String Height of highlighted region. "1.8rem"
backgroundColor String Background color of highlighted region. "rgba(0, 0, 0, 0.5)"
borderColor String Border color of highlighted region. undefined
borderWidth String Border width of highlighted region. "0"
borderStyle String Border style of highlighted region. "solid"
borderRadius String Border radius of highlighted region. "1.8rem"
opacity Number Opacity of highlighted region. 1

Dot

Property Type Description Default
diameter String Diameter of dot. "5px"
backgroundColor String Background color of dot. "rgba(0, 0, 0, 0.5)"
borderColor String Border color of dot. undefined
borderWidth String Border width of dot. 0
borderStyle String Border style of dot. "solid"
borderRadius String Border radius of dot. "50%"
opacity Number Opacity of dot. 1

Bar

Property Type Description Default
height String Height of bar. "5px"
backgroundColor String Background color of bar. "rgba(0, 0, 0, 0.5)"
borderColor String Border color of bar. undefined
borderWidth String Border width of bar. 0
backgroundColor String Background color of bar. undefined
opacity Number Opacity of bar. 1

Popover

Property Type Description Default
label String, Function Text string (or function that returns a string) to display in the popover content row. For functions, attribute is provided as the first parameter and the day is provided as the second. undefined
labelStyle Object, Function Label style object (or function that returns an object). For functions, attribute is provided as the first paramter and the day is provided as the second. undefined
hideIndicator Boolean Hides the indicator symbol on the left side of the popover content row. false
slot String Name of slot to use to display the popover content row. undefined
visibility String Visibility of the popover when this label or slot is displayed ("hover, "focus", "visible", "hidden"). "hover"
isInteractive Boolean Determines if the user can interract with the popover content. If two or more popovers conflic, true overrides. false

Content Style

Content style is just a style object. All normal style properties apply.

Content Hover Style (Deprecated)

NOTE: As of v0.8.0, the contentHoverStyle property has been deprecated in favor of using a function to define the contentStyle property. This functions accepts an object parameter with the following properties (isHovered, isFocused, day). This function should return the configured style.