Availability settings

Archived Cal.com Atoms documentation for Availability settings. These deprecated SDK components are no longer maintained.

The availability settings atom enables a user to set their available time slots. This atom allows users to define specific time slots when they are available for meetings or events, helping them manage their schedules effectively and avoid double bookings.

First, for the AvailabilitySettings toggle animation to work set the reading direction on the <html> element:

<html dir="ltr"> ... </html>

Below code snippet can be used to render the availability settings atom

import { AvailabilitySettings } from "@calcom/atoms";

export default function Availability() {
  return (
    <>
       <AvailabilitySettings
          onUpdateSuccess={() => {
            console.log("Updated schedule successfully");
          }}
          onDeleteSuccess={() => {
            console.log("Deleted schedule successfully");
          }}
          onFormStateChange={(formState) => {
            console.log("Form state updated");
            // Access form data: formState.name, formState.schedule, formState.timeZone, etc.
          }}
       />
    </>
  )
}

For a demonstration of the availability settings atom, please refer to the video below.

Watch the video

If a user wishes to add further adjustments to their availability for special occasions or events, they can use the date overrides feature. Date overrides enables users to pick any date that they're currently available and set specific hours for availability on that day or mark themselves entirely unavailable. Once that day is passed, the date override is automatically deleted.

Below code snippet can be used to render date overrides into the availability settings atom

import { AvailabilitySettings } from "@calcom/atoms";

export default function Availability() {
  return (
    <>
       <AvailabilitySettings
          enableOverrides={true}
          onUpdateSuccess={() => {
            console.log("Updated schedule successfully");
          }}
          onDeleteSuccess={() => {
            console.log("Deleted schedule successfully");
          }}
          onFormStateChange={(formState) => {
            console.log("Form state changed:", formState);
            // Access form data including dateOverrides: formState.dateOverrides
          }}
       />
    </>
  )
}

For a demonstration of the availability settings atom with date overrides, please refer to the video below.

Watch the video

We offer all kinds of customizations to the availability settings atom via props and customClassNames.

Below is a list of props that can be passed to the availability settings atom.

Along with the props, Availability settings atom accepts custom styles via the customClassNames prop. Below is a list of props that fall under this customClassNames prop.

scheduleClassNames Object Structure

The scheduleClassNames prop accepts an object with the following structure for granular styling of schedule components:

timePicker Object Structure (nested within scheduleClassNames)

The timePicker prop accepts an object with the following structure for granular styling of time picker dropdown components. This applies to the time selection dropdowns (e.g., [ 9:00 ]) that users can click to open a dropdown with available times or click to manually enter a time:

dateOverrideClassNames Object Structure

The dateOverrideClassNames prop accepts an object with the following structure for granular styling of date override components:

Programmatic Form Validation and Submission

The AvailabilitySettings component supports programmatic form validation and submission through a ref-based API. This allows you to validate availability data and submit forms programmatically without user interaction.

import { useRef } from 'react';
import { AvailabilitySettings } from "@calcom/atoms";
import type { AvailabilitySettingsFormRef } from "@calcom/atoms";

export function AvailabilityWithValidation() {
  const availabilityRef = useRef<AvailabilitySettingsFormRef>(null);

  const handleValidate = async () => {
    const result = await availabilityRef.current?.validateForm();
    if (result?.isValid) {
      console.log("Availability form is valid");
    } else {
      console.log("Validation errors:", result?.errors);
    }
  };

  const handleSubmit = () => {
    availabilityRef.current?.handleFormSubmit({
      onSuccess: () => {
        // Additional success handling logic here
        console.log('Availability updated successfully');
      },
      onError: (error) => {
        // Additional error handling logic here
        console.error('Error updating availability:', error);
      }
    });
  };

  return (
    <>
      <AvailabilitySettings
        ref={availabilityRef}
        onUpdateSuccess={() => {
          console.log("Updated schedule successfully");
        }}
        onFormStateChange={(formState) => {
          console.log("Form state changed:", formState);
        }}
      />
      <button onClick={handleValidate}>Validate Form</button>
      <button onClick={handleSubmit}>Submit Form</button>
    </>
  );
}

Ref Methods

Callbacks

The handleFormSubmit method accepts an optional callbacks object with the following properties:

type AvailabilitySettingsFormCallbacks = {
  onSuccess?: () => void;
  onError?: (error: Error) => void;
};
  • onSuccess: Called when the form submission is successful. This allows you to execute additional logic after a successful update.
  • onError: Called when an error occurs during form submission. The error parameter contains details about what went wrong, allowing you to handle specific error cases or display custom error messages.

The validateForm method returns an AvailabilityFormValidationResult object with:

  • isValid: Boolean indicating if the form passed validation
  • errors: Object containing any validation errors found

Note: If a required field is not filled in, the validateForm method will not return any error. The validation focuses on the format and consistency of provided data rather than enforcing required field completion.

Last updated