npm

Need private packages and team management tools?Check out npm Orgs. »

nativescript-systemui

1.0.0 • Public • Published

NativeScript System UI

A NativeScript plugin to change System UI.

IOS

To show/hide the statusBar you need to have UIViewControllerBasedStatusBarAppearance set to false in your Info.plist

Usage

npm install nativescript-systemui --save

If you are using version ^1.0.0 then we now use mixins

import { installMixins } from 'nativescript-systemui';
installMixins();

Then new properties are added to the Page class

  • statusBarColor (css property status-bar-color)
  • navigationBarColor (css property navigation-bar-color)

For versions < 1.0.0

Then in your NativeScript project .xml file, add the namespace for the plugin. I'm calling it "x" here, but you can name it anything you want.

iOS only supports a list of settings (default, light, dark, opaque), not a specific color. Android will support any hex background color, but you cannot change the text color on the status bar.

<Page xmlns="http://schemas.nativescript.org/tns.xsd"
      xmlns:x="nativescript-systemui"> 
      
      <!-- Use the tag with StatusBar to style it 
           Available ios settings:
           default 
           light 
           dark
           opaque
      -->
      <x:StatusBar ios:barStyle="light" barColor="#00A7DC" />
      <x:NavigationBar barColor="#00A7DC" />
</Page>

Those settings, combined with an ActionBar that has background-color: #00C0F5 will give you...

status-bar-light

Note The SystemUI plugin will not set the color of the StatusBar on iOS if you don't have an ActionBar as well. If you want to set the color of the StatusBar in NativeScript without having an ActionBar, you can set it to the page background color by setting backgroundSpanUnderStatusBar="true". Otherwise you will have a white StatusBar no matter what you do.

With Vue.js

In your root app.js:

import StatusBarPlugin from 'nativescript-systemui/vue';
Vue.use(StatusBarPlugin);

In your component:

<Page class="page" actionBarHidden="true" backgroundSpanUnderStatusBar="true">
      <StatusBar barColor="#32475b" />
      <NavigationBar barColor="#32475b" />
<Page/>

That's is.

Development workflow

If you would like to contribute to this plugin in order to enabled the repositories code for development follow this steps:

  • Fork the repository locally
  • Open the repository in your favorite terminal
  • Navigate to the src code that contains the plugin's code cd /src
  • Execute the npm script nmp run build.wrappers or npm run build.wrappers.watch
  • When running the Vanila NativeScript demo app execute: npm run demo.android or npm run demo.ios
  • When running the Angular NativeScript demo app execute: npm run demo.angular.android or npm run demo.angular.ios

install

npm i nativescript-systemui

Downloadsweekly downloads

86

version

1.0.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability