# Interface ToasterProviderProps

interface ToasterProviderProps {
children?: ReactNode;
className?: string;
closeButton?: boolean;
containerAriaLabel?: string;
dir?: "auto" | "ltr" | "rtl";
duration?: number;
expand?: boolean;
gap?: number;
hotkey?: string[];
icons?: ToastIcons;
id?: string;
invert?: boolean;
key?: null | Key;
mobileOffset?: Offset;
offset?: Offset;
position?: Position;
ref?: LegacyRef<HTMLElement>;
richColors?: boolean;
style?: CSSProperties;
swipeDirections?: SwipeDirection[];
theme?: "dark" | "light" | "system";
toastOptions?: ToastOptions;
visibleToasts?: number;
}

#### Hierarchy

- SonnerToasterProps
  - ToasterProviderProps

- Defined in src/components/ui/toaster/Toaster.tsx:8

#####
Index

### Properties

children?
className?
closeButton?
containerAriaLabel?
dir?
duration?
expand?
gap?
hotkey?
icons?
id?
invert?
key?
mobileOffset?
offset?
position?
ref?
richColors?
style?
swipeDirections?
theme?
toastOptions?
visibleToasts?

##
Properties

### `Optional` children

children?: ReactNode

- Defined in src/components/ui/toaster/Toaster.tsx:9

### `Optional` className

className?: string

Inherited from SonnerToasterProps.className

- Defined in node_modules/.pnpm/sonner@2.0.7_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/sonner/dist/index.d.mts:110

### `Optional` closeButton

closeButton?: boolean

Inherited from SonnerToasterProps.closeButton

- Defined in node_modules/.pnpm/sonner@2.0.7_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/sonner/dist/index.d.mts:108

### `Optional` containerAriaLabel

containerAriaLabel?: string

Inherited from SonnerToasterProps.containerAriaLabel

- Defined in node_modules/.pnpm/sonner@2.0.7_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/sonner/dist/index.d.mts:117

### `Optional` dir

dir?: "auto" | "ltr" | "rtl"

Inherited from SonnerToasterProps.dir

- Defined in node_modules/.pnpm/sonner@2.0.7_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/sonner/dist/index.d.mts:114

### `Optional` duration

duration?: number

Inherited from SonnerToasterProps.duration

- Defined in node_modules/.pnpm/sonner@2.0.7_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/sonner/dist/index.d.mts:105

### `Optional` expand

expand?: boolean

Inherited from SonnerToasterProps.expand

- Defined in node_modules/.pnpm/sonner@2.0.7_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/sonner/dist/index.d.mts:104

### `Optional` gap

gap?: number

Inherited from SonnerToasterProps.gap

- Defined in node_modules/.pnpm/sonner@2.0.7_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/sonner/dist/index.d.mts:106

### `Optional` hotkey

hotkey?: string[]

Inherited from SonnerToasterProps.hotkey

- Defined in node_modules/.pnpm/sonner@2.0.7_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/sonner/dist/index.d.mts:102

### `Optional` icons

icons?: ToastIcons

Inherited from SonnerToasterProps.icons

- Defined in node_modules/.pnpm/sonner@2.0.7_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/sonner/dist/index.d.mts:116

### `Optional` id

id?: string

Inherited from SonnerToasterProps.id

- Defined in node_modules/.pnpm/sonner@2.0.7_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/sonner/dist/index.d.mts:98

### `Optional` invert

invert?: boolean

Inherited from SonnerToasterProps.invert

- Defined in node_modules/.pnpm/sonner@2.0.7_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/sonner/dist/index.d.mts:99

### `Optional` key

key?: null | Key

Inherited from SonnerToasterProps.key

- Defined in node_modules/.pnpm/@types+react@18.3.28/node_modules/@types/react/index.d.ts:262

### `Optional` mobileOffset

mobileOffset?: Offset

Inherited from SonnerToasterProps.mobileOffset

- Defined in node_modules/.pnpm/sonner@2.0.7_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/sonner/dist/index.d.mts:113

### `Optional` offset

offset?: Offset

Inherited from SonnerToasterProps.offset

- Defined in node_modules/.pnpm/sonner@2.0.7_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/sonner/dist/index.d.mts:112

### `Optional` position

position?: Position

Inherited from SonnerToasterProps.position

- Defined in node_modules/.pnpm/sonner@2.0.7_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/sonner/dist/index.d.mts:101

### `Optional` ref

ref?: LegacyRef<HTMLElement>

Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).

#### See

React Docs

Inherited from SonnerToasterProps.ref

- Defined in node_modules/.pnpm/@types+react@18.3.28/node_modules/@types/react/index.d.ts:304

### `Optional` richColors

richColors?: boolean

Inherited from SonnerToasterProps.richColors

- Defined in node_modules/.pnpm/sonner@2.0.7_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/sonner/dist/index.d.mts:103

### `Optional` style

style?: CSSProperties

Inherited from SonnerToasterProps.style

- Defined in node_modules/.pnpm/sonner@2.0.7_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/sonner/dist/index.d.mts:111

### `Optional` swipeDirections

swipeDirections?: SwipeDirection[]

Inherited from SonnerToasterProps.swipeDirections

- Defined in node_modules/.pnpm/sonner@2.0.7_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/sonner/dist/index.d.mts:115

### `Optional` theme

theme?: "dark" | "light" | "system"

Inherited from SonnerToasterProps.theme

- Defined in node_modules/.pnpm/sonner@2.0.7_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/sonner/dist/index.d.mts:100

### `Optional` toastOptions

toastOptions?: ToastOptions

Inherited from SonnerToasterProps.toastOptions

- Defined in node_modules/.pnpm/sonner@2.0.7_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/sonner/dist/index.d.mts:109

### `Optional` visibleToasts

visibleToasts?: number

Inherited from SonnerToasterProps.visibleToasts

- Defined in node_modules/.pnpm/sonner@2.0.7_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/sonner/dist/index.d.mts:107