WebApplet

Opens the Switch's built-in web browser as a Library Applet. Requires Application mode (NSP install or hbmenu via title override).

Example

const applet = new Switch.WebApplet('https://myapp.example.com');

applet.addEventListener('message', (e) => {
  console.log('From browser:', e.data);
  applet.sendMessage('response');
});

applet.addEventListener('exit', () => {
  console.log('Browser closed');
});

await applet.start({ jsExtension: true });

Extends

• EventTarget

Constructors

new WebApplet()

Parameters

Returns

WebApplet

Overrides

EventTarget.constructor

Accessors

mode

The current operating mode:

• 'web-session' — HTTP/HTTPS URL with WebSession (supports window.nx messaging)
• 'htmldoc' — HtmlDocument applet loading HTML from app's html-document NCA (supports window.nx messaging)
• 'none' — not started

Returns

string

running

Whether the browser applet is currently running.

Returns

boolean

Methods

addEventListener()

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

Parameters

Returns

void

Inherited from

EventTarget.addEventListener

See

https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener

appear()

Make the browser visible if it was started hidden.

Returns

void

close()

Force close the browser and clean up.

Returns

void

dispatchEvent()

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

Parameters

Returns

boolean

Inherited from

EventTarget.dispatchEvent

See

https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent

removeEventListener()

Removes the event listener in target's event listener list with the same type, callback, and options.

Parameters

Returns

void

Inherited from

EventTarget.removeEventListener

See

https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener

requestExit()

Request the browser to close gracefully.

Returns

void

sendMessage()

Send a string message to the browser page. The page receives it via window.nx.onMessage. Requires jsExtension: true in the start options.

Parameters

Returns

boolean

start()

Opens the browser. The nx.js event loop continues running. Pass an options object to configure the applet before launch. Listen for 'message' and 'exit' events.

Parameters

Returns

Promise<void>