@nativescript-community/systemui
    Preparing search index...

    @nativescript-community/systemui

    NativeScript System UI

    A NativeScript plugin to change System UI.

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

    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 See typings for properties types. (they are added to Page type)

    • statusBarColor (css property status-bar-color)
    • statusBarStyle (css property status-bar-style)
    • statusBarHidden (css property status-bar-hidden)
    • navigationBarColor (css property navigation-bar-color)
    • navigationBarStyleANDROID (css property navigation-bar-style)
    • windowBgColorIOS (css property window-bg-color)
    • keepScreenAwake (css property keep-screen-awake)
    • screenOrientation (css property screen-orientation)
    • screenBrightness (css property screen-brightness)

    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

    The repo uses submodules. If you did not clone with --recursive then you need to call

    git submodule update --init

    The package manager used to install and link dependencies must be pnpm or yarn. npm wont work.

    To develop and test: if you use yarn then run yarn if you use pnpm then run pnpm i

    Interactive Menu:

    To start the interactive menu, run npm start (or yarn start or pnpm start). This will list all of the commonly used scripts.

    npm run build.all

    WARNING: it seems yarn build.all wont always work (not finding binaries in node_modules/.bin) which is why the doc explicitly uses npm run

    npm run demo.[ng|react|svelte|vue].[ios|android]

    npm run demo.svelte.ios # Example

    Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in demo-[ng|react|svelte|vue] Instead you work in demo-snippets/[ng|react|svelte|vue] You can start from the install.ts of each flavor to see how to register new demos

    You can update the repo files quite easily

    First update the submodules

    npm run update

    Then commit the changes Then update common files

    npm run sync

    Then you can run yarn|pnpm, commit changed files if any

    npm run readme

    npm run doc

    The publishing is completely handled by lerna (you can add -- --bump major to force a major release) Simply run

    npm run publish

    The repo uses https:// for submodules which means you won't be able to push directly into the submodules. One easy solution is t modify ~/.gitconfig and add

    [url "ssh://git@github.com/"]
    	pushInsteadOf = https://github.com/

    If you have any questions/issues/comments please feel free to create an issue or start a conversation in the NativeScript Community Discord.

    Settings

    Member Visibility

    On This Page

    NativeScript System UI