Home Docs

TimePicker

A BitTimePicker offers a drop-down control that’s optimized for picking a single time from a clock view where contextual information like the day of the week or fullness of the calendar is important. You can modify the calendar to provide additional context or to limit available times.

Usage

Basic
Explore the basic usage of the BitTimePicker component, including a disabled state and a placeholder option.







Time format
Use of different time formats in the BitTimePicker, specifically the 12-hour (AM/PM) and 24-hour formats.


Text input
The input field will open the BitTimePicker, and clicking the field again will dismiss the BitTimePicker and allow text input. Please note to use this feature, you must enter the time in the exact TimeFormat provided for the BitTimePicker.
Icon
Customize the icon of the BitTimePicker, including placing the icon on either the left or right side.


Formatting
Applications can customize how times are formatted and parsed. Formatted times can be ambiguous, so the control will avoid parsing the formatted strings of times selected using the UI when text input is allowed. In this example, we are formatting and parsing times as hh-mm.ss.
Binding
Bind the selected time value of the BitTimePicker to a variable and display the selected time below the picker.

Selected time: 05:12:15
Standalone
Use the BitTimePicker as a standalone component, including options for time format and disabled state.



ReadOnly
The ReadOnly parameter makes the time picker input non-editable, preventing users from manually changing the time value.







Validation
Validation will happen when the Submit button is clicked. This example demonstrates how to use the BitTimePicker within a form to validate the selected time.


Responsive
Enable responsive design for the BitTimePicker, allowing it to adjust its layout and appearance based on the screen size.

Templates
Customize the BitTimePicker using templates, including a custom label template with an action button and a custom icon template.



Hour/minute step
Customize the hour and minute steps in the BitTimePicker, allowing users to increment time by a specified interval.


Style & Class
Explore styling and class customization for BitTimePicker, including component styles, custom classes, and detailed styles.


Component's Style & Class:





Styles & Classes:


RTL
Use BitTimePicker in right-to-left (RTL).



API

