Files
calendar/packages/features/shell/hooks/useWelcomeToCalcomModal.ts
T
sean-brydonandGitHub dc3742d322 chore: Add calendar weekly view enhancements and welcome modal feature (#24948)
## What does this PR do?

- Adds a welcome modal for new Cal.com users
- Implements timezone display in the weekly calendar view
- Creates a hook for fetching onboarding calendar events

## Visual Demo (For contributors especially)

#### Image Demo:

![Welcome Modal](https://user-images.githubusercontent.com/1234567/example-welcome-modal.png)

![Timezone Display](https://user-images.githubusercontent.com/1234567/example-timezone-display.png)

## Mandatory Tasks

- [x] I have self-reviewed the code
- [x] I have updated the developer docs in /docs
- [x] I confirm automated tests are in place that prove my fix is effective or that my feature works.

## How should this be tested?

1. **Welcome Modal:**
   - Create a new user account
   - Verify the welcome modal appears with correct content
   - Test the "Continue" button closes the modal
   - Check that the modal can be triggered via URL parameter `?welcomeToCalcomModal=true`

2. **Timezone Display:**
   - Go to the weekly calendar view
   - Verify the timezone is displayed correctly when `showTimezone` is enabled
   - Test with different timezones to ensure proper formatting

3. **Onboarding Calendar Events:**
   - Test the hook by connecting a calendar during onboarding
   - Verify events are fetched and displayed correctly
   - Check that events refresh when new calendars are connected

## Checklist

- I have read the [contributing guide](https://github.com/calcom/cal.com/blob/main/CONTRIBUTING.md)
- My code follows the style guidelines of this project
- I have commented my code, particularly in hard-to-understand areas
- I have checked if my changes generate no new warnings
2025-11-11 10:47:22 +00:00

44 lines
1014 B
TypeScript

import { parseAsBoolean, useQueryState } from "nuqs";
import { useEffect, useState } from "react";
import { sessionStorage } from "@calcom/lib/webstorage";
const STORAGE_KEY = "showWelcomeToCalcomModal";
export function useWelcomeToCalcomModal() {
const [welcomeToCalcomModal, setWelcomeToCalcomModal] = useQueryState(
"welcomeToCalcomModal",
parseAsBoolean.withDefault(false)
);
const [isOpen, setIsOpen] = useState(false);
useEffect(() => {
if (welcomeToCalcomModal) {
setIsOpen(true);
return;
}
if (sessionStorage.getItem(STORAGE_KEY) === "true") {
setIsOpen(true);
}
}, [welcomeToCalcomModal]);
const closeModal = () => {
setIsOpen(false);
// Remove the query param from URL
setWelcomeToCalcomModal(null);
// Also clear sessionStorage
sessionStorage.removeItem(STORAGE_KEY);
};
return {
isOpen,
closeModal,
};
}
export function setShowWelcomeToCalcomModalFlag() {
sessionStorage.setItem(STORAGE_KEY, "true");
}