capacitor-plugin-status-bar 2.0.0

package/CapacitorPluginStatusBar.podspec

@@ -0,0 +1,17 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapacitorPluginStatusBar'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['repository']['url']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target = '15.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.9'
+end

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Abdelfatah Ashour
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/Package.swift

@@ -0,0 +1,28 @@
+// swift-tools-version: 5.9
+import PackageDescription
+
+let package = Package(
+    name: "CapacitorPluginStatusBar",
+    platforms: [.iOS(.v15)],
+    products: [
+        .library(
+            name: "CapacitorPluginStatusBar",
+            targets: ["StatusBarPlugin"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "8.0.0")
+    ],
+    targets: [
+        .target(
+            name: "StatusBarPlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm")
+            ],
+            path: "ios/Sources/StatusBarPlugin"),
+        .testTarget(
+            name: "StatusBarPluginTests",
+            dependencies: ["StatusBarPlugin"],
+            path: "ios/Tests/StatusBarPluginTests")
+    ]
+)

package/README.md

@@ -0,0 +1,221 @@
+# capacitor-plugin-status-bar
+
+Capacitor status bar
+
+## Install
+
+```bash
+npm install capacitor-plugin-status-bar
+npx cap sync
+```
+
+## Configuration
+
+### iOS
+
+For the `show()` and `hide()` methods to work on iOS, you need to configure your app's `Info.plist`:
+
+1. Open `ios/App/App/Info.plist`
+2. Add or modify the following key:
+
+```xml
+<key>UIViewControllerBasedStatusBarAppearance</key>
+<false/>
+```
+
+**Note:** Starting with iOS 13, Apple deprecated the application-level status bar control API in favor of view controller-based appearance. Setting `UIViewControllerBasedStatusBarAppearance` to `false` allows this plugin to control the status bar programmatically. This is the recommended approach for Capacitor plugins.
+
+### Android
+
+No additional configuration required. The plugin works out of the box on Android.
+
+## API
+
+<docgen-index>
+
+* [`setStyle(...)`](#setstyle)
+* [`show(...)`](#show)
+* [`hide(...)`](#hide)
+* [`setOverlaysWebView(...)`](#setoverlayswebview)
+* [`setBackground(...)`](#setbackground)
+* [`getSafeAreaInsets()`](#getsafeareainsets)
+* [Type Aliases](#type-aliases)
+* [Enums](#enums)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### setStyle(...)
+
+```typescript
+setStyle(options: StatusBarOptions) => Promise<void>
+```
+
+Set the status bar and navigation bar style and color.
+
+| Param         | Type                                                                    | Description                                          |
+| ------------- | ----------------------------------------------------------------------- | ---------------------------------------------------- |
+| **`options`** | <code><a href="#statusbarstyleoptions">StatusBarStyleOptions</a></code> | - The options to set the status bar style and color. |
+
+--------------------
+
+
+### show(...)
+
+```typescript
+show(options: StatusBarShowOptions) => Promise<void>
+```
+
+Show the status bar.
+
+| Param         | Type                                                                  | Description                           |
+| ------------- | --------------------------------------------------------------------- | ------------------------------------- |
+| **`options`** | <code><a href="#statusbarshowoptions">StatusBarShowOptions</a></code> | - The options to show the status bar. |
+
+--------------------
+
+
+### hide(...)
+
+```typescript
+hide(options: StatusBarHideOptions) => Promise<void>
+```
+
+Hide the status bar.
+
+| Param         | Type                                                                  | Description                           |
+| ------------- | --------------------------------------------------------------------- | ------------------------------------- |
+| **`options`** | <code><a href="#statusbarhideoptions">StatusBarHideOptions</a></code> | - The options to hide the status bar. |
+
+--------------------
+
+
+### setOverlaysWebView(...)
+
+```typescript
+setOverlaysWebView(options: StatusBarSetOverlaysWebViewOptions) => Promise<void>
+```
+
+Set whether the status bar overlays the web view.
+
+**iOS only** - On Android this is a no-op (resolves without error).
+
+- `true`: Web content extends behind the status bar (transparent background),
+  allowing content to be visible through the status bar area on scroll.
+- `false`: Restores the status bar background to the color set by `setStyle`
+  or falls back to the default style from Capacitor config.
+
+| Param         | Type                                                                                              | Description                                            |
+| ------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
+| **`options`** | <code><a href="#statusbarsetoverlayswebviewoptions">StatusBarSetOverlaysWebViewOptions</a></code> | - The options to set the status bar overlays web view. |
+
+--------------------
+
+
+### setBackground(...)
+
+```typescript
+setBackground(options: StatusBarSetBackgroundOptions) => Promise<void>
+```
+
+Set the window background color.
+
+| Param         | Type                                                                                    | Description                                       |
+| ------------- | --------------------------------------------------------------------------------------- | ------------------------------------------------- |
+| **`options`** | <code><a href="#statusbarsetbackgroundoptions">StatusBarSetBackgroundOptions</a></code> | - The options to set the window background color. |
+
+--------------------
+
+
+### getSafeAreaInsets()
+
+```typescript
+getSafeAreaInsets() => Promise<SafeAreaInsets>
+```
+
+Get the safe area insets.
+Returns the insets for status bar, navigation bar, and notch areas.
+Values are in pixels on Android and points on iOS.
+
+**Returns:** <code>Promise&lt;<a href="#safeareainsets">SafeAreaInsets</a>&gt;</code>
+
+--------------------
+
+
+### Type Aliases
+
+
+#### StatusBarOptions
+
+<code><a href="#statusbarstyleoptions">StatusBarStyleOptions</a></code>
+
+
+#### StatusBarStyleOptions
+
+<code><a href="#statusbarstylenodefaultoptions">StatusBarStyleNoDefaultOptions</a> | { style: <a href="#style">Style.CUSTOM</a>; color: <a href="#statusbarcolor">StatusBarColor</a>; }</code>
+
+
+#### StatusBarStyleNoDefaultOptions
+
+<code>{ style: <a href="#style">Style</a>; }</code>
+
+
+#### StatusBarColor
+
+Full HEX color format only (6 or 8 digits).
+- 6 digits: #RRGGBB (e.g., #FFFFFF, #000000, #FF5733)
+- 8 digits: #RRGGBBAA with alpha channel (e.g., #FFFFFF00, #FF5733CC)
+
+Note: Short 3-digit format (#FFF) is NOT supported.
+
+<code>`#${string}`</code>
+
+
+#### StatusBarShowOptions
+
+<code>{ animated: boolean; }</code>
+
+
+#### StatusBarHideOptions
+
+<code>{ /** * The animation type for hiding the status bar. * - 'fade': Makes the background transparent without removing the status bar and navigation bar. * - 'slide': Hides the status bar and navigation bar completely (default behavior). */ animation: <a href="#statusbaranimation">StatusBarAnimation</a>; }</code>
+
+
+#### StatusBarSetOverlaysWebViewOptions
+
+<code>{ value: boolean; }</code>
+
+
+#### StatusBarSetBackgroundOptions
+
+<code>{ color: <a href="#statusbarcolor">StatusBarColor</a>; }</code>
+
+
+#### SafeAreaInsets
+
+<code>{ top: number; bottom: number; left: number; right: number; }</code>
+
+
+### Enums
+
+
+#### Style
+
+| Members      | Value                 |
+| ------------ | --------------------- |
+| **`LIGHT`**  | <code>'LIGHT'</code>  |
+| **`DARK`**   | <code>'DARK'</code>   |
+| **`CUSTOM`** | <code>'CUSTOM'</code> |
+
+
+#### StatusBarAnimation
+
+| Members     | Value                |
+| ----------- | -------------------- |
+| **`NONE`**  | <code>'none'</code>  |
+| **`FADE`**  | <code>'fade'</code>  |
+| **`SLIDE`** | <code>'slide'</code> |
+
+</docgen-api>

package/android/build.gradle

@@ -0,0 +1,58 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.1'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.3.0'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.7.0'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.13.0'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace "com.cap.plugins.statusbar"
+    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 36
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 24
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 36
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_21
+        targetCompatibility JavaVersion.VERSION_21
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+</manifest>