Skip to main content

Introducing Workflow Engine, try for FREE workflowengine.io.

DatePicker

Introduction

DatePicker represents a highly customizable component that allows users to enter and pick dates and times in different formats. Specifically, it provides a text input field and a calendar where users can manually enter their required date. You can configure this component to work with specific date format, restrict date ranges, change its appearance, and so on.

This component is a part of @react-form-builder/components-rsuite. The following introduces and describes available properties and options for the DatePicker component.

Main properties

The following general properties are available within the Main tab:

NameTypeDescription
LabelstringProvide a title for your component
AppearancechoiceSelect either subtle or default appearance for the component. The subtle option removes borders for the input field and the calendar
Calendar Default ValuedateSets default date value for calendar panel
CleanablebooleanIf set to true, allows users to change specified date
Default openbooleanIf set to true, the calendar will be opened for users by default. Otherwise, calendar will be opened upon clicking
Default valuebooleanSets default date value for the input field
DisabledbooleanDisables the component
Read OnlybooleanIf set to true, makes your checkbox unavailable to interact with
EditablebooleanIf set to true, the date can be entered via the keyboard
FormatstringFormat of the date when rendered in the input (e.g., yyyy-MM-dd)
ISO WeekbooleanEnables ISO 8601 standard, starts each week with Monday when checked
Limit End YearnumberMaximum selectable year based on the currently selected date
Limit Start YearnumberMinimum selectable year based on the currently selected date
One tapbooleanOne click to complete the selection value
OpenbooleanWhether open the calendar; correlates with the default open property
PlaceholderstringPlaceholder string
PlacementchoiceSelect the placement of component (e.g., bottom end, top start, etc.)
Prevent OverflowbooleanPrevents floating element overflow
Show meridianbooleanIf set to true, displays hours in 12 format
Show week numbersbooleanIf set to true, displays week numbers
SizechoiceSelect the size of the input field (e.g., large, small, etc.)
ValuedateProvide value for the input field

At the bottom of the Main properties menu, you can find additional options:

Style properties

These are properties that allow to customize the size, color and other style properties of your component:

  • For Device: You can provide component's style customization for all devices or specific devices by using this dropdown list. Refer to Adaptive Layout for more details.
  • Component > Class Name: Add a class name for your component for the subsequent styling if necessary.
  • Wrapper: The options below enable you to tailor the appearance of your component and customize it for a specific device type, as selected in the For Device property:

    NameTypeDescription
    WidthnumberSpecifies the width for your component
    HeightnumberSpecifies the height for your component
    Margin top/right/bottom/leftnumberMargin values for you component
    ColorstringAllows customizing the text color
    Background colorstringEnables customizing the background color
Stay in the know
Quickly Build Drag-and-Drop Forms
Star us on GitHub