CalendarMonthNavigator

Interactive month calendar that lets the user select a date
Demo: CalendarMonthNavigator lets the user select a date

Overview

CalendarMonthNavigator extends the read-only CalendarMonth with interactivity. You can use CalendarMonthNavigator on its own as an inline calendar. It is also used as the popup content in a DateComboBox.

Demo: DateComboBox uses CalendarMonthNavigator in its popup

Like all Elix calendar components, CalendarMonthNavigator attempts to provide full international support.

Usage

import CalendarMonthNavigator from 'elix/src/CalendarMonthNavigator.js';

See also

API

Ancestry: CalendarMonthNavigator → CalendarMonthReactiveElement → HTMLElement

Built with mixins ArrowDirectionMixin, AttributeMarshallingMixin, CalendarElementMixin, CalendarElementMixin, DarkModeMixin, FocusVisibleMixin, KeyboardDirectionMixin, KeyboardMixin, ReactiveMixin, and ShadowTemplateMixin.

By default, this uses these elements in the following roles:

This element is used to fill a role in DateComboBox.

$ property

A convenient shortcut for looking up an element by ID in the component's Shadow DOM subtree.

Example: if component's template contains a shadow element <button id="foo">, you can use the reference this.$.foo to obtain the corresponding button in the component instance's shadow tree. The $ function is simply a shorthand for getElementById, so this.$.foo is the same as this.shadowRoot.getElementById('foo').

Type: object

Defined by ShadowTemplateMixin

arrowButtonOverlap property

True if the arrow buttons should overlap the component contents; false if they should appear to the side of the contents.

Type: boolean

Default: true

Defined by ArrowDirectionMixin

arrowButtonRole property

The class, tag, or template used to create the previous/next arrow buttons.

Type: (component class constructor)|HTMLTemplateElement|string

Default: ArrowDirectionButton

Defined by ArrowDirectionMixin

darkMode property

True if the component should configure itself for display on a dark background; false if the component should assume a light background.

The default value of this property is inferred when the component is initially added to the page. The component will look up its hierarchy for an ancestor that has an explicit background color. If the color's lightness value in the HSL cylindrical-coordinate system is below 50%, the background is assumed to be dark and darkMode will default to true. If the color is lighter than that, or no explicit background color can be found, the default value of darkMode will be false.

Type: boolean

Defined by DarkModeMixin

date property

The date that should be shown by the element. For elements that show a range of dates (a month, a week, etc.), the referenced date will be included in the range.

This property can be set as a string, which will be parsed and converted to a JavaScript Date.

If not specified, the default date value is the current date.

Type: Date|string

Defined by CalendarElementMixin

date-changed event

Raised when the date property changes.

Defined by CalendarElementMixin

date-changed event

Raised when the date property changes.

Defined by CalendarElementMixin

dayElementForDate(date) method

Returns the day element corresponding to the given date, or null if the date falls outside the range currently covered by this calendar.

Parameters:

  • date: Datethe date to search for

Returns: Elementnull

Defined by CalendarMonth

dayRole property

The class, tag, or template used to create the day elements.

Type: (component class constructor)|HTMLTemplateElement|string

Default: CalendarDay

Defined by CalendarMonth

days property

Returns the day elements contained by this calendar. Note that this may include days from the previous/next month that fall in the same week as the first/last day of the present month.

Type: Array.

Defined by CalendarMonth

daysOfWeekFormat property

The format used to render the day names in the week days header.

The allowable formats are the same as the weekday formats in Intl.DateTimeFormat.

Type: 'long'|'narrow'|'short'

Default: 'short'

Defined by CalendarMonth

defaultState property

The default state for the component. This can be extended by mixins and classes to provide additional default state.

Type: State

Defined by ReactiveMixin

locale property

A string that identifies a language and a region using a BCP 47 language tag. This is the same format used by to identify a locale in the standard Intl internationalization API. See the locales argument documentation for details.

Calendar elements are region-sensitive, so language alone is insufficient. Accordingly, the locale should identify at least a language and a region. Examples: "en-US" identifies US English, while "en-GB" identifies English in Great Britain. The use of "en" on its own would be insufficient.

Type: string

Defined by CalendarElementMixin

monthFormat property

The format used to render the month name.

The allowable formats are the same as the month formats in Intl.DateTimeFormat.

Type: 'numeric'|'2-digit'|'long'|'short'|'narrow'

Default: 'long'

Defined by CalendarMonth

render() method

Render pending component changes to the DOM.

This method does nothing if the state has not changed since the last render call.

This method invokes all internal render methods. It then invoked componentDidMount (for first render) or componentDidUpdate (for subsequent renders).

Defined by ReactiveMixin

setState(changes) method

Update the component's state by merging the specified changes on top of the existing state. If the component is connected to the document, and the new state has changed, this returns a promise to asynchronously render the component. Otherwise, this returns a resolved promise.

Parameters:

  • changes: objectthe changes to apply to the element's state

Returns: Promise - resolves when the new state has been rendered

Defined by ReactiveMixin

state property

The component's current state. The returned state object is immutable. To update it, invoke setState.

Type: State

Defined by ReactiveMixin

suppressFocusVisibility() method

Temporarily suppress visibility of the keyboard focus until the next keydown event.

This can be useful in components like Menu that actively manage where the focus is in response to mouse hover activity. If the user uses the keyboard to invoke a menu, then changes to using the mouse, it can be distracting to see the focus indicator moving as well. In such situations, the component can invoke this method (e.g., in response to mousemove) to temporarily suppress focus visibility.

Defined by FocusVisibleMixin

[symbols.goDown]() method

Invoked when the user wants to go/navigate down. The default implementation of this method does nothing.

Defined by KeyboardDirectionMixin

[symbols.goEnd]() method

Invoked when the user wants to go/navigate to the end (e.g., of a list). The default implementation of this method does nothing.

Defined by KeyboardDirectionMixin

[symbols.goLeft]() method

Invoked when the user wants to go/navigate left. The default implementation of this method does nothing.

Defined by KeyboardDirectionMixin

[symbols.goRight]() method

Invoked when the user wants to go/navigate right. The default implementation of this method does nothing.

Defined by KeyboardDirectionMixin

[symbols.goStart]() method

Invoked when the user wants to go/navigate to the start (e.g., of a list). The default implementation of this method does nothing.

Defined by KeyboardDirectionMixin

[symbols.goUp]() method

Invoked when the user wants to go/navigate up. The default implementation of this method does nothing.

Defined by KeyboardDirectionMixin

[symbols.keydown]() method

See the symbols documentation for details.

Defined by KeyboardMixin

[symbols.render](changed) method

Internal method for rendering any recent changes in state to the DOM.

The default implementation of this method does nothing. Override this method in your component to update your component's host element and any shadow elements to reflect the component's new state. See the rendering example.

Be sure to call super in your method implementation so that your component's base classes and mixins have a chance to perform their own render work.

Parameters:

  • changed: objectdictionary of flags indicating which state members have changed since the last render

Defined by ReactiveMixin

wrap(original) method

Destructively wrap a node with elements to show arrow buttons.

Parameters:

  • original: Nodethe node that should be wrapped by buttons

Defined by ArrowDirectionMixin

yearFormat property

The format used to render the year.

The allowable formats are the same as the year formats in Intl.DateTimeFormat.

Type: 'numeric'|'2-digit'

Default: 'numeric'

Defined by CalendarMonth