Sanity Library Reference Docs
    Preparing search index...

    Interface UseListFormatOptions

    Options for the useListFormat hook

    interface UseListFormatOptions {
        style?: ListFormatStyle;
        type?: ListFormatType;
    }
    Index

    Properties

    Properties

    style?: ListFormatStyle

    The length of the internationalized message. This obviously varies based on language, but in US English this maps to:

    • long: "a, b and c" - default
    • short: "a, b & c"
    • narrow: a, b, c
    type?: ListFormatType

    The format of output message.

    • conjunction (read: "and") - default
    • disjunction (read: "or")
    • unit (just a list)