[CalendarLink] Add component by zairigimad · Pull Request #3460 · symfony/ux

zairigimad · 2026-04-12T15:57:39Z

Q	A
Bug fix?	no
New feature?	yes
Deprecations?	no
Documentation?	no
Issues	Fix #3308 ...
License	MIT

This new component address the #3308 idea , it provide twig functions as proposed by (@Kocal) with an easy way to configure calendar links , it supports Google Calendar, Microsoft Outlook and Ics.

I did not include a dropdown in the component since we can use any other dropdown from any Kit or custom Dropdown.

Kocal · 2026-04-14T11:39:40Z

Hi, Symfony UX 3.0 has been released, and the 2.x branch is no longer maintained.

Could you please retarget this PR to the 3.x branch instead? That way we can review and merge it in the currently supported version.

Thanks!

github-actions · 2026-04-15T15:42:47Z

📊 Packages dist files size difference

Thanks for the PR! Here is the difference in size of the packages dist files between the base branch and the PR.
Please review the changes and make sure they are expected.

File	Before (Size / Gzip)	After (Size / Gzip)
LazyImage
`controller.d.ts`	`395 B` / `257 B`	Removed
`controller.js`	`904 B` / `457 B`	Removed
Map
`abstract_map_controller.d.ts`	`7.6 kB` / `1.49 kB`	`7.29 kB`^{-4% 📉} / `1.46 kB`^{-2% 📉}
`abstract_map_controller.js`	`4.92 kB` / `1.4 kB`	`4.65 kB`^{-5% 📉} / `1.26 kB`^{-10% 📉}
Map (Bridge Google)
`map_controller.d.ts`	`10.56 kB` / `1.92 kB`	`10.26 kB`^{-3% 📉} / `1.9 kB`^{-1% 📉}
`map_controller.js`	`12.9 kB` / `3.19 kB`	`11.25 kB`^{-13% 📉} / `2.84 kB`^{-11% 📉}
Map (Bridge Leaflet)
`map_controller.d.ts`	`9.92 kB` / `1.84 kB`	`9.61 kB`^{-3% 📉} / `1.81 kB`^{-2% 📉}
`map_controller.js`	`12.45 kB` / `3.36 kB`	`11.38 kB`^{-9% 📉} / `3.17 kB`^{-6% 📉}
Svelte
`components.d.ts`	`200 B` / `150 B`	Removed
`components.js`	`46 B` / `69 B`	Removed
`loader.d.ts`	`435 B` / `217 B`	Removed
`loader.js`	`553 B` / `313 B`	Removed
`register_controller.d.ts`	`384 B` / `235 B`	Removed
`register_controller.js`	`531 B` / `303 B`	Removed
`render_controller.d.ts`	`629 B` / `353 B`	Removed
`render_controller.js`	`1.05 kB` / `493 B`	Removed
Swup
`controller.d.ts`	`1012 B` / `360 B`	Removed
`controller.js`	`1.71 kB` / `653 B`	Removed
TogglePassword
`controller.d.ts`	`896 B` / `355 B`	Removed
`controller.js`	`2.64 kB` / `1.07 kB`	Removed
`style.min.css`	`312 B` / `218 B`	Removed
Typed
`controller.d.ts`	`1.9 kB` / `501 B`	Removed
`controller.js`	`1.8 kB` / `638 B`	Removed

Kocal

Thanks for working on this component!

Please ensure to read the whole review before starting anything, my mind changed during the review and I'm sure we don't need a dedicated route (and everything related) for downloading a .ics file.

Thanks you!

Kocal · 2026-04-17T06:35:11Z

+        $builder->setParameter('ux_calendar_link.ics.data_uri_threshold', $config['ics']['data_uri_threshold']);
+        $builder->setParameter('ux_calendar_link.ics.ttl', $config['ics']['ttl']);
+        $builder->setParameter('ux_calendar_link.ics.download_route.enabled', $config['ics']['download_route']['enabled']);
+        $builder->setParameter('ux_calendar_link.ics.download_route.path', $config['ics']['download_route']['path']);
+
+        if ($config['ics']['download_route']['enabled']) {
+            $builder->setAlias('ux_calendar_link.ics.event_store', 'ux_calendar_link.ics.event_store.cache');
+            $builder->removeDefinition('ux_calendar_link.ics.event_store.in_memory');
+        } else {
+            $builder->removeDefinition('ux_calendar_link.ics.event_store.cache');
+        }


This won't be useful anymore

zairigimad · 2026-04-17T09:04:29Z

