CalendarDays

A 7-column grid of days for use in a month calendar or multi-week calendar
Demo: A default representation of days in the current month in browser's default locale

Overview

Given a startDate and dayCount, this component will show a calendar representation of that many days starting from the indicated date. CalendarMonth uses CalendarDays to render the days portion of the month, to which it adds headers for the month/year and the days of the week.

All of the Elix calendar components attempt to provide full international calendar support to the extent currently possible in the user's web browser.

API

Ancestry: CalendarDays → ReactiveElement → HTMLElement

Built with mixins AttributeMarshallingMixin, CalendarElementMixin, ReactiveMixin, and ShadowTemplateMixin.

The element defines the following shadow parts:

  • day: any of the day elements in the grid, default type is CalendarDay

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

dayElementForDate(date) method

Returns the day element corresponding to the given date, or null if the date falls outside this calendar week.

Parameters:

  • date: Datethe date to search for

dayPartType property

The class, tag, or template used to create the day parts – the set of days shown in the calendar grid.

Type: (component class constructor)|HTMLTemplateElement|string

Default: CalendarDay

days property

The elements for the days being displayed.

Type: Array.|null

[internal.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

[internal.ids] 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[internal.ids].foo to obtain the corresponding button in the component instance's shadow tree. The ids property is simply a shorthand for getElementById, so this[internal.ids].foo is the same as this.shadowRoot.getElementById('foo').

Type: object

Defined by ShadowTemplateMixin

[internal.render](changed) method

Render the indicated 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

[internal.renderChanges]() method

Render any pending component changes to the DOM.

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

ReactiveMixin will invoke this method following a setState call; you should not need to invoke this method yourself.

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

Defined by ReactiveMixin

[internal.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

[internal.state] property

The component's current state.

The returned state object is immutable. To update it, invoke internal.setState.

It's extremely useful to be able to inspect component state while debugging. If you append ?elixdebug=true to a page's URL, then ReactiveMixin will conditionally expose a public state property that returns the component's state. You can then access the state in your browser's debug console.

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