Skip to main content

Date Picker

A date picker is an interactive element for selecting and displaying a date from a calendar.

By default, the date picker starts in a closed state.

Use cases:

  • selecting a date
  • displaying a date
  • disable selecting specific days of the week

Example​

Date picker value: Not changed

Declaration

<DatePicker></DatePicker>

Usage

import { DatePicker } from '@genesislcap/rapid-design-system/react';

export function MyComponent() {

const datePickerRef = useRef(null);
const [value, setValue] = useState('Not changed');
const handleValueChanged = (value) => {
setValue(value.detail);
}

useEffect(() => {
if (datePickerRef.current) {
datePickerRef.current.addEventListener('value-changed', handleValueChanged);
}
}, []);

return (
<DatePicker ref={datePickerRef}>
</DatePicker>
);
}

DOM API​

The sections below provide property and attribute binding examples for Genesis Component syntax. The HTML closing tag is not included.

Attributes​

AttributeTypeUseExample
formatstringThe date format shown defaults to MM-DD-YYYY and can accept any valid dayjs format
<rapid-date-picker format="DD-MM-YYYY">
langstringDetermines the defuault locale. Defaults to en-US and can accept any valid day js lang
<rapid-date-picker lang="en-US">
visiblebooleanDisplays the calendar by default. Defaults to false
<rapid-date-picker ?visible=${(x) => x.visible}>
inline-calendarbooleanDisplays the calendar as an inline block element as opposed to being absolutely positioned relative to it's parent. Defaults to false
<rapid-date-picker inline-calendar>
hide-weekendsbooleanHides Saturday and Sundays restricting user to selecting only week days. Defaults to false
<rapid-date-picker hide-weekends>
positionstringDetermines the position of the calendar. Possible options 'right', 'left', 'center' or 'left'.
<rapid-date-picker position="right">
labelstringSets the label that will be displayed next to the date input text field
<rapid-date-picker label="Trade Date">
valuestringSets the date value as string in the configured format on the date picker.
<rapid-date-picker label="06-20-2025">

Properties​

PropertyTypeUseExample
disabledDaysOfWeek() => number[]An array of numbers disabling days of the week with 0 being Sunday and 6 being Saturday
  <rapid-date-picker :disabledDaysOfTheWeek="${() => [1]}">

Component Methods​

This component doesn't have any methods.

Slots​

SlotUse
endThe icon in the calendar toggle.
bottomThe bottom of the calendar.

Parts​

PartUse
date-toggleThe calendar toggle element which shows the current value and toggle icon.
input-icon-containerThe icon in the calendar toggle.

Events fired​

EventTypeUseExample
value-changedeventEmits a custom change event when the a date is selected in the calendar. Access the value on the event via .target.value.
<rapid-date-picker @value-changed="${(x) => x.myChangeHandler(event)}">

Events listened to​

This component doesn't listen to any events.