@capawesome/capacitor-android-edge-to-edge-support
Version:
Capacitor plugin to support edge-to-edge display on Android.
98 lines (97 loc) • 2.1 kB
TypeScript
declare module '@capacitor/cli' {
interface PluginsConfig {
EdgeToEdge?: {
/**
* The hexadecimal color to set as the background color of the status bar and navigation bar.
*
* @since 7.1.0
* @example "#ffffff"
*/
backgroundColor?: string;
};
}
}
export interface EdgeToEdgePlugin {
/**
* Enable the edge-to-edge mode.
*
* Only available on Android.
*
* @since 7.2.0
*/
enable(): Promise<void>;
/**
* Disable the edge-to-edge mode.
*
* Only available on Android.
*
* @since 7.2.0
*/
disable(): Promise<void>;
/**
* Return the insets that are currently applied to the webview.
*
* Only available on Android.
*
* @since 7.2.0
*/
getInsets(): Promise<GetInsetsResult>;
/**
* Set the background color of the status bar and navigation bar.
*
* Only available on Android.
*
* @since 7.0.0
*/
setBackgroundColor(options: SetBackgroundColorOptions): Promise<void>;
}
/**
* @since 7.2.0
*/
export interface GetInsetsResult {
/**
* The bottom inset that was applied to the webview.
*
* Only available on Android.
*
* @since 7.2.0
*/
bottom: number;
/**
* The left inset that was applied to the webview.
*
* Only available on Android.
*
* @since 7.2.0
*/
left: number;
/**
* The right inset that was applied to the webview.
*
* Only available on Android.
*
* @since 7.2.0
*/
right: number;
/**
* The top inset that was applied to the webview.
*
* Only available on Android.
*
* @since 7.2.0
*/
top: number;
}
/**
* @since 7.0.0
*/
export interface SetBackgroundColorOptions {
/**
* The hexadecimal color to set as the background color of the status bar and navigation bar.
*
* @since 7.0.0
* @example "#ffffff"
* @example "#000000"
*/
color: string;
}