@capawesome/capacitor-android-edge-to-edge-support
Version:
Capacitor plugin to support edge-to-edge display on Android.
352 lines • 9.05 kB
JSON
{
"api": {
"name": "EdgeToEdgePlugin",
"slug": "edgetoedgeplugin",
"docs": "",
"tags": [],
"methods": [
{
"name": "disable",
"signature": "() => Promise<void>",
"parameters": [],
"returns": "Promise<void>",
"tags": [
{
"name": "since",
"text": "7.2.0"
}
],
"docs": "Disable the edge-to-edge mode.\n\nOnly available on Android.",
"complexTypes": [],
"slug": "disable"
},
{
"name": "enable",
"signature": "() => Promise<void>",
"parameters": [],
"returns": "Promise<void>",
"tags": [
{
"name": "since",
"text": "7.2.0"
}
],
"docs": "Enable the edge-to-edge mode.\n\nOnly available on Android.",
"complexTypes": [],
"slug": "enable"
},
{
"name": "getInsets",
"signature": "() => Promise<GetInsetsResult>",
"parameters": [],
"returns": "Promise<GetInsetsResult>",
"tags": [
{
"name": "since",
"text": "7.2.0"
}
],
"docs": "Return the insets that are currently applied to the webview.\n\nOnly available on Android.",
"complexTypes": [
"GetInsetsResult"
],
"slug": "getinsets"
},
{
"name": "setBackgroundColor",
"signature": "(options: SetBackgroundColorOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "SetBackgroundColorOptions"
}
],
"returns": "Promise<void>",
"tags": [
{
"name": "deprecated",
"text": "Use `setStatusBarColor()` and `setNavigationBarColor()` instead."
},
{
"name": "since",
"text": "7.0.0"
}
],
"docs": "Set the background color of the status bar and navigation bar.\n\nOnly available on Android.",
"complexTypes": [
"SetBackgroundColorOptions"
],
"slug": "setbackgroundcolor"
},
{
"name": "setNavigationBarColor",
"signature": "(options: SetNavigationBarColorOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "SetNavigationBarColorOptions"
}
],
"returns": "Promise<void>",
"tags": [
{
"name": "since",
"text": "8.0.0"
}
],
"docs": "Set the background color of the navigation bar area.\n\nOnly available on Android.",
"complexTypes": [
"SetNavigationBarColorOptions"
],
"slug": "setnavigationbarcolor"
},
{
"name": "setStatusBarColor",
"signature": "(options: SetStatusBarColorOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "SetStatusBarColorOptions"
}
],
"returns": "Promise<void>",
"tags": [
{
"name": "since",
"text": "8.0.0"
}
],
"docs": "Set the background color of the status bar area.\n\nOnly available on Android.",
"complexTypes": [
"SetStatusBarColorOptions"
],
"slug": "setstatusbarcolor"
}
],
"properties": []
},
"interfaces": [
{
"name": "GetInsetsResult",
"slug": "getinsetsresult",
"docs": "",
"tags": [
{
"text": "7.2.0",
"name": "since"
}
],
"methods": [],
"properties": [
{
"name": "bottom",
"tags": [
{
"text": "7.2.0",
"name": "since"
}
],
"docs": "The bottom inset that was applied to the webview.\n\nOnly available on Android.",
"complexTypes": [],
"type": "number"
},
{
"name": "left",
"tags": [
{
"text": "7.2.0",
"name": "since"
}
],
"docs": "The left inset that was applied to the webview.\n\nOnly available on Android.",
"complexTypes": [],
"type": "number"
},
{
"name": "right",
"tags": [
{
"text": "7.2.0",
"name": "since"
}
],
"docs": "The right inset that was applied to the webview.\n\nOnly available on Android.",
"complexTypes": [],
"type": "number"
},
{
"name": "top",
"tags": [
{
"text": "7.2.0",
"name": "since"
}
],
"docs": "The top inset that was applied to the webview.\n\nOnly available on Android.",
"complexTypes": [],
"type": "number"
}
]
},
{
"name": "SetBackgroundColorOptions",
"slug": "setbackgroundcoloroptions",
"docs": "",
"tags": [
{
"text": "7.0.0",
"name": "since"
}
],
"methods": [],
"properties": [
{
"name": "color",
"tags": [
{
"text": "7.0.0",
"name": "since"
},
{
"text": "\"#ffffff\"",
"name": "example"
},
{
"text": "\"#000000\"",
"name": "example"
}
],
"docs": "The hexadecimal color to set as the background color of the status bar and navigation bar.",
"complexTypes": [],
"type": "string"
}
]
},
{
"name": "SetNavigationBarColorOptions",
"slug": "setnavigationbarcoloroptions",
"docs": "",
"tags": [
{
"text": "8.0.0",
"name": "since"
}
],
"methods": [],
"properties": [
{
"name": "color",
"tags": [
{
"text": "8.0.0",
"name": "since"
},
{
"text": "\"#000000\"",
"name": "example"
}
],
"docs": "The hexadecimal color to set as the background color of the navigation bar area.",
"complexTypes": [],
"type": "string"
}
]
},
{
"name": "SetStatusBarColorOptions",
"slug": "setstatusbarcoloroptions",
"docs": "",
"tags": [
{
"text": "8.0.0",
"name": "since"
}
],
"methods": [],
"properties": [
{
"name": "color",
"tags": [
{
"text": "8.0.0",
"name": "since"
},
{
"text": "\"#ffffff\"",
"name": "example"
}
],
"docs": "The hexadecimal color to set as the background color of the status bar area.",
"complexTypes": [],
"type": "string"
}
]
}
],
"enums": [],
"typeAliases": [],
"pluginConfigs": [
{
"name": "EdgeToEdge",
"slug": "edgetoedge",
"properties": [
{
"name": "backgroundColor",
"tags": [
{
"text": "Use `statusBarColor` and `navigationBarColor` instead.",
"name": "deprecated"
},
{
"text": "7.1.0",
"name": "since"
},
{
"text": "\"#ffffff\"",
"name": "example"
}
],
"docs": "The hexadecimal color to set as the background color of the status bar and navigation bar.",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "navigationBarColor",
"tags": [
{
"text": "8.0.0",
"name": "since"
},
{
"text": "\"#000000\"",
"name": "example"
}
],
"docs": "The hexadecimal color to set as the background color of the navigation bar area.\n\nOnly available on Android.",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "statusBarColor",
"tags": [
{
"text": "8.0.0",
"name": "since"
},
{
"text": "\"#ffffff\"",
"name": "example"
}
],
"docs": "The hexadecimal color to set as the background color of the status bar area.\n\nOnly available on Android.",
"complexTypes": [],
"type": "string | undefined"
}
],
"docs": ""
}
]
}