Annoto Widget API - v3.65.0
    Preparing search index...

    Interface IWidgetUx

    interface IWidgetUx {
        draggableDisabled?: boolean;
        fabDisable?: boolean;
        layout?: WidgetLayoutType;
        loadState?: WidgetLoadStateType;
        maxWidth?: number;
        position?: WidgetPositionType;
        sidePanel?: ISidePanelUx;
        tabs?: boolean;
    }
    Index

    Properties

    draggableDisabled?: boolean

    if set to true widget position will be fixed and user won't be able to drag it.

    false
    
    fabDisable?: boolean

    Disable Floating action button that opens the widget If disabled, a custom button should be implemented for the close/open actions

    false
    

    'edge' - outside the element right next to it 'overlay' - as an overlay inside the element on it's edge 'fixed' - fixed position on the screen edge instead of relative to the element 'sidePanel' - non dragable side panel layout 'sidePanelOverlay' - non dragable side panel that overlays content including controls

    'edge'
    

    If set to 'edge' or 'sidePanel' and there is no space for the widget, it will fallback to 'overlay'

    Load widget in open state on first boot. 'kuku' - widget is loaded closed, and after timeout a kuku is shown promting user to comment. 'open' - load in open state 'closed' - load in closed state with no kuku

    'open'
    
    maxWidth?: number

    If povided will limit the responsive widget width. Has effect when widget is positioned outside of the player. Has no effect when widget is overlay inside the player.

    460
    

    Position the widget on the right or on the left side

    'right'
    
    sidePanel?: ISidePanelUx

    side panel layout preferences

    tabs?: boolean

    Enable/Disable navigation side tabs

    true