ToolJet/docs/versioned_docs/version-2.68.0/widgets/timer.md
Aman Regu bdfe3270e2
[docs]: v2.68.0-Beta (#10755)
* docs: jira

* docs: formatting + Client Credentials grant type

* docs: connection string pgsql

* docs: parameterized queries mysql

* docs: parameterized queries in PostgreSQL

* docs: update mysql example

* docs: TJDB sql editor

* docs: add metadata to REST API

* docs: add, update  postgresql media

* docs: add metadata to graphql

* docs: update parameterized queries

* docs: add parameterized queries for mssql

* docs: add SSL Cert to mysql

* docs: TJDB SQL restricted commands

* docs: update JIRA token location

* docs: update delete issue example

* docs: update find user by query example

* docs: remove session id from get assignable users

* docs: use correct image for get issues for board

* docs: update create issue example

* docs: update delete issue media

* docs: update assignable users media

* docs: update examples

* docs: update key desc

* docs: v2.68.0-Beta
2024-09-13 19:23:19 +05:30

3.7 KiB

id title
timer Timer

Timer

The Timer widget lets users to count timer both upward and downward

Properties

<div style={{ width:"100px"}}> Property <div style={{ width:"100px"}}> Description
Default value It specifies the initial value of timer. Format is: HH.mm.ss.SS.
Timer type It specifies If its a upward or downward counter. Select Count Up or Count Down from the dropdown or you can click on Fx to programmatically define the values countUp or countDown.

Events

<div style={{ width:"100px"}}> Event <div style={{ width:"100px"}}> Description
On start This event is fired when user clicks on start button.
On resume This event is fired when user clicks on resume button.
On pause This event is fired when user clicks on pause button.
On count down finish This event is fired when the count down timer reaches zero.
On reset This event is fired when user clicks on reset button.

:::info Check Action Reference docs to get the detailed information about all the Actions. :::

Component Specific Actions (CSA)

There are currently no CSA (Component-Specific Actions) implemented to regulate or control the component.

Exposed Variables

<div style={{ width:"100px"}}> Variables <div style={{ width:"100px"}}> Description <div style={{ width:"135px"}}> How To Access
value This variable holds the value of the timer in the following keys: hour, minute, second, and mSecond. Access the value dynamically using JS: {{components.timer1.value.second}}

General

Tooltip

A Tooltip is often used to specify extra information about something when the user hovers the mouse pointer over the widget.

Under the General accordion, you can set the value in the string format. Now hovering over the widget will display the string as the tooltip.

Layout

<div style={{ width:"100px"}}> Layout <div style={{ width:"100px"}}> Description <div style={{ width:"100px"}}> Expected Value
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}}

Styles

<div style={{ width:"100px"}}> Style <div style={{ width:"100px"}}> Description <div style={{ width:"100px"}}> Default Value
Visibility This is to control the visibility of the widget. If {{false}} the widget will not visible after the app is deployed. It can only have boolean values i.e. either {{true}} or {{false}}. By default, it's set to {{true}}.
Disable This property only accepts boolean values. If set to {{true}}, the widget will be locked and becomes non-functional. By default, its value is set to {{false}}.

:::info Any property having Fx button next to its field can be programmatically configured. :::