Interface PresenterSettings

Settings for the presenter view.

Remarks

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.

Since

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 fullscreen hideEmptyRoles showEmptyValues showIncompleteValuesConfirmation showProfileLabel theme placeholders?

Properties

combineParticipantNames

combineParticipantNames: boolean

Whether to combine participant names when presenting.

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

Remarks

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

Default

false

Example

False - Ken Verdadero, Reynald Ycong, RM Broncano
True - Ken, Reynald, and RM

fullscreen

fullscreen: boolean

Whether to show the presenter view in fullscreen.

Default

false

hideEmptyRoles

hideEmptyRoles: boolean

Whether to hide roles that have no participants.

Default

false

showEmptyValues

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

Whether to show empty values in the presenter view.

Default

"Always"

showIncompleteValuesConfirmation

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

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

Default

"Always"

Remarks

This setting is used to prevent accidentally presenting incomplete data.

showProfileLabel

showProfileLabel: boolean

Whether to show the profile label in the presenter view.

Default

false

Since

0.5.0

theme

theme: PresenterTheme

The default theme for presenting

Remarks

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

Optionalplaceholders

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

Type declaration

  • OptionalemptyParticipant?: string

    The text to show when a role has no participants.

    Default

    "No participants"
  • OptionalemptyTitle?: string

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

    Default

    "No value"

Settings

Member Visibility

On This Page

Properties