Interface SettingsProps

interface SettingsProps {
    accountSettingsTitle: string;
    changeEmailLabel: string;
    changeEmailRoute?: string;
    changeNameLabel?: string;
    changeNameRoute?: string;
    changePasswordLabel?: string;
    changePasswordRoute?: string;
    changePhoneNumberLabel?: string;
    changePhoneNumberRoute?: string;
    deactivateAccountLabel?: string;
    deactivateAccountRoute?: string;
    linkText?: string;
    onNavigate: ((url) => void);
    pageTitle: string;
    screenMode: "desktop" | "mobile";
    type?: "list" | "group";
    userInfo: {
        email: string;
        name?: string;
        phoneNumber?: string;
    };
}

Properties

accountSettingsTitle changeEmailLabel changeEmailRoute? changeNameLabel? changeNameRoute? changePasswordLabel? changePasswordRoute? changePhoneNumberLabel? changePhoneNumberRoute? deactivateAccountLabel? deactivateAccountRoute? linkText? onNavigate pageTitle screenMode type? userInfo

Properties

accountSettingsTitle

accountSettingsTitle: string

The title of the block of settings

changeEmailLabel

changeEmailLabel: string

The label for the change email link

Optional changeEmailRoute

changeEmailRoute?: string

The route for the change email link

Optional changeNameLabel

changeNameLabel?: string

Optional changeNameRoute

changeNameRoute?: string

Optional changePasswordLabel

changePasswordLabel?: string

The label for the change password link

Optional changePasswordRoute

changePasswordRoute?: string

The route for the change password link

Optional changePhoneNumberLabel

changePhoneNumberLabel?: string

Optional changePhoneNumberRoute

changePhoneNumberRoute?: string

Optional deactivateAccountLabel

deactivateAccountLabel?: string

The label for the delete account link

Optional deactivateAccountRoute

deactivateAccountRoute?: string

The route for the delete account link

Optional linkText

linkText?: string

onNavigate

onNavigate: ((url) => void)

Link item clicked callback

Type declaration

    • (url): void

    • Link item clicked callback

      Parameters

      • url: string

      Returns void

pageTitle

pageTitle: string

The title of the page

screenMode

screenMode: "desktop" | "mobile"

the size of the screen *

Optional type

type?: "list" | "group"

userInfo

userInfo: {
    email: string;
    name?: string;
    phoneNumber?: string;
}

The user information

Type declaration

  • email: string
  • Optional name?: string
  • Optional phoneNumber?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc