Skip to content

Types for Slider and docs updated #643

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

Merged
merged 1 commit into from
Feb 2, 2022
Merged

Types for Slider and docs updated #643

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
55 changes: 34 additions & 21 deletions .../components/examples/slider/properties/slider-properties/slider-properties.component.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,23 @@
<td><code>1</code></td>
<td>The step interval between values available for selection.</td>
</tr>
<tr>
<td>label: string</td>
<td></td>
<td>Text to be placed above the slider.</td>
</tr>
<tr>
<td>helperText: string</td>
<td></td>
<td>Helper text to be placed above the slider.</td>
</tr>
<tr>
<td>value: number</td>
<td><code>0</code></td>
<td>The selected value.</td>
<td></td>
<td>
The selected value. If undefined, the component will be uncontrolled and
the value will be managed internally by the component.
</td>
</tr>
<tr>
<td>marks: boolean</td>
Expand Down Expand Up @@ -61,35 +74,32 @@
<td>If true, the component will be disabled.</td>
</tr>
<tr>
<td>labelFormatCallback: (value: number) => string | number</td>
<td>labelFormatCallback: function</td>
<td></td>
<td>Function used to format minimum and maximum labels.</td>
</tr>
<tr>
<td>tabIndexValue: number</td>
<td><code>0</code></td>
<td>Value of the tabindex</td>
<td>
This function will be used to format the labels displayed next to the
slider. The value will be passed as parameter and the function must return
the formatted value.
</td>
</tr>
<tr>
<td>valueChange: EventEmitter</td>
<td>onChange: EventEmitter</td>
<td></td>
<td>
This function will be called when the slider changes its value, as it's
being dragged. The new value will be passed as a parameter when this
function is executed.
This event will emit in case the slider changes its value, as it's being
dragged. The new value will be passed as a parameter.
</td>
</tr>
<tr>
<td>onDragEnd: EventEmitter</td>
<td></td>
<td>
This function will be called when the slider changes its value, but only
when the thumb is released. The new value will be passed as a parameter
when this function is executed.
This event will emit in case the slider changes its value, but only when
the thumb is released. The new value will be passed as a parameter.
</td>
</tr>
<tr>
<td>margin: any (string | object)</td>
<td>margin: string | object</td>
<td></td>
<td>
Size of the margin to be applied to the component ('xxsmall' | 'xsmall' |
Expand All @@ -99,10 +109,13 @@
</td>
</tr>
<tr>
<td>size: string | object</td>
<td>size: string</td>
<td><code>'fillParent'</code></td>
<td>
Size of the component ('medium' | 'large' | 'fillParent' | 'fitContent').
</td>
<td>Size of the component.</td>
</tr>
<tr>
<td>tabIndexValue: number</td>
<td><code>0</code></td>
<td>Value of the tabindex</td>
</tr>
</dxc-table>
Loading