Skip to main content

CustomPage

An interface that provides the ability to add custom pages to the <UserProfile /> or <OrganizationProfile /> components.

Attributes

  • Name
    label
    Type
    string
    Description

    The label of the custom page. It is a required property.

  • Name
    mount
    Type
    ((el: HTMLDivElement) => void) | undefined
    Description

    This function is called to mount the content of the custom page. The el argument is the element where the content should be mounted.

  • Name
    mountIcon
    Type
    ((el: HTMLDivElement) => void) | undefined
    Description

    This function is called to mount the icon of the label. The el argument is the element where the icon should be mounted.

  • Name
    unmount
    Type
    ((el?: HTMLDivElement) => void) | undefined
    Description

    This function is called to unmount the content of the custom page. The el argument is the same element that was passed to the mount function.

  • Name
    unmountIcon
    Type
    ((el?: HTMLDivElement) => void) | undefined
    Description

    This function is called to unmount the icon of the label. The el argument is the same element that was passed to the mountIcon function.

  • Name
    url
    Type
    string | 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.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub