Skip to content

Calendar

UX/UI Guidelines

Check the design documentation of the component in ZeroHeight.

Implementations

The component Calendar is available in the following technologies:

Web Components
webreactvueangular

Parameters

Parameters

Parameters are the attributes that can be used to customize the component when using it in a project. They apply to the WebComponents implementation and wrappers and to the Vue and React CSS implementations. Some parameters names change between the implementations, in order to follow the conventions of each technology and framework.

For example, the param model is named ngModel in Angular, modelValue in Vue, but stays as model in React.

By default, all the parameters are optional or can be set in different, except for the ones marked as required

The parametrization of the component can be done with the following custom params or properties:

NameTypeSlottableDescription
modelstringThe selected date.
first-weekdaystringThe first day of the week.
calendar-typestringThe calendar type.
localestring

The locale parameter is used to set the locale of the component. The value must be part of the registered locales in ZDS. If not set, the default locale of the document will be used.

Have a look to the localization mechanisms.

widebooleanExpands the calendar to the full width of the container
customobject

A record of key-value pairs to set the CSS custom tokens. It's a complex attribute set as an JS object in stringified JSON format.

Example:

html
<z-calendar custom='{"fill":"#06e7a3"}' />
custom-strstring

The stringified version of the custom property. It follows the pattern key:value;key:value;, with the possibility of setting multiple values and spaces between the punctuation characters.

Example:

html
<z-calendar custom-str="fill:#06e7a3" />
z-themestring

Sets the theme of the component. The possible values are light and dark.

html
<z-calendar z-theme="dark" />

From Figma to code

...

Customization

INFO

Check everything about the customization mechanics in the "How it works" documentation.

CSS VariableTypeDescription
--z-calendar--header-bgcolorThe background color of the header.
--z-calendar--header-colorcolorThe text color of the header.
--z-calendar--bgcolorThe background color of the calendar.
--z-calendar--colorcolorThe text color of the calendar.
--z-calendar--radiusdistanceThe border radius of the calendar.
--z-calendar--shadowshadowThe shadow of the calendar.

The calendar component it's highly customizable. You can use the --z-calendar--header--bg, --z-calendar--header--color, --z-calendar--bg, --z-calendar--color and --z-calendar--radius to customize the background and color of the header, the background and color of the calendar, and the radius of the calendar.

Or more complex assignations:

Accessibility

...