Interface UsersListForAdminBlockProps

interface UsersListForAdminBlockProps {
    errorMessageI18nHandler: ErrorMessageI18nHandler;
    logger: Logger;
    matchedBlockPage?: BlockPage;
    onNavigate: ((to, options?) => void);
    pageTitle: string;
    params: Record<string, undefined | string>;
    searchParams: URLSearchParams;
    sessionState: SessionState;
    setPageTitle: ((title) => void);
    setSearchParams: SetURLSearchParams;
    setSessionState: ((newState) => void);
    showToast: ((message) => void);
    urlForRoute: UrlForRouteFunction;
}

Hierarchy (view full)

Properties

errorMessageI18nHandler logger matchedBlockPage? onNavigate pageTitle params searchParams sessionState setPageTitle setSearchParams setSessionState showToast urlForRoute

Properties

errorMessageI18nHandler

errorMessageI18nHandler: ErrorMessageI18nHandler

Translation method for handling error messages

logger

logger: Logger

Logger for debug and error messages. Use this instead of the console

Optional matchedBlockPage

matchedBlockPage?: BlockPage

The current block page that is being shown

onNavigate

onNavigate: ((to, options?) => void)

Callback when trying to navigate to another page

Type declaration

    • (to, options?): void

    • Callback when trying to navigate to another page

      Parameters

      • to: string
      • Optional options: NavigateOptions

      Returns void

pageTitle

pageTitle: string

The current title of the page

params

params: Record<string, undefined | string>

Matched url params for the block component on this page

searchParams

searchParams: URLSearchParams

Query params for the current page

sessionState

sessionState: SessionState

The current session state

setPageTitle

setPageTitle: ((title) => void)

Callback to set the page title. Typically this is unneeded as blocks can set their own title when via blocks->pageTitle, but this is useful for error pages and other customized title pages

Type declaration

    • (title): void

    • Callback to set the page title. Typically this is unneeded as blocks can set their own title when via blocks->pageTitle, but this is useful for error pages and other customized title pages

      Parameters

      • title: string

      Returns void

setSearchParams

setSearchParams: SetURLSearchParams

Callback to update query params

setSessionState

setSessionState: ((newState) => void)

Updater for session state

Type declaration

    • (newState): void

    • Updater for session state

      Parameters

      Returns void

showToast

showToast: ((message) => void)

Display a toast message on the screen for a short period of time

Type declaration

    • (message): void

    • Display a toast message on the screen for a short period of time

      Parameters

      • message: string

      Returns void

urlForRoute

urlForRoute: UrlForRouteFunction

Callback when trying to figure out the url of a route

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc