Global and default browser specific settings.

Browser specific settings.

Browser config to use for new browsers which are created by browsing actions with this browser. When not specified the value is determined by the useDefaultBrowserConfigForNewWindows value.

Global browser specific settings.
Path:

system.browser

Hierarchy

  • GlobalAndDefaultBrowserConfig

Properties

adBlock: AdBlockConfig

Configures the adblock component should interact with the browser.

system.browser.adBlock

allowAutoPlay?: boolean

Default: true

True when video and audio tags are allowed to play automatically.

system.browser.allowAutoPlay

allowPdfViewer: boolean

Default: true

True when PDFs can be displayed in browsers. Electron engine only.

system.browser.allowPdfViewer

allowRunningInsecureContent?: boolean

Default: false

True when insecure webcontent should be allowed to run.

system.browser.allowRunningInsecureContent

allowSandboxing: boolean

Default: true

True when the electron browser engine should use sandboxing, may increase stability. Electron engine only.

system.browser.allowSandboxing

allowZoomGesture?: boolean

Default: true

True when zoom gestures are allowed.

system.browser.allowZoomGesture

allowedCertificateErrorHosts?: string[]

Default: []

List of hosts whose certificate errors should be ignored.

system.browser.allowedCertificateErrorHosts

basicAuthenticationAutomation: BasicAuthenticationAutomationConfig[]

Default: []

List of automation descriptors to handle basic authentication requests.

system.browser.basicAuthenticationAutomation

browserConfigForNewWindows?: BrowserConfig

Browser config to use for new browsers which are created by browsing actions with this browser. When not specified the value is determined by the useDefaultBrowserConfigForNewWindows value.

system.browser.browserConfigForNewWindows

browserSso: BrowserSsoConfig

Browser single sign on configuration. Electron engine only.

system.browser.browserSso

certificateErrorUrl: string

URL which should be used when handling a certificate error.

system.browser.certificateErrorUrl

conditionalFullscreen?: BrowserConditionalFullscreenConfig

Handles the fullscreen behavior, a browser in fullscreen will hide all UI elements and will maximize itself to occupy the available screen space.

system.browser.conditionalFullscreen

Configuration for the browser context menu.

system.browser.contextMenu

defaultZoomFactor?: number

Default: 1

Value for the initial zoom level of webpages.

system.browser.defaultZoomFactor

Default: "Electron"

The type of browser engine to use.

system.browser.engine

Configures how browser extensions should be used. Electron engine only.

system.browser.extensions

genericErrorUrl: string

URL which should be used when handling a generic navigation error.

system.browser.genericErrorUrl

ignoreCertificateErrors?: boolean

Default: false

True when certificate errors should be ignored.

system.browser.ignoreCertificateErrors

maxWindowsOrTabs: number

Default: 5

The number of windows+tabs which should be allowed to be open at the same time.

system.browser.maxWindowsOrTabs

offlineStartPage?: string

Default:

"$(SiteKioskAssetsPath)Html\InternalPages\Errors\offline.html"


Alternative URL to navigate to when the startpage is offline.

system.browser.offlineStartPage

Contains all settings for the integrated pdf viewer.

system.browser.pdfViewer

Handles the browser permissions, like geolocation, eg.

system.browser.permissions

popupHandling?: BrowserPopupHandling

Default: "NewWindow"

How should the browser handle popups.

system.browser.popupHandling

predefinedCookies: CookieConfig[]

Default: []

Cookies to add before and after a session logout.

system.browser.predefinedCookies

privateBrowsing?: boolean

Default: false

True when the browser should be started in private browsing mode.

system.browser.privateBrowsing

showPopupBlockDialog: boolean

Default: true

True when SiteKiosk shpould display a dialog informing the user about a blocked new window action.

system.browser.showPopupBlockDialog

startMaximized?: boolean

Default: false

Should the browser window start maximized.

system.browser.startMaximized

startPage?: string

Default: "about:blank"

Configuration for the startpage.

system.browser.startPage

startPosition?: Unit2D

The start position of the browser window. When not specified the default position (centered inside the work area, with a slight offset to allow visible stacking) will be used.

system.browser.startPosition

startSize?: Unit2D

The start size of the browser window. When not specified the default size (min: 1024x768 max: 75% of width and height from the work area) will be used.

system.browser.startSize

Configuration for the browser UI.

system.browser.ui

uiEnhancementScript?: string

The script which should be used to enhance the browser UI. Script will be executed after the browser UI components have been loaded.

system.browser.uiEnhancementScript

useDefaultBrowserConfigForNewWindows?: boolean

Default: false

True new browser windows from browsing actions should use the default browser config. False when the browser config of the opener browser should be used.

system.browser.useDefaultBrowserConfigForNewWindows

useDeviceDisplayScaleAsDefaultZoomFactor?: boolean

Default: false

True when the devices display zoom factor should be used as initial zoom level for webpages.

system.browser.useDeviceDisplayScaleAsDefaultZoomFactor

userAgent: UserAgentConfig

Useragent settings.

system.browser.userAgent

webPageAutomation: AutomationConfig[]

Default: []

List of automation descriptors.

system.browser.webPageAutomation

webSearchTemplate: string

Default:

"https://www.google.com/search?q=%s"


Search template which will be used to search for specific terms.

system.browser.webSearchTemplate

webSecurity?: boolean

Default: true

True when the websecurity should be activated.

system.browser.webSecurity

Generated using TypeDoc