-
Notifications
You must be signed in to change notification settings - Fork 3.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[docs]: Update circular progressbar (#9764)
* update: circular progress bar image * revert formatting * fix: grammer and removed img
- Loading branch information
1 parent
e07f96a
commit 7fe653e
Showing
7 changed files
with
90 additions
and
133 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
85 changes: 39 additions & 46 deletions
85
docs/versioned_docs/version-2.30.0/widgets/circular-progressbar.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,87 +1,80 @@ | ||
| --- | ||
| id: circular-progress-bar | ||
| title: Circular Progress Bar | ||
| title: Circular Progressbar | ||
| --- | ||
| # Circular Progress Bar | ||
| # Circular Progressbar | ||
|
|
||
| Circular progress bar widget can be used to show progress in a progress circle. | ||
| The Circular Progressbar component can be used to show progress in a progress circle. | ||
|
|
||
| <div style={{textAlign: 'center'}}> | ||
|
|
||
| <img className="screenshot-full" src="/img/widgets/circular-progressbar/cpb.png" alt="ToolJet - Widget Reference - Circular progress bar" /> | ||
|
|
||
| </div> | ||
| <div style={{paddingTop:'24px', paddingBottom:'24px'}}> | ||
|
|
||
| ## Properties | ||
|
|
||
| :::info | ||
| Any property having `Fx` button next to its field can be **programmatically configured**. | ||
| ::: | ||
|
|
||
| <div style={{textAlign: 'center'}}> | ||
|
|
||
| <img className="screenshot-full" src="/img/widgets/circular-progressbar/prop.png" alt="ToolJet - Widget Reference - Circular progress bar" /> | ||
| | <div style={{ width:"100px"}}> Properties </div> | <div style={{ width:"100px"}}> Description </div> | <div style={{ width:"135px"}}> Expected Value </div> | | ||
| | ----------- | ----------- | --------------- | | ||
| | Text | Sets a text inside the progress circle.| It expects a `String`, you can also use js to dynamically update the text as the progress changes. | | ||
| | Progress | Sets the progress of the widget. | Progress should be an integer between 0 and 100.| | ||
|
|
||
| </div> | ||
|
|
||
| | properties | description | Expected Value | | ||
| | ----------- | ----------- | --------------- | | ||
| | Text | We can set a text inside the progress circle.| It expects a `String`, you can also use js to dynamically update the text as the progress changes. | | ||
| | Progress | It can be used to set the progress of the widget. | Progress should be an integer between 0 and 100.| | ||
| <div style={{paddingTop:'24px', paddingBottom:'24px'}}> | ||
|
|
||
| ## Component Specific Actions (CSA) | ||
|
|
||
| ### General | ||
| #### Tooltip | ||
| There are currently no CSA (Component-Specific Actions) implemented to regulate or control the component. | ||
|
|
||
| A Tooltip is often used to specify extra information about something when the user hovers the mouse pointer over the widget. | ||
| </div> | ||
|
|
||
| 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. | ||
| <div style={{paddingTop:'24px', paddingBottom:'24px'}}> | ||
|
|
||
| <div style={{textAlign: 'center'}}> | ||
| ## Exposed Variables | ||
|
|
||
| <img className="screenshot-full" src="/img/tooltip.png" alt="ToolJet - Widget Reference - Circular progress bar" /> | ||
| There are currently no exposed variables for the component. | ||
|
|
||
| </div> | ||
|
|
||
| ## Layout | ||
| <div style={{paddingTop:'24px', paddingBottom:'24px'}}> | ||
|
|
||
| ## General | ||
| ### Tooltip | ||
|
|
||
| <div style={{textAlign: 'center'}}> | ||
| A Tooltip is often used to specify extra information about something when the user hovers the mouse pointer over the component. | ||
|
|
||
| <img className="screenshot-full" src="/img/widgets/circular-progressbar/layout.png" alt="ToolJet - Widget Reference - Circular progress bar" /> | ||
| 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. | ||
|
|
||
| </div> | ||
|
|
||
| | Layout | description | | ||
| <div style={{paddingTop:'24px', paddingBottom:'24px'}}> | ||
|
|
||
| ## Layout | ||
|
|
||
| | <div style={{ width:"100px"}}> Layout </div> | <div style={{ width:"100px"}}> Description </div> | | ||
| | ----------- | ----------- | | ||
| | Show on desktop | Toggle on or off to display the widget in desktop view. You can programmatically determine the value by clicking on Fx to set the value `{{true}}` or `{{false}}`. | | ||
| | Show on mobile | Toggle on or off to display the widget in mobile view. You can programmatically determine the value by clicking on Fx to set the value `{{true}}` or `{{false}}`. | | ||
|
|
||
| ## Styles | ||
|
|
||
| <div style={{textAlign: 'center'}}> | ||
| </div> | ||
|
|
||
| <img className="screenshot-full" src="/img/widgets/circular-progressbar/styles.png" alt="ToolJet - Widget Reference - Circular progress bar" /> | ||
| <div style={{paddingTop:'24px', paddingBottom:'24px'}}> | ||
|
|
||
| </div> | ||
| ## Styles | ||
|
|
||
| | properties | description | Expected Value | | ||
| | <div style={{ width:"100px"}}> Property </div> | <div style={{ width:"100px"}}> Description </div> | <div style={{ width:"135px"}}> Expected Value </div> | | ||
| | ----------- | ----------- | ------------------- | | ||
| | Color | To define stroke color.| `HEX color code` or choose color from color-picker. | | ||
| | Text color | To define color of the text inside circular progress bar.| `HEX color code` or choose color from color-picker. | | ||
| | Text size | To define the size of the text | Value must between 0-100. | | ||
| | Stroke width | To define the width of stroke | Value must between 0-100.| | ||
| | Counter Clockwise | Whether to rotate progress bar in counterclockwise direction. | It accepts `{{true}}` and `{{false}}`, Default value is `false`.| | ||
| | Circle ratio | To define ratio of the full circle diameter the progressbar should use. | It accepts numerical value and the default is `1`. | | ||
| | Visibility | Toggle on or off to control the visibility of the widget. | You can programmatically change its value by clicking on the `Fx` button next to it. If `{{false}}` the widget will not be visible after the app is deployed. By default, it's set to `{{true}}`. | | ||
| | Color | Defines stroke color.| `HEX color code` or choose color from color-picker. | | ||
| | Text color | Defines color of the text inside circular progress bar.| `HEX color code` or choose color from color-picker | | ||
| | Text size | Defines the size of the text | Value must between 0-100 | | ||
| | Stroke width | Defines the width of stroke | Value must between 0-100| | ||
| | Counter clockwise | Whether to rotate progress bar in counterclockwise direction. | Accepts `{{true}}` and `{{false}}`, Default value is `false`| | ||
| | Circle ratio | Defines ratio of the full circle diameter the progressbar should use. | Accepts numerical value and the default is `1` | | ||
| | Visibility | Toggle on or off to control the visibility of the widget. | Programmatically change its value by clicking on the `Fx` button next to it. If `{{false}}` the widget will not be visible after the app is deployed. By default, it's set to `{{true}}` | | ||
|
|
||
| :::info | ||
| Circular progress bar widget uses [react-circular-progress](https://github.com/kevinsqi/react-circular-progressbar) package. Check the repo for further more details about properties and styles. | ||
| ::: | ||
|
|
||
|
|
||
| ## Exposed variables | ||
|
|
||
| There are currently no exposed variables for the component. | ||
|
|
||
| ## Component specific actions (CSA) | ||
|
|
||
| There are currently no CSA (Component-Specific Actions) implemented to regulate or control the component. | ||
| </div> |
85 changes: 39 additions & 46 deletions
85
docs/versioned_docs/version-2.33.0/widgets/circular-progressbar.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,87 +1,80 @@ | ||
| --- | ||
| id: circular-progress-bar | ||
| title: Circular Progress Bar | ||
| title: Circular Progressbar | ||
| --- | ||
| # Circular Progress Bar | ||
| # Circular Progressbar | ||
|
|
||
| Circular progress bar widget can be used to show progress in a progress circle. | ||
| The Circular Progressbar component can be used to show progress in a progress circle. | ||
|
|
||
| <div style={{textAlign: 'center'}}> | ||
|
|
||
| <img className="screenshot-full" src="/img/widgets/circular-progressbar/cpb.png" alt="ToolJet - Widget Reference - Circular progress bar" /> | ||
|
|
||
| </div> | ||
| <div style={{paddingTop:'24px', paddingBottom:'24px'}}> | ||
|
|
||
| ## Properties | ||
|
|
||
| :::info | ||
| Any property having `Fx` button next to its field can be **programmatically configured**. | ||
| ::: | ||
|
|
||
| <div style={{textAlign: 'center'}}> | ||
|
|
||
| <img className="screenshot-full" src="/img/widgets/circular-progressbar/prop.png" alt="ToolJet - Widget Reference - Circular progress bar" /> | ||
| | <div style={{ width:"100px"}}> Properties </div> | <div style={{ width:"100px"}}> Description </div> | <div style={{ width:"135px"}}> Expected Value </div> | | ||
| | ----------- | ----------- | --------------- | | ||
| | Text | Sets a text inside the progress circle.| It expects a `String`, you can also use js to dynamically update the text as the progress changes. | | ||
| | Progress | Sets the progress of the widget. | Progress should be an integer between 0 and 100.| | ||
|
|
||
| </div> | ||
|
|
||
| | properties | description | Expected Value | | ||
| | ----------- | ----------- | --------------- | | ||
| | Text | We can set a text inside the progress circle.| It expects a `String`, you can also use js to dynamically update the text as the progress changes. | | ||
| | Progress | It can be used to set the progress of the widget. | Progress should be an integer between 0 and 100.| | ||
| <div style={{paddingTop:'24px', paddingBottom:'24px'}}> | ||
|
|
||
| ## Component Specific Actions (CSA) | ||
|
|
||
| ### General | ||
| #### Tooltip | ||
| There are currently no CSA (Component-Specific Actions) implemented to regulate or control the component. | ||
|
|
||
| A Tooltip is often used to specify extra information about something when the user hovers the mouse pointer over the widget. | ||
| </div> | ||
|
|
||
| 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. | ||
| <div style={{paddingTop:'24px', paddingBottom:'24px'}}> | ||
|
|
||
| <div style={{textAlign: 'center'}}> | ||
| ## Exposed Variables | ||
|
|
||
| <img className="screenshot-full" src="/img/tooltip.png" alt="ToolJet - Widget Reference - Circular progress bar" /> | ||
| There are currently no exposed variables for the component. | ||
|
|
||
| </div> | ||
|
|
||
| ## Layout | ||
| <div style={{paddingTop:'24px', paddingBottom:'24px'}}> | ||
|
|
||
| ## General | ||
| ### Tooltip | ||
|
|
||
| <div style={{textAlign: 'center'}}> | ||
| A Tooltip is often used to specify extra information about something when the user hovers the mouse pointer over the component. | ||
|
|
||
| <img className="screenshot-full" src="/img/widgets/circular-progressbar/layout.png" alt="ToolJet - Widget Reference - Circular progress bar" /> | ||
| 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. | ||
|
|
||
| </div> | ||
|
|
||
| | Layout | description | | ||
| <div style={{paddingTop:'24px', paddingBottom:'24px'}}> | ||
|
|
||
| ## Layout | ||
|
|
||
| | <div style={{ width:"100px"}}> Layout </div> | <div style={{ width:"100px"}}> Description </div> | | ||
| | ----------- | ----------- | | ||
| | Show on desktop | Toggle on or off to display the widget in desktop view. You can programmatically determine the value by clicking on Fx to set the value `{{true}}` or `{{false}}`. | | ||
| | Show on mobile | Toggle on or off to display the widget in mobile view. You can programmatically determine the value by clicking on Fx to set the value `{{true}}` or `{{false}}`. | | ||
|
|
||
| ## Styles | ||
|
|
||
| <div style={{textAlign: 'center'}}> | ||
| </div> | ||
|
|
||
| <img className="screenshot-full" src="/img/widgets/circular-progressbar/styles.png" alt="ToolJet - Widget Reference - Circular progress bar" /> | ||
| <div style={{paddingTop:'24px', paddingBottom:'24px'}}> | ||
|
|
||
| </div> | ||
| ## Styles | ||
|
|
||
| | properties | description | Expected Value | | ||
| | <div style={{ width:"100px"}}> Property </div> | <div style={{ width:"100px"}}> Description </div> | <div style={{ width:"135px"}}> Expected Value </div> | | ||
| | ----------- | ----------- | ------------------- | | ||
| | Color | To define stroke color.| `HEX color code` or choose color from color-picker. | | ||
| | Text color | To define color of the text inside circular progress bar.| `HEX color code` or choose color from color-picker. | | ||
| | Text size | To define the size of the text | Value must between 0-100. | | ||
| | Stroke width | To define the width of stroke | Value must between 0-100.| | ||
| | Counter Clockwise | Whether to rotate progress bar in counterclockwise direction. | It accepts `{{true}}` and `{{false}}`, Default value is `false`.| | ||
| | Circle ratio | To define ratio of the full circle diameter the progressbar should use. | It accepts numerical value and the default is `1`. | | ||
| | Visibility | Toggle on or off to control the visibility of the widget. | You can programmatically change its value by clicking on the `Fx` button next to it. If `{{false}}` the widget will not be visible after the app is deployed. By default, it's set to `{{true}}`. | | ||
| | Color | Defines stroke color.| `HEX color code` or choose color from color-picker. | | ||
| | Text color | Defines color of the text inside circular progress bar.| `HEX color code` or choose color from color-picker | | ||
| | Text size | Defines the size of the text | Value must between 0-100 | | ||
| | Stroke width | Defines the width of stroke | Value must between 0-100| | ||
| | Counter clockwise | Whether to rotate progress bar in counterclockwise direction. | Accepts `{{true}}` and `{{false}}`, Default value is `false`| | ||
| | Circle ratio | Defines ratio of the full circle diameter the progressbar should use. | Accepts numerical value and the default is `1` | | ||
| | Visibility | Toggle on or off to control the visibility of the widget. | Programmatically change its value by clicking on the `Fx` button next to it. If `{{false}}` the widget will not be visible after the app is deployed. By default, it's set to `{{true}}` | | ||
|
|
||
| :::info | ||
| Circular progress bar widget uses [react-circular-progress](https://github.com/kevinsqi/react-circular-progressbar) package. Check the repo for further more details about properties and styles. | ||
| ::: | ||
|
|
||
|
|
||
| ## Exposed variables | ||
|
|
||
| There are currently no exposed variables for the component. | ||
|
|
||
| ## Component specific actions (CSA) | ||
|
|
||
| There are currently no CSA (Component-Specific Actions) implemented to regulate or control the component. | ||
| </div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters