Time Off Policies Settings Reference

The TimeOffSettings is the main entry point for users to configure and manage their time-off policies and settings.

The component shows an overview of the existing policies in an organization and exposes global settings that control how time off requests are handled.

Policy settings interface showing policy details, employee assignments, and configuration options

Basic Implementation

React

iframe

Users must visit the settings page to configure their time-off policies, or you can create default using the Time Off Policies API.

Component Behavior

The TimeOffSettings component is the main entry point for all time off-related features.

At the top of the screen is a global toggle that enables or disables time off across the organization. If the global toggle is disabled, no employee will be able to request time off or view assigned balances.

Policy settings interface global configuration

Other global configuration options:

Whether managers are allowed to approve time off requests

Whether time off must be requested in advance, and the number of days required

Below the global settings is the time off policy table. This lists all policies defined for the account, including their name, type, whether they are paid or unpaid, and whether they have a b balance. Each policy shows how many employees are currently assigned and its current status. Refer to Time Off Management for more information about these options.

Policies can be edited or created directly from this view. Status toggles are used to enable or disable policies without removing them.

This screen is designed to be embedded as part of a settings menu or in combination with other settings pages.

Events and Callbacks

Event	Trigger	Payload
`onTimeOffPolicyCreate`	Admin creates a new time off policy	`time_off_policy` object
`onTimeOffPolicyEdit`	Admin modifies an existing time off policy	`time_off_policy` object
`onTimeOffPolicyDelete`	Admin deletes a time off policy	`time_off_policy` object
`onTimeOffPolicyEnable`	User activates a draft or inactive policy	`time_off_policy` object
`onTimeOffPolicyDisable`	User deactivates a policy	`time_off_policy` object

Component Properties

Property	Type	Required	Description
`goToPolicy`	`(policyId: string) => void`	Yes	Callback to navigate to a specific policy
`showTimeOffSettings`	`boolean`	Yes	Show or hide the time off settings page

💡

The TimeOffSettings component is the entry point to creating time-off policies. All other time-off related components will link their empty state to this settings page.

Time Off Policies Settings Reference

Basic Implementation#

Component Behavior#

Events and Callbacks#

Component Properties#

Basic Implementation

Component Behavior

Events and Callbacks

Component Properties