Skip to content

Commit 7ea77ab

Browse files
Copilothotlong
andcommitted
Clarify Toaster export documentation to prevent confusion
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 6ba7aac commit 7ea77ab

2 files changed

Lines changed: 12 additions & 6 deletions

File tree

packages/components/src/ui/index.ts

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,10 @@ export * from './skeleton';
5656
export * from './slider';
5757
/**
5858
* Sonner is the recommended toast solution for ObjectUI.
59-
* The Toaster export below is the Sonner Toaster component.
59+
* When you import { Toaster } from '@object-ui/components', you get the Sonner Toaster (recommended).
60+
* The legacy toast system is still available but deprecated.
6061
* @see https://ui.shadcn.com/docs/components/sonner
6162
*/
62-
export * from './sonner';
63-
// Explicitly export Toaster from Sonner as the default Toaster
6463
export { Toaster } from './sonner';
6564
export * from './spinner';
6665
export * from './switch';
@@ -69,7 +68,11 @@ export * from './tabs';
6968
export * from './textarea';
7069
/** @deprecated Use Sonner (sonner.tsx) for toast notifications instead */
7170
export * from './toast';
72-
/** @deprecated Use Sonner Toaster from sonner.tsx instead. Import { Toaster } for the recommended component. */
71+
/**
72+
* @deprecated Use the Sonner-based Toaster instead.
73+
* Import { Toaster } from '@object-ui/components' to get the recommended Sonner Toaster.
74+
* This ToastNotifier export is the legacy Radix-based toaster.
75+
*/
7376
export { Toaster as ToastNotifier } from './toaster';
7477
export * from './toggle-group';
7578
export * from './toggle';

packages/components/src/ui/toaster.tsx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,14 @@
88

99
/**
1010
* @deprecated This component is part of the legacy Radix toast system.
11-
* Please use the Sonner-based Toaster instead:
11+
* Please use the Sonner-based Toaster instead by importing from the main package:
1212
*
1313
* ```tsx
14+
* // Recommended (gets Sonner Toaster)
1415
* import { Toaster } from '@object-ui/components';
15-
* // This now exports the Sonner Toaster by default
16+
*
17+
* // NOT recommended (gets legacy Toaster)
18+
* import { Toaster } from '@object-ui/components/ui/toaster';
1619
* ```
1720
*
1821
* See sonner.tsx for the recommended toast solution.

0 commit comments

Comments
 (0)