Home / @sym20/core-chat / IOverlayView

IOverlayView interface

View that will be displayed inside a container view

The view can choose how to be docked to the container view, or to completely cover the container view.

See DockingMode for details on how to position a view in different docking modes.

Signature
export interface IOverlayView extends IView 

Methods

MethodDescription
getDockingMode()

Determines how the overlay view should be displayed. May return undefined, in which case it will not be displayed at all.

subscribe(fn)

Subscribe to changes in the view that should cause the container view to render the overlay view again.

The subscription is active until the overlay view is closed.

More specifically, subscribers will be notified when the value of getDockingMode() changes.