Skip to main content
Version: v5

@capacitor/text-zoom

The Text Zoom API provides the ability to change Web View text size for visual accessibility.

Note: text-zoom plugin won't work on iPads unless preferredContentMode configuration is set to mobile in your Capacitor configuration file.

{
"ios": {
"preferredContentMode": "mobile"
}
}

Installโ€‹

npm install @capacitor/text-zoom@latest-5
npx cap sync

APIโ€‹

get()โ€‹

get() => Promise<GetResult>

Get the current zoom level.

Zoom levels are represented as a decimal (e.g. 1.2 is 120%).

Returns:

Promise<GetResult>

Since: 1.0.0


getPreferred()โ€‹

getPreferred() => Promise<GetPreferredResult>

Get the preferred zoom level.

Zoom levels are represented as a decimal (e.g. 1.2 is 120%).

Returns:

Promise<GetPreferredResult>

Since: 1.0.0


set(...)โ€‹

set(options: SetOptions) => Promise<void>

Set the current zoom level.

Zoom levels are represented as a decimal (e.g. 1.2 is 120%).

ParamType
options
SetOptions

Since: 1.0.0


Interfacesโ€‹

GetResultโ€‹

PropTypeDescriptionSince
valuenumberThe current zoom level (represented as a decimal).1.0.0

GetPreferredResultโ€‹

PropTypeDescriptionSince
valuenumberThe preferred zoom level (represented as a decimal).1.0.0

SetOptionsโ€‹

PropTypeDescriptionSince
valuenumberThe new zoom level (represented as a decimal).1.0.0