From 8d20cfb0c6ff38e7180f1c6c5ffea2dcf60fd21c Mon Sep 17 00:00:00 2001
From: Jordan Pittman <jordan@cryptica.me>
Date: Fri, 3 May 2024 09:55:02 -0400
Subject: [PATCH] Deprecate dot notation (#3170)

* Expose new components under dot notation

Most of them already where so only a couple were missing.

* Deprecate dot notation

* Add deprecation to `RadioGroupOption`

* Update deprecations

* Update changelog

* Update changelog
---
 packages/@headlessui-react/CHANGELOG.md                     | 1 +
 .../@headlessui-react/src/components/combobox/combobox.tsx  | 4 ++++
 packages/@headlessui-react/src/components/dialog/dialog.tsx | 6 ++++++
 .../src/components/disclosure/disclosure.tsx                | 2 ++
 .../src/components/focus-trap/focus-trap.tsx                | 1 +
 .../@headlessui-react/src/components/listbox/listbox.tsx    | 5 +++++
 packages/@headlessui-react/src/components/menu/menu.tsx     | 6 ++++++
 .../@headlessui-react/src/components/popover/popover.tsx    | 4 ++++
 packages/@headlessui-react/src/components/portal/portal.tsx | 5 ++++-
 .../src/components/radio-group/radio-group.tsx              | 4 ++++
 packages/@headlessui-react/src/components/switch/switch.tsx | 1 +
 packages/@headlessui-react/src/components/tabs/tabs.tsx     | 4 ++++
 .../src/components/transition/transition.tsx                | 2 ++
 13 files changed, 44 insertions(+), 1 deletion(-)

diff --git a/packages/@headlessui-react/CHANGELOG.md b/packages/@headlessui-react/CHANGELOG.md
index 72c81c4918..ddb55f8704 100644
--- a/packages/@headlessui-react/CHANGELOG.md
+++ b/packages/@headlessui-react/CHANGELOG.md
@@ -45,6 +45,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Change default tags for `ListboxOptions`, `ListboxOption`, `ComboboxOptions`, `ComboboxOption` and `TabGroup` components ([#3109](https://github.com/tailwindlabs/headlessui/pull/3109))
 - Change default tag from `div` to `Fragment` on `Transition` components ([#3110](https://github.com/tailwindlabs/headlessui/pull/3110))
 - Update minimal peer dependency version requirements for `react` and `react-dom` ([#3131](https://github.com/tailwindlabs/headlessui/pull/3131))
+- Deprecate dot notation for components ([#2887](https://github.com/tailwindlabs/headlessui/pull/2887), [#3170](https://github.com/tailwindlabs/headlessui/pull/3170))
 
 ### Added
 
diff --git a/packages/@headlessui-react/src/components/combobox/combobox.tsx b/packages/@headlessui-react/src/components/combobox/combobox.tsx
index bf8ac3df11..7fb744b0ff 100644
--- a/packages/@headlessui-react/src/components/combobox/combobox.tsx
+++ b/packages/@headlessui-react/src/components/combobox/combobox.tsx
@@ -1971,10 +1971,14 @@ export let ComboboxOptions = forwardRefWithAs(OptionsFn) as _internal_ComponentC
 export let ComboboxOption = forwardRefWithAs(OptionFn) as _internal_ComponentComboboxOption
 
 export let Combobox = Object.assign(ComboboxRoot, {
+  /** @deprecated use `<ComboboxInput>` instead of `<Combobox.Input>` */
   Input: ComboboxInput,
+  /** @deprecated use `<ComboboxButton>` instead of `<Combobox.Button>` */
   Button: ComboboxButton,
   /** @deprecated use `<Label>` instead of `<Combobox.Label>` */
   Label: ComboboxLabel,
+  /** @deprecated use `<ComboboxOptions>` instead of `<Combobox.Options>` */
   Options: ComboboxOptions,
+  /** @deprecated use `<ComboboxOption>` instead of `<Combobox.Option>` */
   Option: ComboboxOption,
 })
diff --git a/packages/@headlessui-react/src/components/dialog/dialog.tsx b/packages/@headlessui-react/src/components/dialog/dialog.tsx
index 7ed07b4344..9b1330da47 100644
--- a/packages/@headlessui-react/src/components/dialog/dialog.tsx
+++ b/packages/@headlessui-react/src/components/dialog/dialog.tsx
@@ -658,17 +658,23 @@ export interface _internal_ComponentDialogTitle extends HasDisplayName {
 export interface _internal_ComponentDialogDescription extends _internal_ComponentDescription {}
 
 let DialogRoot = forwardRefWithAs(DialogFn) as _internal_ComponentDialog
+/** @deprecated use a plain `<div>` instead of `<DialogBackdrop>` */
 export let DialogBackdrop = forwardRefWithAs(BackdropFn) as _internal_ComponentDialogBackdrop
 export let DialogPanel = forwardRefWithAs(PanelFn) as _internal_ComponentDialogPanel
+/** @deprecated use a plain `<div>` instead of `<DialogOverlay>` */
 export let DialogOverlay = forwardRefWithAs(OverlayFn) as _internal_ComponentDialogOverlay
 export let DialogTitle = forwardRefWithAs(TitleFn) as _internal_ComponentDialogTitle
 /** @deprecated use `<Description>` instead of `<DialogDescription>` */
 export let DialogDescription = Description as _internal_ComponentDialogDescription
 
 export let Dialog = Object.assign(DialogRoot, {
+  /** @deprecated use a plain `<div>` instead of `<Dialog.Backdrop>` */
   Backdrop: DialogBackdrop,
+  /** @deprecated use `<DialogPanel>` instead of `<Dialog.Panel>` */
   Panel: DialogPanel,
+  /** @deprecated use a plain `<div>` instead of `<Dialog.Overlay>` */
   Overlay: DialogOverlay,
+  /** @deprecated use `<DialogTitle>` instead of `<Dialog.Title>` */
   Title: DialogTitle,
   /** @deprecated use `<Description>` instead of `<Dialog.Description>` */
   Description: Description as _internal_ComponentDialogDescription,
diff --git a/packages/@headlessui-react/src/components/disclosure/disclosure.tsx b/packages/@headlessui-react/src/components/disclosure/disclosure.tsx
index 6a0eca8b97..c27d8f5740 100644
--- a/packages/@headlessui-react/src/components/disclosure/disclosure.tsx
+++ b/packages/@headlessui-react/src/components/disclosure/disclosure.tsx
@@ -514,6 +514,8 @@ export let DisclosureButton = forwardRefWithAs(ButtonFn) as _internal_ComponentD
 export let DisclosurePanel = forwardRefWithAs(PanelFn) as _internal_ComponentDisclosurePanel
 
 export let Disclosure = Object.assign(DisclosureRoot, {
+  /** @deprecated use `<DisclosureButton>` instead of `<Disclosure.Button>` */
   Button: DisclosureButton,
+  /** @deprecated use `<DisclosurePanel>` instead of `<Disclosure.Panel>` */
   Panel: DisclosurePanel,
 })
diff --git a/packages/@headlessui-react/src/components/focus-trap/focus-trap.tsx b/packages/@headlessui-react/src/components/focus-trap/focus-trap.tsx
index d2569c9892..2539dabbc0 100644
--- a/packages/@headlessui-react/src/components/focus-trap/focus-trap.tsx
+++ b/packages/@headlessui-react/src/components/focus-trap/focus-trap.tsx
@@ -233,6 +233,7 @@ export interface _internal_ComponentFocusTrap extends HasDisplayName {
 let FocusTrapRoot = forwardRefWithAs(FocusTrapFn) as _internal_ComponentFocusTrap
 
 export let FocusTrap = Object.assign(FocusTrapRoot, {
+  /** @deprecated use `FocusTrapFeatures` instead of `FocusTrap.features` */
   features: FocusTrapFeatures,
 })
 
diff --git a/packages/@headlessui-react/src/components/listbox/listbox.tsx b/packages/@headlessui-react/src/components/listbox/listbox.tsx
index c3da6f4d58..1de94eff9e 100644
--- a/packages/@headlessui-react/src/components/listbox/listbox.tsx
+++ b/packages/@headlessui-react/src/components/listbox/listbox.tsx
@@ -1403,9 +1403,14 @@ export let ListboxSelectedOption = forwardRefWithAs(
 ) as _internal_ComponentListboxSelectedOption
 
 export let Listbox = Object.assign(ListboxRoot, {
+  /** @deprecated use `<ListboxButton>` instead of `<Listbox.Button>` */
   Button: ListboxButton,
   /** @deprecated use `<Label>` instead of `<Listbox.Label>` */
   Label: ListboxLabel,
+  /** @deprecated use `<ListboxOptions>` instead of `<Listbox.Options>` */
   Options: ListboxOptions,
+  /** @deprecated use `<ListboxOption>` instead of `<Listbox.Option>` */
   Option: ListboxOption,
+  /** @deprecated use `<ListboxSelectedOption>` instead of `<Listbox.SelectedOption>` */
+  SelectedOption: ListboxSelectedOption,
 })
diff --git a/packages/@headlessui-react/src/components/menu/menu.tsx b/packages/@headlessui-react/src/components/menu/menu.tsx
index 55865584c8..7320189229 100644
--- a/packages/@headlessui-react/src/components/menu/menu.tsx
+++ b/packages/@headlessui-react/src/components/menu/menu.tsx
@@ -1109,10 +1109,16 @@ export let MenuHeading = forwardRefWithAs(HeadingFn) as _internal_ComponentMenuH
 export let MenuSeparator = forwardRefWithAs(SeparatorFn) as _internal_ComponentMenuSeparator
 
 export let Menu = Object.assign(MenuRoot, {
+  /** @deprecated use `<MenuButton>` instead of `<Menu.Button>` */
   Button: MenuButton,
+  /** @deprecated use `<MenuItems>` instead of `<Menu.Items>` */
   Items: MenuItems,
+  /** @deprecated use `<MenuItem>` instead of `<Menu.Item>` */
   Item: MenuItem,
+  /** @deprecated use `<MenuSection>` instead of `<Menu.Section>` */
   Section: MenuSection,
+  /** @deprecated use `<MenuHeading>` instead of `<Menu.Heading>` */
   Heading: MenuHeading,
+  /** @deprecated use `<MenuSeparator>` instead of `<Menu.Separator>` */
   Separator: MenuSeparator,
 })
diff --git a/packages/@headlessui-react/src/components/popover/popover.tsx b/packages/@headlessui-react/src/components/popover/popover.tsx
index f108b9cb78..3940555f3d 100644
--- a/packages/@headlessui-react/src/components/popover/popover.tsx
+++ b/packages/@headlessui-react/src/components/popover/popover.tsx
@@ -1189,8 +1189,12 @@ export let PopoverPanel = forwardRefWithAs(PanelFn) as _internal_ComponentPopove
 export let PopoverGroup = forwardRefWithAs(GroupFn) as _internal_ComponentPopoverGroup
 
 export let Popover = Object.assign(PopoverRoot, {
+  /** @deprecated use `<PopoverButton>` instead of `<Popover.Button>` */
   Button: PopoverButton,
+  /** @deprecated use `<PopoverOverlay>` instead of `<Popover.Overlay>` */
   Overlay: PopoverOverlay,
+  /** @deprecated use `<PopoverPanel>` instead of `<Popover.Panel>` */
   Panel: PopoverPanel,
+  /** @deprecated use `<PopoverGroup>` instead of `<Popover.Group>` */
   Group: PopoverGroup,
 })
diff --git a/packages/@headlessui-react/src/components/portal/portal.tsx b/packages/@headlessui-react/src/components/portal/portal.tsx
index 5517827c43..8de48410cd 100644
--- a/packages/@headlessui-react/src/components/portal/portal.tsx
+++ b/packages/@headlessui-react/src/components/portal/portal.tsx
@@ -261,4 +261,7 @@ export interface _internal_ComponentPortalGroup extends HasDisplayName {
 let PortalRoot = forwardRefWithAs(PortalFn) as unknown as _internal_ComponentPortal
 export let PortalGroup = forwardRefWithAs(GroupFn) as _internal_ComponentPortalGroup
 
-export let Portal = Object.assign(PortalRoot, { Group: PortalGroup })
+export let Portal = Object.assign(PortalRoot, {
+  /** @deprecated use `<PortalGroup>` instead of `<Portal.Group>` */
+  Group: PortalGroup,
+})
diff --git a/packages/@headlessui-react/src/components/radio-group/radio-group.tsx b/packages/@headlessui-react/src/components/radio-group/radio-group.tsx
index 3585106600..6d554aadff 100644
--- a/packages/@headlessui-react/src/components/radio-group/radio-group.tsx
+++ b/packages/@headlessui-react/src/components/radio-group/radio-group.tsx
@@ -588,6 +588,7 @@ export interface _internal_ComponentRadioLabel extends _internal_ComponentLabel
 export interface _internal_ComponentRadioDescription extends _internal_ComponentDescription {}
 
 let RadioGroupRoot = forwardRefWithAs(RadioGroupFn) as _internal_ComponentRadioGroup
+/** @deprecated use `<Radio>` instead of `<RadioGroupOption>` */
 export let RadioGroupOption = forwardRefWithAs(OptionFn) as _internal_ComponentRadioOption
 export let Radio = forwardRefWithAs(RadioFn) as _internal_ComponentRadio
 /** @deprecated use `<Label>` instead of `<RadioGroupLabel>` */
@@ -596,7 +597,10 @@ export let RadioGroupLabel = Label as _internal_ComponentRadioLabel
 export let RadioGroupDescription = Description as _internal_ComponentRadioDescription
 
 export let RadioGroup = Object.assign(RadioGroupRoot, {
+  /** @deprecated use `<Radio>` instead of `<RadioGroup.Option>` */
   Option: RadioGroupOption,
+  /** @deprecated use `<Radio>` instead of `<RadioGroup.Radio>` */
+  Radio: Radio,
   /** @deprecated use `<Label>` instead of `<RadioGroup.Label>` */
   Label: RadioGroupLabel,
   /** @deprecated use `<Description>` instead of `<RadioGroup.Description>` */
diff --git a/packages/@headlessui-react/src/components/switch/switch.tsx b/packages/@headlessui-react/src/components/switch/switch.tsx
index 45cc4a3fc7..a5715dc7b8 100644
--- a/packages/@headlessui-react/src/components/switch/switch.tsx
+++ b/packages/@headlessui-react/src/components/switch/switch.tsx
@@ -276,6 +276,7 @@ export let SwitchLabel = Label as _internal_ComponentSwitchLabel
 export let SwitchDescription = Description as _internal_ComponentSwitchDescription
 
 export let Switch = Object.assign(SwitchRoot, {
+  /** @deprecated use `<SwitchGroup>` instead of `<Switch.Group>` */
   Group: SwitchGroup,
   /** @deprecated use `<Label>` instead of `<Switch.Label>` */
   Label: SwitchLabel,
diff --git a/packages/@headlessui-react/src/components/tabs/tabs.tsx b/packages/@headlessui-react/src/components/tabs/tabs.tsx
index 1e1e3d4a7a..eb7d9b36d0 100644
--- a/packages/@headlessui-react/src/components/tabs/tabs.tsx
+++ b/packages/@headlessui-react/src/components/tabs/tabs.tsx
@@ -702,8 +702,12 @@ export let TabPanels = forwardRefWithAs(PanelsFn) as _internal_ComponentTabPanel
 export let TabPanel = forwardRefWithAs(PanelFn) as _internal_ComponentTabPanel
 
 export let Tab = Object.assign(TabRoot, {
+  /** @deprecated use `<TabGroup>` instead of `<Tab.Group>` */
   Group: TabGroup,
+  /** @deprecated use `<TabList>` instead of `<Tab.List>` */
   List: TabList,
+  /** @deprecated use `<TabPanels>` instead of `<Tab.Panels>` */
   Panels: TabPanels,
+  /** @deprecated use `<TabPanel>` instead of `<Tab.Panel>` */
   Panel: TabPanel,
 })
diff --git a/packages/@headlessui-react/src/components/transition/transition.tsx b/packages/@headlessui-react/src/components/transition/transition.tsx
index 2732d0771d..fb358036cf 100644
--- a/packages/@headlessui-react/src/components/transition/transition.tsx
+++ b/packages/@headlessui-react/src/components/transition/transition.tsx
@@ -675,6 +675,8 @@ let InternalTransitionChild = forwardRefWithAs(
 export let TransitionChild = forwardRefWithAs(ChildFn) as _internal_ComponentTransitionChild
 
 export let Transition = Object.assign(TransitionRoot, {
+  /** @deprecated use `<TransitionChild>` instead of `<Transition.Child>` */
   Child: TransitionChild,
+  /** @deprecated use `<Transition>` instead of `<Transition.Root>` */
   Root: TransitionRoot,
 })