API Docs for:
Show:

Y.Plugin.Calendar.JumpNav Class

Defined in: gallery-js/calendar-jumpnav.js:1
Module: gallery-contextmenu-view

A Plugin for Y.Calendar that sets up Calendar to work with Y.Calendar.JumpNavView, which is a View class extension to setup a "click" listener on Calendar's "Month Year" header label that opens a popup Panel to provide a quick method to jump to a month / year.

Please see the Calendar.JumpNavView documentation for full details.

Constructor

Y.Plugin.Calendar.JumpNav

(
  • config
)

Defined in gallery-js/calendar-jumpnav.js:1

Parameters:

  • config Object

Example:

var myCal = new Y.Calendar({
    contentBox: "#mycal",
    width: '200px',
    showPrevMonth: true,
    showNextMonth: true
});

// Plugin the View to this Calendar ... available years are 1988 to 2021
cal.plug( Y.Plugin.Calendar.JumpNav, {
    yearStart: 1988,
    yearEnd:   2021
});

cal.render();

Methods

_afterHostRenderEvent

() private

Defined in gallery-js/calendar-jumpnav.js:135

Connector method that initializes the View and connects it to the Calendar instance

destructor

() protected

Defined in gallery-js/calendar-jumpnav.js:123

Destroys the View that was created and detaches its event listeners

initializer

(
  • config
)

Defined in gallery-js/calendar-jumpnav.js:113

Parameters:

  • config Object

Properties

NAME

String

Defined in gallery-js/calendar-jumpnav.js:40

name for this plugin

NS

String

Defined in gallery-js/calendar-jumpnav.js:32

This plugin can be accessed from a Calendar instance as "Calendar.jumpnav"

Attributes

closeAfterGo

Boolean

Defined in gallery-js/calendar-jumpnav.js:95

This flag sets whether the Panel instance should be hidden after the "Go" button is pressed

Default: true

offsetXY

Array

Defined in gallery-js/calendar-jumpnav.js:70

The x,y offset (horiz, vert) that should be used to offset the popup Panel from the original Calendar "header label" that was clicked.

Default: [ 30, 10 ]

openEventType

String

Defined in gallery-js/calendar-jumpnav.js:82

Sets the Event "type" that is used in the Calendar "header label" listener to open the popup Panel. Sensible values are "click" or "dblclick".

Default: 'click'

yearEnd

Number

Defined in gallery-js/calendar-jumpnav.js:60

Default: Current year

yearStart

Number

Defined in gallery-js/calendar-jumpnav.js:50

Default: 1985