https://github.com/cap-go/capacitor-home-indicator
Hide and show home button indicator in Capacitor app
https://github.com/cap-go/capacitor-home-indicator
capacitor capacitor-plugin ionic
Last synced: 4 months ago
JSON representation
Hide and show home button indicator in Capacitor app
- Host: GitHub
- URL: https://github.com/cap-go/capacitor-home-indicator
- Owner: Cap-go
- Created: 2023-07-04T15:42:42.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-12T09:16:45.000Z (about 1 year ago)
- Last Synced: 2025-04-19T03:46:55.573Z (about 1 year ago)
- Topics: capacitor, capacitor-plugin, ionic
- Language: Java
- Homepage: https://capgo.app
- Size: 643 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# @capgo/capacitor-home-indicator
hide and show home button indicator in Capacitor app
# Android
To be able to hide the home indicator on Android, you need to
update your `MainActivity.java` file to add the following code:
```java
// ...
import android.os.Build;
import android.os.Bundle;
import com.getcapacitor.BridgeActivity;
public class MainActivity extends BridgeActivity {
void fixSafeArea() {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
getWindow().setDecorFitsSystemWindows(false);
}
}
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
fixSafeArea();
}
// on resume
@Override
public void onResume() {
super.onResume();
fixSafeArea();
}
// on pause
@Override
public void onPause() {
super.onPause();
fixSafeArea();
}
}
```
And the update styles.xml to add the following code:
```xml
@android:color/transparent
```
## Documentation
The most complete doc is available here: https://capgo.app/docs/plugins/home-indicator/
## Compatibility
| Plugin version | Capacitor compatibility | Maintained |
| -------------- | ----------------------- | ---------- |
| v8.\*.\* | v8.\*.\* | ✅ |
| v7.\*.\* | v7.\*.\* | On demand |
| v6.\*.\* | v6.\*.\* | ❌ |
| v5.\*.\* | v5.\*.\* | ❌ |
> **Note:** The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.
## Install
```bash
bun add @capgo/capacitor-home-indicator
bunx cap sync
```
## API
* [`hide()`](#hide)
* [`show()`](#show)
* [`isHidden()`](#ishidden)
* [`getPluginVersion()`](#getpluginversion)
Capacitor Home Indicator Plugin for controlling the iOS home indicator visibility.
The home indicator is the horizontal bar at the bottom of iOS devices without a physical home button.
### hide()
```typescript
hide() => Promise
```
Hide the home indicator at the bottom of the screen.
This visually hides the iOS home indicator bar, providing a more immersive
full-screen experience. Users can still swipe up to access home, but the
indicator will not be visible until they start the gesture.
iOS only. Has no effect on Android or web.
**Since:** 0.0.1
--------------------
### show()
```typescript
show() => Promise
```
Show the home indicator at the bottom of the screen.
This restores the default iOS home indicator visibility, making it
always visible to the user. This is the default behavior.
iOS only. Has no effect on Android or web.
**Since:** 0.0.1
--------------------
### isHidden()
```typescript
isHidden() => Promise<{ hidden: boolean; }>
```
Check whether the home indicator is currently hidden.
Returns the current visibility state of the iOS home indicator.
**Returns:** Promise<{ hidden: boolean; }>
**Since:** 0.0.1
--------------------
### getPluginVersion()
```typescript
getPluginVersion() => Promise<{ version: string; }>
```
Get the native Capacitor plugin version.
**Returns:** Promise<{ version: string; }>
**Since:** 0.0.1
--------------------
### CSS Variables
You can use `--safe-area-inset-bottom` to make sure your content is not hidden by the home indicator
This variable is injected by the plugin for android.
It's useful if you set real fullscreen mode on android.
with :
```java
getWindow().setDecorFitsSystemWindows(false);
```
# Credits
This plugin was created originally for [Kick.com](https://kick.com) by [Capgo](https://capgo.app)