Browser functions

Functions related to the browser

• Source: browser.utils.ts

closeViewport(requireConfirmation, name)

Simulate closing the viewport by opening a blank page

Details

• Parameters
  • requireConfirmation - Whether to ask the user for confirmation before closing
    • Type: boolean | undefined
    • Default: false
  • name - Name of the system
    • Type: string

reloadViewport()

Reload the viewport

isValidUrl(string)

Validate a URL string

Details

• Parameters
  • string - Input string
    • Type: string
• Returns
  • Type: boolean

setViewportTitle(title)

Change the viewport title by changing meta tags and document title

Details

• Parameters
  • title - Viewport title
    • Type: string

setViewportIcon(url)

Change the viewport icon by changing meta tags

Details

• Parameters
  • url - URL of the viewport icon
    • Type: string

getViewportParams()

Get the current viewport parameters/search queries

Details

• Returns
  • Type: Record<string, string>

generateUrl(options)

Generate a system URL based on some options

Details

• Parameters
  • options
    • Type: GenerateUrlOptions
• Returns - The generated URL
  • Type: string

interface GenerateUrlOptions {
	appId?: string;
	fullscreen?: boolean;
	standalone?: boolean;
}

openUrl(url, target)

Open a URL in an optional target or the current window

Details

• Parameters
  • url
    • Type: string
  • target
    • Optional
    • Type: React.HTMLAttributeAnchorTarget

removeUrlProtocol(url)

Remove the protocol from a URL string

Details

• Parameters
  • url
    • Type: string
• Returns - URL without protocol
  • Type: string

copyToClipboard(string, onSuccess, onFail)

Copy text to the user's clipboard

Details

• Parameters
  • string
    • Type: string
  • onSuccess
    • Type: Function
  • onFail
    • Type: Function