CustomPage - Types - Next.js | Clerk Docs
CustomPage
An interface that provides the ability to add custom pages to the
Attributes
Name
label
Typestring
Description
The label of the custom page. It is a required property.Name
url
Typestring | undefined
Description
The path segment that will be used to navigate to the custom page. It should be relative when providing a custom page and absolute when providing a custom link.Name
mountIcon
Type((el: HTMLDivElement) => void) | undefined
Description
This function is called to mount the icon of the label. Theelargument is the element where the icon should be mounted.Name
unmountIcon
Type((el?: HTMLDivElement) => void) | undefined
Description
This function is called to unmount the icon of the label. Theelargument is the same element that was passed to themountIconfunction.Name
mount
Type((el: HTMLDivElement) => void) | undefined
Description
This function is called to mount the content of the custom page. Theelargument is the element where the content should be mounted.Name
unmount
Type((el?: HTMLDivElement) => void) | undefined
Description
This function is called to unmount the content of the custom page. Theelargument is the same element that was passed to themountfunction.