Navigation Back to home

MonthCalendar

A month calendar for appointments and date-based planning, with optional datasource-driven event loading.

Import
the javascript logo
import { MonthCalendar } from "@schukai/monster/source/components/time/month-calendar.mjs";
Source
the git logo
Package
the npm logo
Since
3.112.0

Introduction

The Monster MonthCalendar shows appointments across a monthly grid. Use it when users should browse planned items, availability or simple scheduling information in a familiar calendar format.

When to use MonthCalendar

  • Use it for month-based planning: Good for availability overviews, event calendars and lightweight scheduling.
  • Use it when a datasource can provide appointments: The component can render remote planning data inside the calendar grid.
  • Do not use it for minute-level planning: Detailed time allocation usually wants a timeline or agenda view.

Calendar Simple

This is a monster calendar component. It is a simple calendar that displays the current month. No more no less.

Javascript

//import '@schukai/monster/source/components/time/month-calendar.mjs';<script type="module">//import '@schukai/monster/source/components/time/month-calendar.mjs';</script>

HTML

<monster-month-calendar>
</monster-month-calendar>

Stylesheet

/** no additional stylesheet is defined **/
Open in playground

Component Design

This component is built using the Shadow DOM, which allows it to encapsulate its internal structure and styling. By using a shadow root, the component's internal elements are isolated from the rest of the webpage, ensuring that external styles or scripts cannot accidentally modify its internal layout or behavior.

Shadow DOM and Accessibility

Since the component is encapsulated within a shadow root, direct access to its internal elements is restricted. This means that developers cannot manipulate or style these elements from outside the component. The Shadow DOM helps maintain consistency in the design and behavior of the component by preventing external interference.

Customizing Through Exported Parts

While the Shadow DOM restricts direct access to the component's internal structure, customization is still possible through exported parts. Specific parts of the component are made accessible for styling by being explicitly marked for export. These exported parts can be targeted and customized using CSS, allowing you to modify the appearance of the component without compromising its encapsulation.

Available Part Attributes

  • control: This part represents the entire control area of the slider, including navigation buttons and thumbnails. Use this to style the general layout and background of the control panel.

Below is an example of how to use CSS part attributes to customize different parts of the Control.


monster-component::part(control) {
    background-color: #f0f0f0;
    padding: 10px;
}

Explanation of the Example

  • monster-slider::part(control): Styles the entire control panel, giving it a light background color and some padding.

Accessibility

Accessibility is a key consideration in the design of this component. By following best practices for web accessibility, the component ensures that users of all abilities can interact with it effectively. This includes support for keyboard navigation, screen readers, and other assistive technologies to provide an inclusive user experience.

HTML Structure

<monster-month-calendar></monster-month-calendar>

JavaScript Initialization

const element = document.createElement('monster-month-calendar');
document.body.appendChild(element);

Exported

MonthCalendar

Derived from

CustomElement

Options

The Options listed in this section are defined directly within the class. This class is derived from several parent classes, including the CustomElement class. Therefore, it inherits Options from these parent classes. If you cannot find a specific Options in this list, we recommend consulting the documentation of the CustomElement.

Option
Type
Default
Description
templates
object
Template definitions
templates.main
string
undefined
Main template
labels
object
undefined
Labels for the control
classes
object
undefined
Classes for the control
disabled
boolean
false
Disables the control
features
object
Features for the control
features.showWeekend
boolean
true
Show the weekend
features.monthOneLine
boolean
false
Show the month in one line
actions
object
undefined
Actions for the control
locale
object
Locale for the control
locale.weekdayFormat
string
short
Weekday format
startDate
string
undefined
Start date
endDate
string
End date
datasource
object
Datasource
datasource.selector
string
Datasource selector

  • since
  • deprecated

Properties and Attributes

The Properties and Attributes listed in this section are defined directly within the class. This class is derived from several parent classes, including the CustomElement class and ultimately from HTMLElement. Therefore, it inherits Properties and Attributes from these parent classes. If you cannot find a specific Properties and Attributes in this list, we recommend consulting the documentation of the CustomElement.

  • data-monster-options: Sets the configuration options for the collapse component when used as an HTML attribute.
  • data-monster-option-[name]: Sets the value of the configuration option [name] for the collapse component when used as an HTML attribute.

Methods

The methods listed in this section are defined directly within the class. This class is derived from several parent classes, including the CustomElement class and ultimately from HTMLElement. Therefore, it inherits methods from these parent classes. If you cannot find a specific method in this list, we recommend consulting the documentation of the CustomElement.

Behavioral methods

refresh()
Returns
  • {Promise}
This method is called when the component is created.

Static methods

[instanceSymbol]()
This method is called by the instanceof operator.
getCSSStyleSheet()
Returns
  • {CSSStyleSheet[]}
getTag()
Returns
  • {string}

Lifecycle methods

Lifecycle methods are called by the environment and are usually not intended to be called directly.

[assembleMethodSymbol]()
Returns
  • {Components.Time.Calendar
[initMethodSymbol]()
This method is called by the instanceof operator.

Events

This component does not fire any public events. It may fire events that are inherited from its parent classes.

The current width of the area is too small to display the content correctly.