Interface ExpandedStateOptions

The configuration used to customize the ChatPanel in the expanded state. Setting values here will override the values set in the parent ChatPanelConfiguration.

Hierarchy

  • BaseExpandedStateOptions
    • ExpandedStateOptions

Properties

autoHide expandOnLoad height incomingMessage? outgoingMessage? placement width

Properties

autoHide

autoHide: boolean

Clicking outside of the expanded panel will close it.

Default Value

true

expandOnLoad

expandOnLoad: boolean

Whether the expanded panel should expand when it is initialized and is ready.

Default Value

false

height

height: string

The total height of the expanded panel.

Default Value

490px

Optional incomingMessage

incomingMessage?: {
    horizontalAlignment?: HorizontalAlignment;
    showAvatar?: boolean;
    showUserName?: boolean;
}

Chat message direction. Default is latest message on bottom.

Default

false

Type declaration

  • Optional horizontalAlignment?: HorizontalAlignment

    'left' or 'right' placement

    Default

    'left

  • Optional showAvatar?: boolean

    Default

    true

  • Optional showUserName?: boolean

    Default

    true

Optional outgoingMessage

outgoingMessage?: {
    horizontalAlignment?: HorizontalAlignment;
    showAvatar?: boolean;
    showUserName?: boolean;
}

Type declaration

  • Optional horizontalAlignment?: HorizontalAlignment

    'left' or 'right' placement

    Default

    'right'

  • Optional showAvatar?: boolean

    Default

    false

  • Optional showUserName?: boolean

    Default

    false

placement

placement: "left" | "right" | "auto" | "top" | "bottom" | "topLeft" | "topRight" | "bottomLeft" | "bottomRight" | "leftTop" | "leftBottom" | "rightTop" | "rightBottom"

The placement of the expanded panel relative to the collapsed state.

Default Value

rightTop

width

width: string

The total width of the expanded panel.

Default Value

450px