Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • StatusbarProperties

Indexable

[key: string]: any

key for others property.

Index

Properties

Optional animated

animated: undefined | true | false

If the transition between status bar property changes should be animated. Supported for backgroundColor, barStyle and hidden. If the transition between status bar property changes should be animated. Supported for backgroundColor, barStyle and hidden.

Optional backgroundColor

backgroundColor: ColorProperties

The background color of the status bar. it is for android only The background color of the status bar. it is for android only

Optional barStyle

barStyle: "default" | "light-content" | "dark-content"

Sets the color of the status bar text. Sets the color of the status bar text.

Optional hidden

hidden: undefined | true | false

If the status bar is hidden. If the status bar is hidden.

Optional networkActivityIndicatorVisible

networkActivityIndicatorVisible: undefined | true | false

If the network activity indicator should be visible. It is for ios only If the network activity indicator should be visible. It is for ios only

setBackgroundColor

setBackgroundColor: function

Set the background color for the status bar Set the background color for the status bar

Type declaration

    • (color: string, animated?: undefined | true | false): void
    • Parameters

      • color: string
      • Optional animated: undefined | true | false

      Returns void

setBarStyle

setBarStyle: function

Set the status bar style Set the status bar style

Type declaration

    • (style: object, animated?: undefined | true | false): void
    • Parameters

      • style: object
      • Optional animated: undefined | true | false

      Returns void

setHidden

setHidden: function

Show or hide the status bar Show or hide the status bar

Type declaration

    • (hidden: boolean, animation?: undefined | object): void
    • Parameters

      • hidden: boolean
      • Optional animation: undefined | object

      Returns void

setNetworkActivityIndicatorVisible

setNetworkActivityIndicatorVisible: function

Control the visibility of the network activity indicator Control the visibility of the network activity indicator

Type declaration

    • (visible: boolean): void
    • Parameters

      • visible: boolean

      Returns void

setTranslucent

setTranslucent: function

Control the translucency of the status bar Control the translucency of the status bar

Type declaration

    • (translucent: boolean): void
    • Parameters

      • translucent: boolean

      Returns void

Optional showHideTransition

showHideTransition: "fade" | "slide"

The transition effect when showing and hiding the status bar using the hidden prop. Defaults to 'fade'. The transition effect when showing and hiding the status bar using the hidden prop. Defaults to 'fade'.

Optional translucent

translucent: undefined | true | false

If the status bar is translucent. When translucent is set to true, the app will draw under the status bar. This is useful when using a semi transparent status bar color. It is for android only If the status bar is translucent. When translucent is set to true, the app will draw under the status bar. This is useful when using a semi transparent status bar color. It is for android only

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc