Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Cap-go/home-indicator
Hide and show home button indicator in Capacitor app
https://github.com/Cap-go/home-indicator
capacitor
Last synced: 24 days ago
JSON representation
Hide and show home button indicator in Capacitor app
- Host: GitHub
- URL: https://github.com/Cap-go/home-indicator
- Owner: Cap-go
- Created: 2023-07-04T15:42:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-08T02:00:41.000Z (8 months ago)
- Last Synced: 2024-04-13T21:17:27.977Z (8 months ago)
- Topics: capacitor
- Language: Java
- Homepage:
- Size: 286 KB
- Stars: 0
- 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
- awesome-capacitor - Home indicator - Hide and show home button indicator in Capacitor app. ([Capgo plugins](https://capgo.app/))
README
# @capgo/home-indicator
➡️ Get Instant updates for your App with Capgo 🚀
Fix your annoying bug now, Hire a Capacitor expert 💪
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 android.os.Handler;
import android.view.WindowInsets;
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
```
## Install
```bash
npm install @capgo/home-indicator
npx cap sync
```
## API
* [`hide()`](#hide)
* [`show()`](#show)
* [`isHidden()`](#ishidden)
* [`getPluginVersion()`](#getpluginversion)
### hide()
```typescript
hide() => Promise
```
Hide the home indicator.
**Since:** 0.0.1
--------------------
### show()
```typescript
show() => Promise
```
Show the home indicator.
**Since:** 0.0.1
--------------------
### isHidden()
```typescript
isHidden() => Promise<{ hidden: boolean; }>
```
Get the home indicator status.
**Returns:** Promise<{ hidden: boolean; }>
**Since:** 0.0.1
--------------------
### getPluginVersion()
```typescript
getPluginVersion() => Promise<{ version: string; }>
```
Get the native Capacitor plugin version
**Returns:** Promise<{ version: string; }>
--------------------
### 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)