Thank you @Kocal for this great review and suggestions, indeed there are bunch of things to simplify here , I will take care of this

Kocal · 2026-04-17T11:02:38Z

The package must also be added in the subtree split configuration file, at the repo's root

zairigimad · 2026-04-18T15:00:36Z

The package must also be added in the subtree split configuration file, at the repo's root

I did a large cleanup here and the CI is green.

Kocal

New round

Kocal · 2026-04-21T11:47:01Z

+    $services = $container->services()
+        ->defaults()
+            ->autowire()
+            ->autoconfigure()
+            ->private();


We do not configure services defaults in bundles:

Suggested change

$services = $container->services()

->defaults()

->autowire()

->autoconfigure()

->private();

$services = $container->services();

Kocal · 2026-04-21T11:49:46Z

+**Symfony UX Calendar Link** generates "Add to calendar" links for Google
+Calendar, Outlook.com, Office 365 and iCalendar (``.ics``) — the format
+consumed by Apple Calendar, Outlook desktop, Thunderbird and every native
+calendar client.


Suggested change

**Symfony UX Calendar Link** generates "Add to calendar" links for Google

Calendar, Outlook.com, Office 365 and iCalendar (``.ics``) — the format

consumed by Apple Calendar, Outlook desktop, Thunderbird and every native

calendar client.

Symfony UX CalendarLink is a Symfony bundle that allows generator of "Add to calendar" links for Google

Calendar, Outlook.com, Office 365 and iCalendar (``.ics``), the format

consumed by Apple Calendar, Outlook desktop, Thunderbird and every native

calendar client.

Kocal · 2026-04-21T11:49:53Z

+It addresses the long-standing request in
+`symfony/ux#3308 <https://github.com/symfony/ux/issues/3308>`_ for a
+first-party "Add to calendar" component in the Symfony UX initiative.
+


To remove, that's not useful

Kocal · 2026-04-21T11:50:48Z

+.. code-block:: terminal
+
+    $ composer require symfony/ux-calendar-link
+
+If you're not using Symfony Flex, enable the bundle manually:
+
+::
+
+    // config/bundles.php
+    return [
+        // ...
+        Symfony\UX\CalendarLink\UXCalendarLinkBundle::class => ['all' => true],
+    ];


Suggested change

.. code-block:: terminal

$ composer require symfony/ux-calendar-link

If you're not using Symfony Flex, enable the bundle manually:

::

// config/bundles.php

return [

// ...

Symfony\UX\CalendarLink\UXCalendarLinkBundle::class => ['all' => true],

];

Install the bundle using Composer and Symfony Flex:

.. code-block:: terminal

$ composer require symfony/ux-turbo

Kocal · 2026-04-21T11:52:43Z

+A note on Apple Calendar and EventKit
+-------------------------------------
+
+Apple's EventKit (``EKEvent`` / ``EKEventStore``) is a **native iOS/macOS
+API**, not a web URL scheme. There is no proprietary "Add to Apple Calendar"
+deeplink. The correct way to target Apple Calendar from a web page is to
+serve an RFC 5545 ``.ics`` file — Safari on iOS and macOS recognize the
+``text/calendar`` MIME type and offers to add the event directly. The ``ics``
+provider covers Apple Calendar, Outlook desktop, Thunderbird and every other
+native calendar client in a single link.
+
+ICS delivery
+------------
+
+The ``ics`` provider always returns a
+``data:text/calendar;charset=utf-8;base64,...`` URL containing the full
+VCALENDAR payload.


I don't think these paragraphs are useful

Kocal · 2026-04-21T11:52:59Z

+Reminders and recurrence
+------------------------
+
+::


Add some text please

Kocal · 2026-04-21T11:54:51Z

+accepting the usual ``interval``, ``count`` and ``until`` named arguments:
+
+::


Having :: alone is nonsense:

Suggested change

accepting the usual ``interval``, ``count`` and ``until`` named arguments:

::

accepting the usual ``interval``, ``count`` and ``until`` named arguments::

Kocal · 2026-04-21T11:57:11Z

+    CalendarRecurrence::daily(interval: 2);                   // every other day
+    CalendarRecurrence::monthly(count: 6);                    // six monthly occurrences
+    CalendarRecurrence::yearly(until: new \DateTimeImmutable('2030-01-01'));


Suggested change

CalendarRecurrence::daily(interval: 2); // every other day

CalendarRecurrence::monthly(count: 6); // six monthly occurrences

CalendarRecurrence::yearly(until: new \DateTimeImmutable('2030-01-01'));

