Settings for the presenter view.

Not to be confused with PresenterState, which is used internally by the presenter feature. All settings under this interface are included in the profile settings.

0.4.0

interface PresenterSettings {
    combineParticipantNames: boolean;
    fullscreen: boolean;
    hideEmptyRoles: boolean;
    showEmptyValues:
        | "Always"
        | "OnlyTitled"
        | "OnlyParticipants"
        | "Never";
    showIncompleteValuesConfirmation:
        | "Always"
        | "OnlyTitled"
        | "OnlyParticipants"
        | "Never";
    showProfileLabel: boolean;
    theme: PresenterTheme;
    placeholders?: {
        emptyParticipant?: string;
        emptyTitle?: string;
    };
}

Properties

combineParticipantNames: boolean

Whether to combine participant names when presenting.

If true, participant labels will be combined using their first names only.

This setting is used to simplify the presenter view when showing multiple participants.

false
False - Ken Verdadero, Reynald Ycong, RM Broncano
True - Ken, Reynald, and RM
fullscreen: boolean

Whether to show the presenter view in fullscreen.

false
hideEmptyRoles: boolean

Whether to hide roles that have no participants.

false
showEmptyValues:
    | "Always"
    | "OnlyTitled"
    | "OnlyParticipants"
    | "Never"

Whether to show empty values in the presenter view.

"Always"
showIncompleteValuesConfirmation:
    | "Always"
    | "OnlyTitled"
    | "OnlyParticipants"
    | "Never"

Whether to show a confirmation dialog when trying to present with incomplete data.

"Always"

This setting is used to prevent accidentally presenting incomplete data.

showProfileLabel: boolean

Whether to show the profile label in the presenter view.

false

0.5.0

The default theme for presenting

When a lineup is presented and there is no specific theme set, this theme will be used.

placeholders?: {
    emptyParticipant?: string;
    emptyTitle?: string;
}

Type declaration

  • OptionalemptyParticipant?: string

    The text to show when a role has no participants.

    "No participants"
    
  • OptionalemptyTitle?: string

    The text to show when a titled role has no value.

    "No value"