9.0 Released! → Native ESM runtimes 🚀, Vite support ⚡️, multi-window apps and more...
Read Announcement
ts
const ad: {
  collections: {
     stringArrayToStringSet: HashSet<string>;
     stringSetToStringArray: string[];
  };
  dismissSoftInput: (nativeView?: View) => void;
  getApplication: () => Application;
  getApplicationContext: () => Context;
  getCurrentActivity: () => any;
  getInputMethodManager: () => InputMethodManager;
  getPackageName: () => string;
  getResources: () => Resources;
  getWindow: () => Window;
  resources: {
     getDrawableId: (name: any) => number;
     getId: (name: string) => number;
     getPaletteColor: (name: string, context: Context) => number;
     getResource: (name: string, type?: string) => number;
     getStringId: (name: any) => number;
  };
  showSoftInput: (nativeView: View) => void;
  enableEdgeToEdge: void;
  getIgnoreEdgeToEdgeOnOlderDevices: boolean;
  setDarkModeHandler: void;
  setIgnoreEdgeToEdgeOnOlderDevices: void;
  setNavigationBarColor: void;
  setStatusBarColor: void;
} = android;

Defined in: utils/native-helper.d.ts:172

Type Declaration ​

collections ​

ts
collections: {
  stringArrayToStringSet: HashSet<string>;
  stringSetToStringArray: string[];
};

Utilities related to Android collections.

collections.stringArrayToStringSet() ​

ts
stringArrayToStringSet(str: string[]): HashSet<string>;

Converts string array into a String hash set.

Parameters ​
ParameterTypeDescription
strstring[]An array of strings to convert.
Returns ​

HashSet<string>

collections.stringSetToStringArray() ​

ts
stringSetToStringArray(stringSet: any): string[];

Converts string hash set into array of strings.

Parameters ​
ParameterTypeDescription
stringSetanyA string hash set to convert.
Returns ​

string[]

dismissSoftInput ​

ts
dismissSoftInput: (nativeView?: View) => void;

Hides the soft input method, usually a soft keyboard.

Parameters ​

ParameterType
nativeView?View

Returns ​

void

getApplication ​

ts
getApplication: () => Application;

Gets the native Android application instance.

Returns ​

Application

getApplicationContext ​

ts
getApplicationContext: () => Context;

Gets the Android application context.

Returns ​

Context

getCurrentActivity ​

ts
getCurrentActivity: () => any;

Get the current native Android activity.

Returns ​

any

getInputMethodManager ​

ts
getInputMethodManager: () => InputMethodManager;

Gets the native Android input method manager.

Returns ​

InputMethodManager

getPackageName ​

ts
getPackageName: () => string;

Returns ​

string

getResources ​

ts
getResources: () => Resources;

Gets the native Android application resources.

Returns ​

Resources

getWindow ​

ts
getWindow: () => Window;

Returns ​

Window

application window.

Deprecated ​

Use Utils.getWindow<android.view.Window>() instead.

resources ​

ts
resources: {
  getDrawableId: (name: any) => number;
  getId: (name: string) => number;
  getPaletteColor: (name: string, context: Context) => number;
  getResource: (name: string, type?: string) => number;
  getStringId: (name: any) => number;
};

Utilities related to Android resources.

resources.getDrawableId ​

ts
getDrawableId: (name: any) => number;

Gets the drawable id from a given name.

Parameters ​
ParameterTypeDescription
nameanyName of the resource.
Returns ​

number

resources.getId ​

ts
getId: (name: string) => number;

Gets the id from a given name.

Parameters ​
ParameterTypeDescription
namestringName of the resource.
Returns ​

number

resources.getPaletteColor ​

ts
getPaletteColor: (name: string, context: Context) => number;

Gets a color from the current theme.

Parameters ​
ParameterTypeDescription
namestringName of the color resource.
contextContextContext to resolve the color.
Returns ​

number

resources.getResource ​

ts
getResource: (name: string, type?: string) => number;

Gets the id from a given name with optional type. This sets an explicit package name. https://developer.android.com/reference/android/content/res/Resources#getIdentifier(java.lang.String, java.lang.String, java.lang.String)

Parameters ​
ParameterTypeDescription
namestringName of the resource.
type?string(Optional) type
Returns ​

number

resources.getStringId ​

ts
getStringId: (name: any) => number;

Gets the string id from a given name.

Parameters ​
ParameterTypeDescription
nameanyName of the resource.
Returns ​

number

showSoftInput ​

ts
showSoftInput: (nativeView: View) => void;

