Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aashu-dubey/capacitor-statusbar-safe-area

Capacitor Package to get Status bar height and Safe area insets on Android & iOS.
https://github.com/aashu-dubey/capacitor-statusbar-safe-area

android capacitor capacitor-plugin cross-platform ionic ios library npm-package package plugin safearea statusbar typescript

Last synced: 4 days ago
JSON representation

Capacitor Package to get Status bar height and Safe area insets on Android & iOS.

Host: GitHub
URL: https://github.com/aashu-dubey/capacitor-statusbar-safe-area
Owner: Aashu-Dubey
License: mit
Created: 2022-03-19T11:58:31.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-06-02T19:27:20.000Z (9 months ago)
Last Synced: 2025-02-16T11:55:50.696Z (4 days ago)
Topics: android, capacitor, capacitor-plugin, cross-platform, ionic, ios, library, npm-package, package, plugin, safearea, statusbar, typescript
Language: Java
Homepage: https://npmjs.com/package/@aashu-dubey/capacitor-statusbar-safe-area
Size: 739 KB
Stars: 38
Watchers: 2
Forks: 11
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


# capacitor-statusbar-safe-area

Get Status bar height and Safe area insets on Android & iOS.

[![npm](https://img.shields.io/npm/v/@aashu-dubey/capacitor-statusbar-safe-area?style=flat-square)](https://www.npmjs.com/package/@aashu-dubey/capacitor-statusbar-safe-area) [![npm](https://img.shields.io/npm/dm/@aashu-dubey/capacitor-statusbar-safe-area?style=flat-square)](https://www.npmjs.com/package/@aashu-dubey/capacitor-statusbar-safe-area) [![Install Size](https://packagephobia.now.sh/badge?p=@aashu-dubey/capacitor-statusbar-safe-area)](https://www.npmjs.com/package/@aashu-dubey/capacitor-statusbar-safe-area)



## Install

```bash

npm install @aashu-dubey/capacitor-statusbar-safe-area

npx cap sync

```

## Usage

```typescript

import { SafeArea } from '@aashu-dubey/capacitor-statusbar-safe-area';

const getStatusBarHeight = async () => {

  const { height } = await SafeArea.getStatusBarHeight();

  return height; // Ex. 29.090909957885742

};

const getSafeAreaInsets = async () => {

  const insets = await SafeArea.getSafeAreaInsets();

  return insets; // Ex. { "bottom":34, "top":47, "right":0, "left":0 }

};

```

### CSS Variables

Package also exposes CSS variables, for that you need to call `injectCSSVariables` method in your `platform.ready()` function or whenever app System UI visibility is changed

```typescript

import { SafeAreaController } from '@aashu-dubey/capacitor-statusbar-safe-area';

const injectSafeAreaVariables = () => {

  SafeAreaController.injectCSSVariables();

};

```

then you can use them in your CSS files

```scss

.myContainer {

  // '--status-bar-height' & '--safe-area-inset-top' would most probably be same

  margin-top: var(--status-bar-height);

}

.myElement {

  padding-top: var(--safe-area-inset-top);

  padding-left: var(--safe-area-inset-left);

  padding-right: var(--safe-area-inset-right);

  padding-bottom: var(--safe-area-inset-bottom);

}

```

### HTML Tag

Other than the above options, you can also use `safe-area` web component exported by the plugin.

#### Angular

For Angular users, you will get an error warning that this web component is unknown to the Angular compiler. This is resolved by modifying the module that declares your component to allow for custom web components.

```ts

// your-component.module.ts

import { CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';

@NgModule({

  schemas: [CUSTOM_ELEMENTS_SCHEMA]

})

```

You also have to register the custom element before using the tag

```ts

// app.component.ts or your-component.ts

import { registerSafeAreaElement } '@aashu-dubey/capacitor-statusbar-safe-area';

registerSafeAreaElement();

```

then just wrap the part you want to apply safe area padding on with `safe-area` tag as below

```html

  

```

#### Others

You will have to import the plugin in your component in order to make the web component work.

React

```jsx

import { registerSafeAreaElement } '@aashu-dubey/capacitor-statusbar-safe-area';

registerSafeAreaElement();

const MyComponent = () => {

  return (

    

      // Other content

    

  );

}

```

Vue

```html

  

    

  

import { registerSafeAreaElement } '@aashu-dubey/capacitor-statusbar-safe-area';

registerSafeAreaElement();

```

#### Attributes

There are two attributes, that can be used with the `safe-area` web component to control it's behaviour, `mode` & `edges`.

```html

```

more details [here](#safeareahtmlprops).

### With SSR

The plugin and it's functionalities are client specific and might throw error when used on the server side like [#10](https://github.com/Aashu-Dubey/capacitor-statusbar-safe-area/issues/10) and [#11](https://github.com/Aashu-Dubey/capacitor-statusbar-safe-area/issues/11), so always make sure to access the plugin on the client side.

Here are some example for a possible solution to use the plugin in:

- [NuxtJs (Vue)](https://github.com/Aashu-Dubey/capacitor-statusbar-safe-area/issues/10#issuecomment-1685089169)

- [NextJS (React)](https://github.com/Aashu-Dubey/capacitor-statusbar-safe-area/issues/11#issuecomment-1697267497)

## Capacitor version support

| capacitor | plugin version       |

| --------- | -------------------- |

| v6.x      | 3.0.0                |

| v5.x      | 2.1.0                |

| v4.x      | >= 1.1.0 && <= 2.0.0 |

| v3.x      | <= 1.0.1             |

## API

* [`getStatusBarHeight()`](#getstatusbarheight)

* [`getSafeAreaInsets()`](#getsafeareainsets)

* [Interfaces](#interfaces)

### getStatusBarHeight()

```typescript

getStatusBarHeight() => Promise<{ height: number; }>

```

Get the Status bar height on Android and iOS, and on Web it returns 0.

**Returns:** Promise<{ height: number; }>

--------------------

### getSafeAreaInsets()

```typescript

getSafeAreaInsets() => Promise

```

Get the Safe area insets for Android and iOS, and on Web it returns 0 for all.

**Returns:** Promise<SafeAreaInset>

--------------------

### Interfaces

#### SafeAreaInset

| Prop         | Type                | Description                      |

| ------------ | ------------------- | -------------------------------- |

| **`top`**    | number | Safe Area inset value at top.    |

| **`bottom`** | number | Safe Area inset value at bottom. |

| **`left`**   | number | Safe Area inset value at left.   |

| **`right`**  | number | Safe Area inset value at right.  |

#### SafeAreaHTMLProps

| Prop        | Type                               | Description                                                                                                                                                              |

| ----------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

| **`mode`**   | 'padding' \| 'margin' | Whether to apply safe area insets as `padding` or `margin`. default `padding`.                                                                                                          |

| **`edges`**  | string                | Specify the edges you want to apply safe area padding on, separated by comma.

For example, to apply padding only on top, left and right, `edges="top,left,right"`. default to all edges. |