Skip to content
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.

Sign up for GitHub

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

Updates docs based on new TimePicker seconds support #518

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Updates docs based on new TimePicker seconds support #518

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/basics/user-interface/controls/builtin-controls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ These controls display repeating data, in either a tabular or list format:
|[CalendarDatePicker](../../../reference/controls/calendar/calendar-date-picker.md)|DateTime|An extension of the calendar control that includes a text box and button.|
|[ColorPicker](../../../reference/controls/colorpicker)|Color / HsvColor|The color picker supports user-selection and editing of colors using a spectrum, palette and component sliders. It also supports an optional alpha component, RGB or HSV color models and hexadecimal color values.|
|[DatePicker](../../../reference/controls/datepicker.md)|DateTime|The date picker has three 'spinner' controls to allow the user to pick a date value.|
|[TimePicker](../../../reference/controls/timepicker.md)|TimeSpan|The time picker has three 'spinner' controls to allow the user to pick a time from hours, minutes and seconds.|
|[TimePicker](../../../reference/controls/timepicker.md)|TimeSpan|The time picker has two to four 'spinner' controls to allow the user to pick a time from hours, minutes and seconds.|

## Displaying images

Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/wpf/comparison-of-avalonia-with-wpf-and-uwp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ This section describes the differences in controls in vanilla WPF and UWP (with
| ✖ | ✖ | TeachingTip | First introduced in the Windows UI Library |
| TextBlock | TextBlock | TextBlock | |
| TextBox | TextBox | TextBox | |
| TimePicker | ✖ | TimePicker | |
| TimePicker | ✖ | TimePicker | Avalonia's TimePicker is very similar to UWP's but additionally, optionally, supports seconds |
| TimePickerFlyout | ✖ | TimePickerFlyout | |
| ToggleButton | ToggleButton | ToggleButton | |
| ✖ | ✖ | ToggleSplitButton | First introduced in the Windows UI Library |
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/controls/timepicker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ import TimePickerScreenshot from '/img/reference/controls/timepicker/timepicker.

# TimePicker

The `TimePicker` has two or three 'spinner' controls to allow the user to pick a time value. The time picker can work in 24 or 12 hour formats. The picker controls display when the control is clicked.
The `TimePicker` has two to four 'spinner' controls to allow the user to pick a time value. The time picker can work in 24 or 12 hour formats and supports hours, minutes, and seconds. The picker controls display when the control is clicked.

## Useful Properties

You will probably use these properties most often:

<table><thead><tr><th width="231">Property</th><th>Description</th></tr></thead><tbody><tr><td><code>ClockIdentifier</code></td><td>Choose between 12 and 24 hour formats. The 12 hour format shows a third spinner for AM/PM.</td></tr><tr><td><code>MinuteIncrement</code></td><td>Defines selectable increments for the minutes. The default is 1 (all minutes can be selected).</td></tr><tr><td><code>SelectedTime</code></td><td>(Nullable TimeSpan) the selected time.</td></tr></tbody></table>
<table><thead><tr><th width="231">Property</th><th>Description</th></tr></thead><tbody><tr><td><code>ClockIdentifier</code></td><td>Choose between 12 and 24 hour formats. The 12 hour format shows an additional spinner for AM/PM.</td></tr><tr><td><code>UseSeconds</code></td><td>Shows an additional spinner for seconds when true. The default is false (seconds spinner is not shown).</td></tr><tr><td><code>MinuteIncrement</code></td><td>Defines selectable increments for the minutes. The default is 1 (all minutes can be selected).</td></tr><tr><td><code>SecondIncrement</code></td><td>Defines selectable increments for the seconds. The default is 1 (all seconds can be selected).</td></tr><tr><td><code>SelectedTime</code></td><td>(Nullable TimeSpan) the selected time.</td></tr></tbody></table>

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/controls/value-selector-controls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ description: REFERENCE

These controls provide a graphical presentation to represent a value of a specific type. They also provide some kind of graphical interaction to change the value.

<table><thead><tr><th width="208.33333333333331">Control</th><th width="119">Type</th><th>Description</th></tr></thead><tbody><tr><td><a href="checkbox">CheckBox</a></td><td>Boolean</td><td>True value presented as a check mark. Click interaction toggles the value. Has an option to display an 'unknown' value.</td></tr><tr><td><a href="slider">Slider</a></td><td>Double</td><td>Relative value compared to a maximum and minimum value presented as the position along the length of the slider track of the slider button. Drag interaction on the slider button can alter the value between the maximum and minimum values. Keyboard and click interactions can also nudge the value.</td></tr><tr><td><a href="./calendar/">Calendar</a></td><td>DateTime</td><td>The calendar is a control for users to select dates or date ranges.</td></tr><tr><td><a href="./calendar/calendar-date-picker">CalendarDatePicker</a></td><td>DateTime</td><td>An extension of the calendar control that includes a text box and button.</td></tr><tr><td><a href="datepicker">DatePicker</a></td><td>DateTime</td><td>The date picker has three 'spinner' controls to allow the user to pick a date value.</td></tr><tr><td><a href="./timepicker">TimePicker</a></td><td>TimeSpan</td><td>The time picker has three 'spinner' controls to allow the user to pick a time from hours, minutes and seconds. </td></tr></tbody></table>
<table><thead><tr><th width="208.33333333333331">Control</th><th width="119">Type</th><th>Description</th></tr></thead><tbody><tr><td><a href="checkbox">CheckBox</a></td><td>Boolean</td><td>True value presented as a check mark. Click interaction toggles the value. Has an option to display an 'unknown' value.</td></tr><tr><td><a href="slider">Slider</a></td><td>Double</td><td>Relative value compared to a maximum and minimum value presented as the position along the length of the slider track of the slider button. Drag interaction on the slider button can alter the value between the maximum and minimum values. Keyboard and click interactions can also nudge the value.</td></tr><tr><td><a href="./calendar/">Calendar</a></td><td>DateTime</td><td>The calendar is a control for users to select dates or date ranges.</td></tr><tr><td><a href="./calendar/calendar-date-picker">CalendarDatePicker</a></td><td>DateTime</td><td>An extension of the calendar control that includes a text box and button.</td></tr><tr><td><a href="datepicker">DatePicker</a></td><td>DateTime</td><td>The date picker has three 'spinner' controls to allow the user to pick a date value.</td></tr><tr><td><a href="./timepicker">TimePicker</a></td><td>TimeSpan</td><td>The time picker has two to four 'spinner' controls to allow the user to pick a time from hours, minutes and seconds. </td></tr></tbody></table>