@geekyhawks/react-native-ui-components
Version:
A lightweight and reusable React Native UI components library with customizable Text, TextInput, FloatingLabelTextInput, Button, and more. Built with TypeScript, fully typed, and designed for easy integration into any React Native project.
45 lines • 1.82 kB
TypeScript
/**
* StatusBar
*
* A customizable wrapper around React Native's `StatusBar`.
* Supports theme-based variants (`default`, `transparent`, `light`, `dark`)
* and allows overriding background color, bar style, and translucency.
* Optionally renders an app bar spacer for consistent layout across platforms.
*
* Author: Geeky Hawks FZE LLC
*/
import React from "react";
import { DefaultStatusBarVariants } from "../../theme";
/**
* Props for custom StatusBar component
*
* - **backgroundColor**: override theme or variant background color
* - **barStyle**: override bar style (`default`, `light-content`, `dark-content`)
* - **hideAppBar**: hide the app bar spacer (default: false)
* - **translucent**: control translucency (default taken from variant or true)
* - **variant**: choose from default variants (`default` | `transparent` | `light` | `dark`)
* or a custom variant defined in ThemeProvider
*/
export interface Props {
/** Background color (theme token or direct value) */
backgroundColor?: string;
/** Status bar style */
barStyle?: "default" | "light-content" | "dark-content";
/** Hide the app bar spacer below the status bar */
hideAppBar?: boolean;
/** Enable translucent status bar */
translucent?: boolean;
/** Variant key from theme or custom */
variant?: DefaultStatusBarVariants | (string & {});
}
/**
* StatusBar
*
* A customizable wrapper around React Native's `StatusBar`.
* - Applies theme-based variants for background color, bar style, and translucency.
* - Optionally renders an app bar spacer for consistent layout below the status bar.
* - Supports overriding all props (backgroundColor, barStyle, translucent) manually.
*/
declare const StatusBar: React.FC<Props>;
export default StatusBar;
//# sourceMappingURL=StatusBar.d.ts.map