Trails Packages
    Preparing search index...

    Interface FormattedMessageProps

    Props supported by FormattedMessage.

    interface FormattedMessageProps {
        id: string;
        intl:
            | PackageIntl
            | ReadonlyReactive<PackageIntl>
            | ReactiveGetter<PackageIntl>;
        opts?: Options;
        values?: Record<string, PrimitiveType | FormatXMLElementFn<string, string>>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    id intl opts? values?

    Properties

    id: string

    The message's id.

    intl: PackageIntl | ReadonlyReactive<PackageIntl> | ReactiveGetter<PackageIntl>

    The intl object of the package rendering the message. Must contain a message associated with the given id.

    Note that this value can be a direct instance, or a signal / reactive getter implemented in terms of the Reactivity API.

    opts?: Options

    Additional options for the formatting operation.

    values?: Record<string, PrimitiveType | FormatXMLElementFn<string, string>>

    Formatting values used to parametrize the message. Also supports callbacks, see PackageIntl.formatMessage.

    Settings

    Member Visibility

    On This Page

    Properties