-
Notifications
You must be signed in to change notification settings - Fork 1.3k
DateBox: add Overview #7108
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DateBox: add Overview #7108
Conversation
concepts/05 UI Components/DateBox/01 Overview/10 Key Features.md
Outdated
Show resolved
Hide resolved
concepts/05 UI Components/DateBox/01 Overview/10 Key Features.md
Outdated
Show resolved
Hide resolved
Co-authored-by: dirkpieterse <dirk.pieterse@devexpress.com>
| @@ -0,0 +1,5 @@ | |||
| - **Customization** | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should mention all important features as other vendors do
We have at least two component in one so we will have a long list here
- DateBox Types
Describe the followings:
- type prop
- different types for value pickers
'calendar' | 'list' | 'native' | 'rollers'
-
Value Formating (Locale-dependent format, Built-in predefined formats, Custom Format String.
-
Masked Input (from Sveta's doc)
You can use the displayFormat property to define a mask that controls user input if useMaskBehavior is true.
- Date/Time Ranges OR Accepted Date Range (min, max props)
Example of the description from other landing:
By default, component has no limits and will accept any date the user provides. To limit the available dates users can select from, simply use min and max properties. They enable you to define the valid date ranges available within the component.
-
Date disabling
-
Calendar Options
Please describe the followings in one section or in different
firstDayOfWeek
minZoomLevel /maxZoomLevel & zoomLevel
selectionMode
selectWeekOnClick
showWeekNumbers & weekNumberRule -
Form Support and Value validation
Example of such description:
Form support and date validation
Date values are validated within a minimum and maximum range to enforce entering only a valid date value. In a form component, integrate the form validation plugin to perform custom validation in the date text box.
We can mention invalidDateMessage & dateOutOfRangeMessage
-
Adaptivity
(see adaptivityEnabled) -
A11y, KBN, RTL
-
Appearance settings
I found the following list of properties that set basic UI. I think we should mention them with short descriptions (you can try to shorten the list without loosing info)
- stylingMode
- label & labelMode
- placeholder
- opened
- buttons[], applyValueMode
- showClearButton & showDropDownButton
- buttons texts (applyButtonText, cancelButtonText, todayButtonText)
- dropDownOptions
- Customization
dropDownButtonTemplate
calendar cell template
| <img src="/images/DateBox/date-box-elements.png" alt="DateBox elements"/> | ||
|
|
||
| 1. [Date display format](/Documentation/ApiReference/UI_Components/dxDateBox/Configuration/#displayFormat) | ||
| 2. [Input buttons](/Documentation/ApiReference/UI_Components/dxDateBox/Configuration/buttons/) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's be more specific
Input buttons: Clear and DropDownButton
|
|
||
| 1. [Date display format](/Documentation/ApiReference/UI_Components/dxDateBox/Configuration/#displayFormat) | ||
| 2. [Input buttons](/Documentation/ApiReference/UI_Components/dxDateBox/Configuration/buttons/) | ||
| 3. [Format and UI type](/Documentation/ApiReference/UI_Components/dxDateBox/Configuration/#type) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should describe UI elements not API props on these pictures
So, it's better to remove 'Format and UI type' but add 'Calendar area OR Date picker: Calendar' and 'Time picker'
No description provided.