Docs
Calendar
Plugins
Current Time Indicator

Current time indicator

This plugin adds a current time indicator to the calendar. It will automatically update every minute.

Current time indicator

Install

npm i @schedule-x/current-time

Usage

import { createCurrentTimePlugin } from '@schedule-x/current-time'
 
const calendar = createCalendar(
  { /* calendar config */ },
  [createCurrentTimePlugin()]
)

Configuration

createCurrentTimePlugin({
  // Whether the indicator should be displayed in the full width of the week. Defaults to false
  fullWeekWidth: true,
 
  // Time zone offset in minutes. Can be any offset valid according to UTC (-720 to 840)
  timeZoneOffset: 120
})
Last updated on

We use cookies for marketing purposes. By clicking "Accept", you consent to the use of all cookies. If you decline, we will only use functional cookies. You can read more about our cookie policy here.