// every other day

CalendarRecurrence::daily(interval: 2);

// six monthly occurrences

CalendarRecurrence::monthly(count: 6);

// ...

CalendarRecurrence::yearly(until: new \DateTimeImmutable('2030-01-01'));

Kocal · 2026-04-21T11:57:17Z

+All-day events
+--------------
+
+::


Add some text please

Kocal

Thanks for taking care about my previous comments, here some new ones.

Overall it looks fine, but I still want to take some time to try it inside a real project.

Thanks!

Kocal · 2026-04-26T11:39:12Z

+Usage
+-----
+
+Start by creating a CalendarEvent object in your controller. Once populated with your event details, pass it to Twig to render the calendar links::


Suggested change

Start by creating a CalendarEvent object in your controller. Once populated with your event details, pass it to Twig to render the calendar links::

Start by creating a ``CalendarEvent`` object in your controller. Once populated with your event details, pass it to Twig to render the calendar links::

Kocal · 2026-04-26T11:40:00Z

+                start: new \DateTimeImmutable('2026-05-14 09:00'),
+                end:   new \DateTimeImmutable('2026-05-15 18:00'),
+                location: 'Cité Universitaire Paris',
+                description: 'Annual Symfony conference',


Suggested change

description: 'Annual Symfony conference',

description: 'Annual Symfony conference in France',

(since we also have SF Con, SF Day, and SF Live Berlin 😉)

Kocal · 2026-04-26T11:42:40Z

+* ``ux_calendar_link(event, provider)`` — generates a link for one provider
+* ``ux_calendar_links(event)`` — generates links for every registered provider


Suggested change

* ``ux_calendar_link(event, provider)`` — generates a link for one provider

* ``ux_calendar_links(event)`` — generates links for every registered provider

* ``ux_calendar_link(event, provider)``: generates a link for one provider

* ``ux_calendar_links(event)``: generates links for every registered provider

PS: you can add this section to your AGENTS.md / skills :D

### Em-dash Never use em-dashes (the `—` character). Use parentheses, commas, colons, or restructure the sentence instead. | Bad | Good | |-----|------| | EN: "The tool — which was released last year — is now stable." | EN: "The tool (released last year) is now stable." | | EN: "This has one major benefit — speed." | EN: "This has one major benefit: speed." | | FR: "L'outil — sorti l'an dernier — est maintenant stable." | FR: "L'outil, sorti l'an dernier, est maintenant stable." |

Kocal · 2026-04-26T11:43:21Z

+``CalendarRecurrence`` exposes one static factory per RFC 5545 frequency —
+``minutely()``, ``daily()``, ``weekly()``, ``monthly()``, ``yearly()`` — each
+accepting the usual ``interval``, ``count`` and ``until`` named arguments:


Suggested change

``CalendarRecurrence`` exposes one static factory per RFC 5545 frequency —

``minutely()``, ``daily()``, ``weekly()``, ``monthly()``, ``yearly()`` — each

accepting the usual ``interval``, ``count`` and ``until`` named arguments:

``CalendarRecurrence`` exposes one static factory per RFC 5545 frequency:

``minutely()``, ``daily()``, ``weekly()``, ``monthly()``, ``yearly()``, each

accepting the usual ``interval``, ``count`` and ``until`` named arguments:

Kocal · 2026-04-26T11:48:27Z

+    private function uid(CalendarEvent $event): string
+    {
+        $hash = hash('xxh128', implode('|', [
+            $event->title,
+            $event->start->format(\DateTimeInterface::ATOM),
+            $event->end->format(\DateTimeInterface::ATOM),
+            $event->location ?? '',
+        ]));
+
+        return $hash.'@ux-calendar-link.symfony';
+    }


I don't really like this method, as two similar events with different description/url/... will have the same generated hash, which is wrong.

And as documented by https://icalendar.org/New-Properties-for-iCalendar-RFC-7986/5-3-uid-property.html, it's recommended to use a UUID to generate the UID field.

