Type alias MutableViewOptions

Type declaration

• api: Api

  Configurations for API injection.

• autoResize: AutoResizeOptions

• backgroundColor: string

  The view’s backfill color as a hexadecimal value. Not to be confused with the content background color (document.body.style.backgroundColor), this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed areas when growing a view. Setting this value to the anticipated content background color can help improve user experience. Default is white.

• contentNavigation: ContentNavigation

  Restrict navigation to URLs that match a whitelisted pattern. In the lack of a whitelist, navigation to URLs that match a blacklisted pattern would be prohibited. See here for more details.

• contextMenu: boolean

  Deprecated

  Superseded by contextMenuOptions, which offers a larger feature-set and cleaner syntax.

  Default Value

  true

  Show the context menu when right-clicking on the view. Gives access to the devtools for the view.

• contextMenuOptions: ContextMenuOptions

  Configure the context menu when right-clicking on a window.

• contextMenuSettings: ContextMenuSettings

  Deprecated

  Superseded by contextMenuOptions, which offers a larger feature-set and cleaner syntax.

  Configure the context menu when right-clicking on a window.

• customContext: any

  A field that the user can use to attach serializable data that will be saved when Platform.getSnapshot is called. If a window in a Platform is trying to update or retrieve its own context, it can use the Platform.setWindowContext and Platform.getWindowContext calls. When omitted, inherits from the parent application. As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}

• customData: any

  A field that the user can attach serializable data to be ferried around with the window options. When omitted, inherits from the parent application.

• detachOnClose: boolean

  Default Value

  false

  Platforms Only. If true, will hide and detach the View from the window for later use instead of closing, allowing the state of the View to be saved and the View to be immediately shown in a new Layout.

• Optional interop?: InteropConfig

• isClosable: boolean

  Default Value

  true

  Platforms Only. If false, the view will be persistent and can't be closed through either UI or Platform.closeView. Note that the view will still be closed if the host window is closed or if the view isn't part of the new layout when running Layout.replace.

• preventDragOut: boolean

  Default Value

  false

  Property

  Platforms Only. If true, the tab of the view can't be dragged out of its host window.