Elgato_dark/ToolJet
1
0
Fork 0
mirror of https://github.com/ToolJet/ToolJet synced 2026-05-24 09:28:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

[docs]: Update documentation for range slider (#10949)

Browse source 
* docs:Updated documentation for range slider

* Update fx in next version.

* Update fx in LTS version.

* Update range-slider.md next version

* Update range-slider.md

* Update range-slider.md versioned docs

---------

Co-authored-by: Pratik Agrawal <pratik@tooljet.com>
This commit is contained in:
avnish100 2024-10-15 12:16:31 +05:30 committed by GitHub
parent edcabe17e7
commit 72cbaf1b0f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 44 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
docs/docs/widgets/range-slider.md
View file

@ -4,13 +4,13 @@ title: Range Slider
---
# Range Slider
The **Range Slider** widget is widely used across different UIs. One of the main purposes is to filter, explore all the related content and available in the control and settings options.
The **Range Slider** component is widely used across different UIs. One of the main purposes is to filter, explore all the related content and available in the control and settings options.
:::tip
Range Sliders have "Two handles" option which allows user to select within a range.
Range Sliders have **Two handles** option which allows users to select a range.
:::
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
<div style={{paddingTop:'24px'}}>
## Properties
@ -18,12 +18,12 @@ Range Sliders have "Two handles" option which allows user to select within a ran
|:------------ |:-------------|
| Minimum value | Set the minimum value for the slider. This field accepts any numerical value. |
| Maximum value | Set the maximum value for the slider. This field accepts any numerical value. |
| Value | Set the default value when the widget loads. This can be used to pre-fill the value based on your data and requirements. |
| Value | Set the default value when the component loads. This can be used to pre-fill the value based on your data and requirements. |
| Two handles | The slider will now have 2 dragging handles. It is used to define a range of values versus a single given value. |
</div>
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
<div style={{paddingTop:'24px'}}>
## Component Specific Actions (CSA)
@ -31,7 +31,7 @@ There are currently no CSA (Component-Specific Actions) implemented to regulate
</div>
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
<div style={{paddingTop:'24px'}}>
## Exposed Variables
@ -41,41 +41,43 @@ There are currently no CSA (Component-Specific Actions) implemented to regulate
</div>
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
<div style={{paddingTop:'24px'}}>
## General
### Tooltip
A Tooltip is often used to specify extra information about something when the user hovers the mouse pointer over the widget.
A Tooltip is often used to specify extra information about something when the user hovers the mouse pointer over the component.
Under the <b>General</b> accordion, you can set the value in the string format. Now hovering over the widget will display the string as the tooltip.
Under the <b>General</b> accordion, you can set the value in the string format. Now hovering over the component will display the string as the tooltip.
</div>
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
<div style={{paddingTop:'24px'}}>
## Layout
## Devices
| <div style={{ width:"100px"}}> Layout </div> | <div style={{ width:"100px"}}> Description </div> | <div style={{ width:"135px"}}> Expected Value </div> |
| <div style={{ width:"100px"}}> Property </div> | <div style={{ width:"100px"}}> Description </div> | <div style={{ width:"135px"}}> Expected Value </div> |
|:--------------- |:----------------------------------------- | :------------------------------------------------------------------------------------------------------------- |
| Show on desktop | Toggle on or off to display desktop view. | You can programmatically determining the value by clicking on `Fx` to set the value `{{true}}` or `{{false}}` |
| Show on mobile | Toggle on or off to display mobile view. | You can programmatically determining the value by clicking on `Fx` to set the value `{{true}}` or `{{false}}` |
| Show on desktop | Makes the component visible in desktop view.| You can set it with the toggle button or dynamically configure the value by clicking on **fx** and entering a logical expression. |
| Show on mobile | Makes the component visible in mobile view. | You can set it with the toggle button or dynamically configure the value by clicking on **fx** and entering a logical expression. |
</div>
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
<div style={{paddingTop:'24px'}}>
---
## Styles
| <div style={{ width:"100px"}}> Style </div> | <div style={{ width:"100px"}}> Description </div> |
|:------------ |:-------------|
| Line color | Enter the hexcode to set the default color for slider's track. |
| Handle color | Enter the hexcode to set the color for slider's handler. |
| Track color | Enter the hexcode to set the color for slider's active portion on the track. |
| Line color | Enter the hex code to set the default color for the slider's track. |
| Handle color | Enter the hex code to set the color for the slider's handler. |
| Track color | Enter the hex code to set the color for the slider's active portion on the track. |
| Visibility | Set the visibility of the slider programmatically. The default value is `{{true}}`. |
:::info
Any property having `Fx` button next to its field can be **programmatically configured**.
Any property having **fx** button next to its field can be **programmatically configured**.
:::
</div>
</div>

42
docs/versioned_docs/version-2.50.0-LTS/widgets/range-slider.md
View file

@ -4,13 +4,13 @@ title: Range Slider
---
# Range Slider
The **Range Slider** widget is widely used across different UIs. One of the main purposes is to filter, explore all the related content and available in the control and settings options.
The **Range Slider** component is widely used across different UIs. One of the main purposes is to filter, explore all the related content and available in the control and settings options.
:::tip
Range Sliders have "Two handles" option which allows user to select within a range.
Range Sliders have **Two handles** option which allows users to select a range.
:::
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
<div style={{paddingTop:'24px'}}>
## Properties
@ -18,12 +18,12 @@ Range Sliders have "Two handles" option which allows user to select within a ran
|:------------ |:-------------|
| Minimum value | Set the minimum value for the slider. This field accepts any numerical value. |
| Maximum value | Set the maximum value for the slider. This field accepts any numerical value. |
| Value | Set the default value when the widget loads. This can be used to pre-fill the value based on your data and requirements. |
| Value | Set the default value when the component loads. This can be used to pre-fill the value based on your data and requirements. |
| Two handles | The slider will now have 2 dragging handles. It is used to define a range of values versus a single given value. |
</div>
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
<div style={{paddingTop:'24px'}}>
## Component Specific Actions (CSA)
@ -31,7 +31,7 @@ There are currently no CSA (Component-Specific Actions) implemented to regulate
</div>
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
<div style={{paddingTop:'24px'}}>
## Exposed Variables
@ -41,41 +41,43 @@ There are currently no CSA (Component-Specific Actions) implemented to regulate
</div>
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
<div style={{paddingTop:'24px'}}>
## General
### Tooltip
A Tooltip is often used to specify extra information about something when the user hovers the mouse pointer over the widget.
A Tooltip is often used to specify extra information about something when the user hovers the mouse pointer over the component.
Under the <b>General</b> accordion, you can set the value in the string format. Now hovering over the widget will display the string as the tooltip.
Under the <b>General</b> accordion, you can set the value in the string format. Now hovering over the component will display the string as the tooltip.
</div>
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
<div style={{paddingTop:'24px'}}>
## Layout
## Devices
| <div style={{ width:"100px"}}> Layout </div> | <div style={{ width:"100px"}}> Description </div> | <div style={{ width:"135px"}}> Expected Value </div> |
| <div style={{ width:"100px"}}> Property </div> | <div style={{ width:"100px"}}> Description </div> | <div style={{ width:"135px"}}> Expected Value </div> |
|:--------------- |:----------------------------------------- | :------------------------------------------------------------------------------------------------------------- |
| Show on desktop | Toggle on or off to display desktop view. | You can programmatically determining the value by clicking on `Fx` to set the value `{{true}}` or `{{false}}` |
| Show on mobile | Toggle on or off to display mobile view. | You can programmatically determining the value by clicking on `Fx` to set the value `{{true}}` or `{{false}}` |
| Show on desktop | Makes the component visible in desktop view. | You can set it with the toggle button or dynamically configure the value by clicking on **fx** and entering a logical expression. |
| Show on mobile | Makes the component visible in mobile view. | You can set it with the toggle button or dynamically configure the value by clicking on **fx** and entering a logical expression. |
</div>
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
<div style={{paddingTop:'24px'}}>
---
## Styles
| <div style={{ width:"100px"}}> Style </div> | <div style={{ width:"100px"}}> Description </div> |
|:------------ |:-------------|
| Line color | Enter the hexcode to set the default color for slider's track. |
| Handle color | Enter the hexcode to set the color for slider's handler. |
| Track color | Enter the hexcode to set the color for slider's active portion on the track. |
| Line color | Enter the hex code to set the default color for the slider's track. |
| Handle color | Enter the hex code to set the color for the slider's handler. |
| Track color | Enter the hex code to set the color for the slider's active portion on the track. |
| Visibility | Set the visibility of the slider programmatically. The default value is `{{true}}`. |
:::info
Any property having `Fx` button next to its field can be **programmatically configured**.
Any property having **fx** button next to its field can be **programmatically configured**.
:::
</div>
</div>