@nativescript-community/systemui
v1.1.23
Published
Provides API for changing the styles of SystemUI (StatusBar, NavigationBar...) on iOS.
Downloads
291
Readme
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-community/systemui --save
If you are using version ^1.0.0 then we now use mixins
import { installMixins } from '@nativescript-community/systemui';
installMixins();
Then new properties are added to the Page
class
statusBarColor
(css propertystatus-bar-color
)navigationBarColor
(css propertynavigation-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-community/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...
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-community/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
ornpm run build.wrappers.watch
- When running the Vanila NativeScript demo app execute:
npm run demo.android
ornpm run demo.ios
- When running the Angular NativeScript demo app execute:
npm run demo.angular.android
ornpm run demo.angular.ios