Skip to content

An opinionated toast component for React.

Easier classname customization (#232)

Emil Kowalskie78eb4183c28
diff --git a/src/index.tsx b/src/index.tsx
index f893423..a15b893 100644
--- a/src/index.tsx
+++ b/src/index.tsx
@@ -5,7 +5,7 @@ import ReactDOM from 'react-dom';
import './styles.css';
import { getAsset, Loader } from './assets';
-import type { HeightT, Position, ToastT, ToastToDismiss, ExternalToast, ToasterProps } from './types';
+import type { HeightT, Position, ToastT, ToastToDismiss, ExternalToast, ToasterProps, ToastClassnames } from './types';
import { ToastState, toast } from './state';
// Visible toasts amount
@@ -50,6 +50,11 @@ interface ToastProps {
unstyled?: boolean;
descriptionClassName?: string;
loadingIcon?: React.ReactNode;
+ classNames?: ToastClassnames;
+}
+
+function cn(...classes: (string | undefined)[]) {
+ return classes.filter(Boolean).join(' ');
}
const Toast = (props: ToastProps) => {
@@ -75,6 +80,7 @@ const Toast = (props: ToastProps) => {
gap = GAP,
loadingIcon: loadingIconProp,
expandByDefault,
+ classNames,
} = props;
const [mounted, setMounted] = React.useState(false);
const [removed, setRemoved] = React.useState(false);
@@ -90,7 +96,6 @@ const Toast = (props: ToastProps) => {
const dismissible = toast.dismissible !== false;
const toastClassname = toast.className || '';
const toastDescriptionClassname = toast.descriptionClassName || '';
-
// Height index is used to calculate the offset as it gets updated before the toast array, which means we can calculate the new layout faster.
const heightIndex = React.useMemo(
() => heights.findIndex((height) => height.toastId === toast.id) || 0,
@@ -120,6 +125,7 @@ const Toast = (props: ToastProps) => {
const disabled = toastType === 'loading';
offset.current = React.useMemo(() => heightIndex * gap + toastsHeightBefore, [heightIndex, toastsHeightBefore]);
+ console.log(classNames);
React.useEffect(() => {
// Trigger enter animation without using CSS animation
@@ -215,7 +221,10 @@ const Toast = (props: ToastProps) => {
function getLoadingIcon() {
if (loadingIconProp) {
return (
- <div className="loader" data-visible={toastType === 'loading'}>
+ <div
+ className={cn('loader', classNames?.toast, toast?.classNames?.toast)}
+ data-visible={toastType === 'loading'}
+ >
{loadingIconProp}
</div>
);
@@ -230,7 +239,14 @@ const Toast = (props: ToastProps) => {
role="status"
tabIndex={0}
ref={toastRef}
- className={className + ' ' + toastClassname}
+ className={cn(
+ className,
+ toastClassname,
+ classNames?.toast,
+ toast?.classNames?.toast,
+ classNames?.[toastType],
+ toast?.classNames?.[toastType],
+ )}
data-sonner-toast=""
data-styled={!Boolean(toast.jsx || toast.unstyled)}
data-mounted={mounted}
@@ -321,6 +337,7 @@ const Toast = (props: ToastProps) => {
toast.onDismiss?.(toast);
}
}
+ className={cn(classNames?.closeButton, toast?.classNames?.closeButton)}
>
<svg
xmlns="http://www.w3.org/2000/svg"
@@ -350,9 +367,19 @@ const Toast = (props: ToastProps) => {
) : null}
<div data-content="">
- <div data-title="">{toast.title}</div>
+ <div data-title="" className={cn(classNames?.title, toast?.classNames?.title)}>
+ {toast.title}
+ </div>
{toast.description ? (
- <div data-description="" className={descriptionClassName + toastDescriptionClassname}>
+ <div
+ data-description=""
+ className={cn(
+ descriptionClassName,
+ toastDescriptionClassname,
+ classNames?.description,
+ toast?.classNames?.description,
+ )}
+ >
{toast.description}
</div>
) : null}
@@ -369,6 +396,7 @@ const Toast = (props: ToastProps) => {
toast.cancel.onClick();
}
}}
+ className={cn(classNames?.cancelButton, toast?.classNames?.cancelButton)}
>
{toast.cancel.label}
</button>
@@ -382,6 +410,7 @@ const Toast = (props: ToastProps) => {
if (event.defaultPrevented) return;
deleteToast();
}}
+ className={cn(classNames?.actionButton, toast?.classNames?.actionButton)}
>
{toast.action.label}
</button>
@@ -630,6 +659,7 @@ const Toaster = (props: ToasterProps) => {
interacting={interacting}
position={position}
style={toastOptions?.style}
+ classNames={toastOptions?.classNames}
cancelButtonStyle={toastOptions?.cancelButtonStyle}
actionButtonStyle={toastOptions?.actionButtonStyle}
removeToast={removeToast}
diff --git a/src/types.ts b/src/types.ts
index 149136e..db126ee 100644
--- a/src/types.ts
+++ b/src/types.ts
@@ -11,6 +11,21 @@ export type PromiseData<ToastData = any> = ExternalToast & {
finally?: () => void | Promise<void>;
};
+export interface ToastClassnames {
+ toast?: string;
+ title?: string;
+ description?: string;
+ loader?: string;
+ closeButton?: string;
+ cancelButton?: string;
+ actionButton?: string;
+ success?: string;
+ error?: string;
+ info?: string;
+ warning?: string;
+}
+
+// TODO: CLEANUP TYPES
export interface ToastT {
id: number | string;
title?: string | React.ReactNode;
@@ -39,6 +54,7 @@ export interface ToastT {
style?: React.CSSProperties;
unstyled?: boolean;
className?: string;
+ classNames?: ToastClassnames;
descriptionClassName?: string;
position?: Position;
}
@@ -57,6 +73,7 @@ interface ToastOptions {
actionButtonStyle?: React.CSSProperties;
duration?: number;
unstyled?: boolean;
+ classNames?: ToastClassnames;
}
export interface ToasterProps {
diff --git a/website/src/pages/_meta.json b/website/src/pages/_meta.json
index 3509f0b..12b2b8e 100644
--- a/website/src/pages/_meta.json
+++ b/website/src/pages/_meta.json
@@ -14,5 +14,13 @@
"toaster": {
"title": "Toaster",
"href": "/toaster"
+ },
+ "-- GUIDES": {
+ "type": "separator",
+ "title": "Guides"
+ },
+ "styling": {
+ "title": "Styling",
+ "href": "/styling"
}
}
diff --git a/website/src/pages/styling.mdx b/website/src/pages/styling.mdx
new file mode 100644
index 0000000..f74d7ad
--- /dev/null
+++ b/website/src/pages/styling.mdx
@@ -0,0 +1,86 @@
+# Styling
+
+Styling can be done globally via `toastOptions`, this way every toast will have the same styling.
+
+```jsx
+<Toaster
+ toastOptions={{
+ style: {
+ background: 'red',
+ },
+ className: 'class',
+ }}
+/>
+```
+
+You can also use the same props when calling `toast` to style a specific toast.
+
+```jsx
+toast('Hello World', {
+ style: {
+ background: 'red',
+ },
+ className: 'class',
+});
+```
+
+## Tailwind CSS
+
+The preferred way to style the toasts with tailwind is by using the `classNames` prop. Exclamation mark in front of the class is required to override the default styles.
+
+```jsx
+<Toaster
+ toastOptions={{
+ classNames: {
+ toast: '!bg-blue-400',
+ title: '!text-red-400',
+ description: '!text-red-400',
+ actionButton: '!bg-zinc-400',
+ cancelButton: '!bg-orange-400',
+ closeButton: '!bg-lime-400',
+ },
+ }}
+/>
+```
+
+You can do the same when calling `toast()`.
+
+```jsx
+toast('Hello World', {
+ classNames: {
+ toast: '!bg-blue-400',
+ title: '!text-red-400 !text-2xl',
+ description: '!text-red-400',
+ actionButton: '!bg-zinc-400',
+ cancelButton: '!bg-orange-400',
+ closeButton: '!bg-lime-400',
+ },
+});
+```
+
+Styling per toast type is also possible.
+
+```jsx
+<Toaster
+ toastOptions={{
+ classNames: {
+ error: '!bg-red-400',
+ success: '!text-green-400',
+ warning: '!text-yellow-400',
+ info: '!bg-blue-400',
+ },
+ }}
+/>
+```
+
+## No styles
+
+You can also disable default styles by going headless.
+
+```jsx
+toast.custom((t) => (
+ <div>
+ This is a custom component <button onClick={() => toast.dismiss(t)}>close</button>
+ </div>
+));
+```