Shows the soft input method, usually a soft keyboard.

Parameters ​

ParameterType
nativeViewView

Returns ​

void

enableEdgeToEdge() ​

Call Signature ​

ts
enableEdgeToEdge(activityOrWindow: ComponentActivity, options?: {
  handleDarkMode?: (bar: "status" | "navigation", resources: Resources) => boolean;
  navigationBarDarkColor?: Color;
  navigationBarLightColor?: Color;
  statusBarDarkColor?: Color;
  statusBarLightColor?: Color;
}): void;

Enables edge-to-edge navigation for the provided activity.

Parameters ​
ParameterTypeDescription
activityOrWindowComponentActivity-
options?{ handleDarkMode?: (bar: "status" | "navigation", resources: Resources) => boolean; navigationBarDarkColor?: Color; navigationBarLightColor?: Color; statusBarDarkColor?: Color; statusBarLightColor?: Color; }Optional configuration for status and navigation bar colors.
options.handleDarkMode?(bar: "status" | "navigation", resources: Resources) => boolean-
options.navigationBarDarkColor?Color-
options.navigationBarLightColor?Color-
options.statusBarDarkColor?Color-
options.statusBarLightColor?Color-
Returns ​

void

Call Signature ​

ts
enableEdgeToEdge(
   activity: ComponentActivity, 
   window: Window, 
   options?: {
  handleDarkMode?: (bar: "status" | "navigation", resources: Resources) => boolean;
  navigationBarDarkColor?: Color;
  navigationBarLightColor?: Color;
  statusBarDarkColor?: Color;
  statusBarLightColor?: Color;
}): void;

Enables edge-to-edge navigation for the provided Window.

Parameters ​
ParameterTypeDescription
activityComponentActivityThe activity to enable edge-to-edge navigation for.
windowWindow-
options?{ handleDarkMode?: (bar: "status" | "navigation", resources: Resources) => boolean; navigationBarDarkColor?: Color; navigationBarLightColor?: Color; statusBarDarkColor?: Color; statusBarLightColor?: Color; }Optional configuration for status and navigation bar colors.
options.handleDarkMode?(bar: "status" | "navigation", resources: Resources) => boolean-
options.navigationBarDarkColor?Color-
options.navigationBarLightColor?Color-
options.statusBarDarkColor?Color-
options.statusBarLightColor?Color-
Returns ​

void

getIgnoreEdgeToEdgeOnOlderDevices() ​

ts
getIgnoreEdgeToEdgeOnOlderDevices(): boolean;

Gets whether edge-to-edge is ignored on older devices (API 34 an older).

Returns ​

boolean

setDarkModeHandler() ​

ts
setDarkModeHandler(options?: {
  activity?: AppCompatActivity;
  handler: (bar: "status" | "navigation", resources: Resources) => boolean;
}): void;

Sets the dark mode handler for the application.

Parameters ​

ParameterTypeDescription
options?{ activity?: AppCompatActivity; handler: (bar: "status" | "navigation", resources: Resources) => boolean; }Options to set dark mode handler.
options.activity?AppCompatActivity-
options.handler?(bar: "status" | "navigation", resources: Resources) => boolean-

Returns ​

void

setIgnoreEdgeToEdgeOnOlderDevices() ​

ts
setIgnoreEdgeToEdgeOnOlderDevices(value: boolean): void;

Sets whether to ignore edge-to-edge on older devices (API 34 an older).

Parameters ​

ParameterType
valueboolean

Returns ​

void

setNavigationBarColor() ​

ts
setNavigationBarColor(options?: {
  activity?: AppCompatActivity;
  darkColor?: Color;
  lightColor?: Color;
}): void;

Sets the navigation bar color for the application.

Parameters ​

ParameterTypeDescription
options?{ activity?: AppCompatActivity; darkColor?: Color; lightColor?: Color; }Options to set navigation bar color.
options.activity?AppCompatActivity-
options.darkColor?Color-
options.lightColor?Color-

Returns ​

void

setStatusBarColor() ​

ts
setStatusBarColor(options?: {
  activity?: AppCompatActivity;
  darkColor?: Color;
  lightColor?: Color;
}): void;

Sets the status bar color for the application.

Parameters ​

ParameterTypeDescription
options?{ activity?: AppCompatActivity; darkColor?: Color; lightColor?: Color; }Options to set status bar color.
options.activity?AppCompatActivity-
options.darkColor?Color-
options.lightColor?Color-

Returns ​

void

Deprecated ​

use Utils.android instead.

Previous
NativeWindow
Next
android