BitTimePicker parameters
Name
Type
Default value
Description
AllowTextInput bool false Whether the TimePicker allows input a time string directly or not.
CalloutAriaLabel string Clock Aria label for time picker popup for screen reader users.
CalloutHtmlAttributes Dictionary<string, object> new Dictionary<String, Object>() Capture and render additional attributes in addition to the main callout's parameters.
Classes BitTimePickerClassStyles null Custom CSS classes for different parts of the TimePicker.
CloseButtonTitle string Close time picker The title of the close button (tooltip).
Culture CultureInfo CultureInfo.CurrentUICulture CultureInfo for the TimePicker.
DropDirection BitDropDirection BitDropDirection.TopAndBottom Determines the allowed drop directions of the callout.
HasBorder bool true Determines if the TimePicker has a border.
HourStep int 1 Determines increment/decrement steps for time-picker's hour.
IconName string Clock Optional TimePicker icon.
IconLocation BitIconLocation BitIconLocation.Right TimePicker icon location.
IconTemplate RenderFragment? null Custom TimePicker icon template.
IsOpen bool false Whether or not this TimePicker is open.
Label string? null Label for the TimePicker.
LabelTemplate RenderFragment? null Used to customize the label for the TimePicker.
MinuteStep int 1 Determines increment/decrement steps for time-picker's minute.
OnClick EventCallback Callback for when clicking on TimePicker input.
OnFocus EventCallback Callback for when focus moves into the TimePicker input.
OnFocusIn EventCallback Callback for when focus moves into the TimePicker input.
OnFocusOut EventCallback Callback for when clicking on TimePicker input.
OnSelectTime EventCallback<TimeSpan?> Callback for when the on selected time changed.
Placeholder string? null Placeholder text for the DatePicker.
Responsive bool false Enables the responsive mode in small screens.
ShowCloseButton bool false Whether the BitTimePicker's close button should be shown or not.
Styles BitTimePickerClassStyles null Custom CSS styles for different parts of the TimePicker.
Standalone bool false Whether the BitTimePicker is rendered standalone or with the input component and callout.
TabIndex int 0 The tabIndex of the TextField.
TimeFormat BitTimeFormat BitTimeFormat.TwentyFourHours The time format of the time-picker, 24H or 12H.
Underlined bool false Whether or not the Text field of the TimePicker is underlined.
ValueFormat string? null The format of the time in the TimePicker like "HH:mm".
BitInputBase parameters
Name
Type
Default value
Description
DisplayName string? null Gets or sets the display name for this field.
InputHtmlAttributes IReadOnlyDictionary<string, object>? null Gets or sets a collection of additional attributes that will be applied to the created element.
Name string? null Gets or sets the name of the element. Allows access by name from the associated form.
NoValidate bool false Disables the validation of the input.
OnChange EventCallback<TValue?> Callback for when the input value changes.
ReadOnly bool false Makes the input read-only.
Required bool false Makes the input required.
Value TValue? null Gets or sets the value of the input. This should be used with two-way binding.
BitInputBase public members
Name
Type
Default value
Description
InputElement ElementReference The ElementReference of the input element.
FocusAsync() () => ValueTask Gives focus to the input element.
FocusAsync(bool preventScroll) (bool preventScroll) => ValueTask Gives focus to the input element.
BitComponentBase parameters
Name
Type
Default value
Description
AriaLabel string? null The aria-label of the control for the benefit of screen readers.
Class string? null Custom CSS class for the root element of the component.
Dir BitDir? null Determines the component direction.
HtmlAttributes Dictionary<string, object> new Dictionary<string, object>() Capture and render additional attributes in addition to the component's parameters.
Id string? null Custom id attribute for the root element. if null the UniqueId will be used instead.
IsEnabled bool true Whether or not the component is enabled.
Style string? null Custom CSS style for the root element of the component.
Visibility BitVisibility BitVisibility.Visible Whether the component is visible, hidden or collapsed.
BitComponentBase public members
Name
Type
Default value
Description
UniqueId Guid Guid.NewGuid() The readonly unique id of the root element. it will be assigned to a new Guid at component instance construction.
RootElement ElementReference The ElementReference of the root element.
BitTimePickerClassStyles properties
Name
Type
Default value
Description
Root string? null Custom CSS classes/styles for the root element of the BitTimePicker.
Focused string? null Custom CSS classes/styles for the focused state of the BitTimePicker.
Label string? null Custom CSS classes/styles for the Label of the BitTimePicker.
InputWrapper string? null Custom CSS classes/styles for the input wrapper of the BitTimePicker.
InputContainer string? null Custom CSS classes/styles for the input container of the BitTimePicker.
Input string? null Custom CSS classes/styles for the input of the BitTimePicker.
Icon string? null Custom CSS classes/styles for the icon of the BitTimePicker.
Overlay string? null Custom CSS classes/styles for the overlay of the BitTimePicker.
Callout string? null Custom CSS classes/styles for the callout of the BitTimePicker.
CalloutContainer string? null Custom CSS classes/styles for the callout container of the BitTimePicker.
TimeInputContainer string? null Custom CSS classes/styles for the time input container of the BitTimePicker.
HourInputContainer string? null Custom CSS classes/styles for the hour input container of the BitTimePicker.
IncreaseHourButton string? null Custom CSS classes/styles for the increase hour button of the BitTimePicker.
IncreaseHourIcon string? null Custom CSS classes/styles for the increase hour icon of the BitTimePicker.
HourInput string? null Custom CSS classes/styles for the hour input of the BitTimePicker.
DecreaseHourButton string? null Custom CSS classes/styles for the decrease hour button of the BitTimePicker.
DecreaseHourIcon string? null Custom CSS classes/styles for the decrease hour icon of the BitTimePicker.
HourMinuteSeparator string? null Custom CSS classes/styles for the hour minute separator of the BitTimePicker.
MinuteInputContainer string? null Custom CSS classes/styles for the minute input container of the BitTimePicker.
IncreaseMinuteButton string? null Custom CSS classes/styles for the increase minute button of the BitTimePicker.
IncreaseMinuteIcon string? null Custom CSS classes/styles for the increase minute icon of the BitTimePicker.
MinuteInput string? null Custom CSS classes/styles for the minute input of the BitTimePicker.
DecreaseMinuteButton string? null Custom CSS classes/styles for the decrease minute button of the BitTimePicker.
DecreaseMinuteIcon string? null Custom CSS classes/styles for the decrease minute icon of the BitTimePicker.
AmPmContainer string? null Custom CSS classes/styles for the AM/PM container of the BitTimePicker.
AmButton string? null Custom CSS classes/styles for the AM button of the BitTimePicker.
PmButton string? null Custom CSS classes/styles for the PM button of the BitTimePicker.
CloseButton string? null Custom CSS classes/styles for the close button of the BitTimePicker.
CloseButtonIcon string? null Custom CSS classes/styles for the close button icon of the BitTimePicker.
BitVisibility enum
Name
Value
Description
Visible 0 Show content of the component.
Hidden 1 Hide content of the component,though the space it takes on the page remains.
Collapsed 2 Hide content of the component,though the space it takes on the page gone.
BitIconLocation enum
Name
Value
Description
Left 0 Show the icon at the left side.
Right 1 Show the icon at the right side.
BitTimePickerEditMode enum
Name
Value
Description
Normal 0 Can edit hours and minutes.
OnlyMinutes 1 Can edit only minutes.
OnlyHours 1 Can edit only hours.
BitTimeFormat enum
Name
Value
Description
TwentyFourHours 0 Show time pickers in 24 hours format.
TwelveHours 1 Show time pickers in 12 hours format.
BitDropDirection enum
Name
Value
Description
All 0 The direction determined automatically based on the available spaces in all directions.
TopAndBottom 1 Show the callout at the top or bottom side.
BitVisibility enum
Name
Value
Description
Visible 0 The content of the component is visible.
Hidden 1 The content of the component is hidden, but the space it takes on the page remains (visibility:hidden).
Collapsed 2 The component is hidden (display:none).
BitDir enum
Name
Value
Description
Ltr 0 Ltr (left to right) is to be used for languages that are written from the left to the right (like English).
Rtl 1 Rtl (right to left) is to be used for languages that are written from the right to the left (like Arabic).
Auto 2 Auto lets the user agent decide. It uses a basic algorithm as it parses the characters inside the element until it finds a character with a strong directionality, then applies that directionality to the whole element.
  • On this page