(with https://symfony.com/doc/7.4/components/uid.html#testing-uuids)

Kocal · 2026-04-26T11:49:39Z

+        $this->assertStringContainsString("BEGIN:VCALENDAR\r\n", $ics);
+        $this->assertStringContainsString("DTSTART:20260514T090000Z\r\n", $ics);
+        $this->assertStringContainsString("DTEND:20260514T100000Z\r\n", $ics);
+        $this->assertStringContainsString("SUMMARY:Demo\r\n", $ics);
+        $this->assertStringContainsString("END:VCALENDAR\r\n", $ics);


Can't we assert the whole string instead?

Kocal · 2026-04-26T11:51:52Z

+EXPERIMENTAL This component is currently experimental and is likely to
+change, or even change drastically.


Suggested change

EXPERIMENTAL This component is currently experimental and is likely to

change, or even change drastically.

**EXPERIMENTAL** This component is currently experimental and is

likely to change, or even change drastically.

(please mimic the other README.md files)

Kocal · 2026-04-26T11:52:04Z

+## Basic usage
+
+```php
+use Symfony\UX\CalendarLink\CalendarEvent;
+
+$event = new CalendarEvent(
+    title: 'Symfony Live Paris',
+    start: new \DateTimeImmutable('2026-05-14 09:00'),
+    end:   new \DateTimeImmutable('2026-05-15 18:00'),
+    location: 'Disneyland Paris',
+    description: 'Annual Symfony conference',
+);
+
+return $this->render('event/show.html.twig', ['event' => $event]);
+```
+
+```twig
+<a href="{{ ux_calendar_link(event, 'google').url }}">Add to Google Calendar</a>
+
+{% for link in ux_calendar_links(event) %}
+    <a href="{{ link.url }}">{{ link.label }}</a>
+{% endfor %}
+```


Kocal · 2026-04-26T11:52:16Z

+This repository is a READ-ONLY sub-tree split. See https://github.com/symfony/ux
+to create issues or submit pull requests.


Suggested change

This repository is a READ-ONLY sub-tree split. See https://github.com/symfony/ux

to create issues or submit pull requests.

**This repository is a READ-ONLY sub-tree split**. See

https://github.com/symfony/ux to create issues or submit pull requests.

Kocal · 2026-04-26T11:53:30Z

+change, or even change drastically.
+
+Symfony UX Calendar Link generates "Add to calendar" links for Google
+Calendar, Outlook.com, Office 365 and iCalendar (`.ics`) — the format


Suggested change

Calendar, Outlook.com, Office 365 and iCalendar (`.ics`) — the format

Calendar, Outlook.com, Office 365 and iCalendar (`.ics`), the format

Kocal · 2026-04-26T11:59:49Z

+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
+         backupGlobals="false"
+         colors="true"
+         bootstrap="tests/bootstrap.php"
+         failOnRisky="true"
+         failOnWarning="true"
+>
+    <php>
+        <ini name="error_reporting" value="-1"/>
+        <server name="KERNEL_CLASS" value="Symfony\UX\CalendarLink\Tests\Fixtures\TestKernel"/>
+    </php>
+
+    <testsuites>
+        <testsuite name="symfony/ux-calendar-link Test Suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+
+    <coverage>
+        <include>
+            <directory>./src</directory>
+        </include>
+    </coverage>
+</phpunit>


This is what PHPUnit configuration file from other UX packages looks like:

Suggested change

<?xml version="1.0" encoding="UTF-8"?>

<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"

backupGlobals="false"

colors="true"

bootstrap="tests/bootstrap.php"

failOnRisky="true"

failOnWarning="true"

>

<php>

<ini name="error_reporting" value="-1"/>

<server name="KERNEL_CLASS" value="Symfony\UX\CalendarLink\Tests\Fixtures\TestKernel"/>

</php>

<testsuites>

<testsuite name="symfony/ux-calendar-link Test Suite">

<directory>./tests/</directory>

</testsuite>

</testsuites>

<coverage>

<include>

<directory>./src</directory>

</include>

</coverage>

</phpunit>

<?xml version="1.0" encoding="UTF-8"?>



<phpunit

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"

colors="true"

bootstrap="tests/bootstrap.php"

failOnDeprecation="true"

failOnRisky="true"

failOnWarning="true"

cacheDirectory=".phpunit.cache"

>

<php>

<ini name="error_reporting" value="-1"/>

<env name="SHELL_VERBOSITY" value="-1"/>

<env name="KERNEL_CLASS" value="Symfony\UX\CalendarLink\Tests\Fixtures\TestKernel" />

</php>

<testsuites>

<testsuite name="Symfony UX CalendarLink Test Suite">

<directory>./tests</directory>

</testsuite>

</testsuites>

<source

ignoreSuppressionOfDeprecations="true"

ignoreIndirectDeprecations="true"

restrictNotices="true"

restrictWarnings="true"

>

<include>

<directory>src</directory>

</include>

<deprecationTrigger>

<function>trigger_deprecation</function>

</deprecationTrigger>

</source>

</phpunit>

carsonbot added Deprecation Feature New Feature Status: Needs Review Needs to be reviewed labels Apr 12, 2026

zairigimad marked this pull request as draft April 12, 2026 15:58

zairigimad force-pushed the feat/component-calendar-link branch 6 times, most recently from b7c7159 to 4da188d Compare April 12, 2026 16:20

zairigimad marked this pull request as ready for review April 13, 2026 14:25

Kocal added Status: Needs Work Additional work is needed and removed Status: Needs Review Needs to be reviewed labels Apr 14, 2026

zairigimad added 4 commits April 15, 2026 16:42

Init CalendarLink component

fa84d0d

fix RST and Fabot

39d63c4

fix fabot

85ca566

fix ci

13a1fc5

zairigimad force-pushed the feat/component-calendar-link branch from bb5ab31 to 13a1fc5 Compare April 15, 2026 15:42

zairigimad requested a review from Kocal as a code owner April 15, 2026 15:42

carsonbot added Status: Needs Review Needs to be reviewed and removed Status: Needs Work Additional work is needed labels Apr 15, 2026

zairigimad changed the base branch from 2.x to 3.x April 15, 2026 15:42

fix fabbot

b19f99b

Kocal removed the Deprecation label Apr 17, 2026

Kocal changed the title ~~[CalendarLink] Init CalendarLink component~~ [CalendarLink] Add component Apr 17, 2026

Kocal requested changes Apr 17, 2026

View reviewed changes

carsonbot added Status: Needs Work Additional work is needed and removed Status: Needs Review Needs to be reviewed labels Apr 17, 2026

Kocal requested changes Apr 17, 2026

View reviewed changes

Comment thread src/CalendarLink/tests/bootstrap.php Outdated

Comment thread src/CalendarLink/composer.json Outdated

Comment thread src/CalendarLink/composer.json Outdated

carsonbot added Status: Needs Review Needs to be reviewed and removed Status: Needs Work Additional work is needed labels Apr 18, 2026

fix feedbacks and minor refacts

8348232

zairigimad force-pushed the feat/component-calendar-link branch from 405061c to 8348232 Compare April 18, 2026 14:51

Kocal requested changes Apr 21, 2026

View reviewed changes

carsonbot added Status: Needs Work Additional work is needed Status: Needs Review Needs to be reviewed and removed Status: Needs Review Needs to be reviewed Status: Needs Work Additional work is needed labels Apr 21, 2026

zairigimad requested a review from Kocal April 21, 2026 14:29

zairigimad force-pushed the feat/component-calendar-link branch from 74889b4 to c83ae65 Compare April 21, 2026 14:30

second round feedbacks

3920086

zairigimad force-pushed the feat/component-calendar-link branch from c83ae65 to 3920086 Compare April 21, 2026 14:38

Kocal requested changes Apr 26, 2026

View reviewed changes

carsonbot added Status: Needs Work Additional work is needed and removed Status: Needs Review Needs to be reviewed labels Apr 26, 2026

Kocal requested changes Apr 26, 2026

View reviewed changes

		accepting the usual ``interval``, ``count`` and ``until`` named arguments:

		::

	Start by creating a CalendarEvent object in your controller. Once populated with your event details, pass it to Twig to render the calendar links::
	Start by creating a ``CalendarEvent`` object in your controller. Once populated with your event details, pass it to Twig to render the calendar links::

	description: 'Annual Symfony conference',
	description: 'Annual Symfony conference in France',

		* ``ux_calendar_link(event, provider)`` — generates a link for one provider
		* ``ux_calendar_links(event)`` — generates links for every registered provider

		EXPERIMENTAL This component is currently experimental and is likely to
		change, or even change drastically.

		This repository is a READ-ONLY sub-tree split. See https://github.com/symfony/ux
		to create issues or submit pull requests.

	Calendar, Outlook.com, Office 365 and iCalendar (`.ics`) — the format
	Calendar, Outlook.com, Office 365 and iCalendar (`.ics`), the format

Uh oh!

Conversation

zairigimad commented Apr 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Kocal commented Apr 14, 2026

Uh oh!

github-actions Bot commented Apr 15, 2026

📊 Packages dist files size difference

Uh oh!

Kocal left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zairigimad commented Apr 17, 2026

Uh oh!

Kocal commented Apr 17, 2026

Uh oh!

zairigimad commented Apr 18, 2026

Uh oh!

Kocal left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Kocal left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zairigimad commented Apr 12, 2026 •

edited

Loading