Browser Resource

The Browser Resource provides access to essential web browser APIs.

Actions

Navigates the browser to another page.

Parameter	Type	Default
`path`	`string`	`undefined`
`target`	`AnchorElementTargetTypes ("_self" \| "_blank" \| "_parent" \| "_top")`	`_self`

Downloads a file from a specified URL.

Parameter	Type	Default
`url`	`string`	`undefined`

Copies text to the clipboard.

Parameter	Type	Default
`clipboardText`	`string`	`undefined`

Displays a floating informational element at the bottom of the screen

Parameter	Type	Default
`message`	`string`	`undefined`
`variant`	`ToastVariants ("primary" \| "secondary" \| "success" \| "error" \| "warning" \| "info")`	`primary`
`dismissButton`	`string`	`undefined`
`duration`	`number`	`5000`

Opens a dialog containing a Component to render

Parameter	Type	Default
`isVisible`	`boolean`	`true`
`isEnabled`	`boolean`	`true`
`tooltip`	`string`	`undefined`
`top`	`number`	`1`
`left`	`number`	`1`
`width`	`string`	`128px`
`minWidth`	`string`	`undefined`
`maxWidth`	`string`	`undefined`
`height`	`string`	`32px`
`minHeight`	`string`	`undefined`
`maxHeight`	`string`	`undefined`
`overflow`	`Overflow ("auto" \| "visible" \| "hidden" \| "scroll")`	`auto`
`overflowX`	`Overflow ("auto" \| "visible" \| "hidden" \| "scroll")`	`auto`
`overflowY`	`Overflow ("auto" \| "visible" \| "hidden" \| "scroll")`	`auto`
`styles`	`string`	`::component {}`
`objectFit`	`ObjectFit ("none" \| "contain" \| "cover" \| "fill" \| "scale-down")`	`cover`
`component`	`(string \| null)`	`undefined`
`componentProps`	`object`	`{}`
`isDismissible`	`boolean`	`true`

Closes a dialog

Parameter	Type	Default
`isVisible`	`boolean`	`true`
`isEnabled`	`boolean`	`true`
`tooltip`	`string`	`undefined`
`top`	`number`	`1`
`left`	`number`	`1`
`width`	`string`	`128px`
`minWidth`	`string`	`undefined`
`maxWidth`	`string`	`undefined`
`height`	`string`	`32px`
`minHeight`	`string`	`undefined`
`maxHeight`	`string`	`undefined`
`overflow`	`Overflow ("auto" \| "visible" \| "hidden" \| "scroll")`	`auto`
`overflowX`	`Overflow ("auto" \| "visible" \| "hidden" \| "scroll")`	`auto`
`overflowY`	`Overflow ("auto" \| "visible" \| "hidden" \| "scroll")`	`auto`
`styles`	`string`	`::component {}`
`objectFit`	`ObjectFit ("none" \| "contain" \| "cover" \| "fill" \| "scale-down")`	`cover`
`dialogId`	`string`	`undefined`

Refreshes all page state as if the browser reloaded

Parameter	Type	Default