1.0.0 • Published 1 year ago

@awesome-cordova-library/navigationbar v1.0.0

Weekly downloads
-
License
SEE LICENSE IN LI...
Repository
github
Last release
1 year ago

@awesome-cordova-library/navigationbar

Hide and auto hide navigation bar.

Github

Installation

cordova plugin add cordova-plugin-navigationbar
(when build error, use github url: cordova plugin add https://github.com/cranberrygame/cordova-plugin-navigationbar)
npm i @awesome-cordova-library/navigationbar

Vanilla

Declaration

class NavigationBar {
  /**
   *
   * @param autoHideNavigationBar {boolean}
   * @param successCallback {Function}
   * @param errorCallback {Function}
   */
  static setUp(autoHideNavigationBar: boolean, successCallback: () => void, errorCallback: () => void): void;
  /**
   *
   * @param successCallback {Function}
   * @param errorCallback {Function}
   */
  static hideNavigationBar(successCallback: () => void, errorCallback: () => void): void;
}

Usages

import NavigationBar from '@awesome-cordova-library/navigationbar';

document.addEventListener(
  'deviceready',
  function () {
    var autoHideNavigationBar = false;
    NavigationBar.setUp(autoHideNavigationBar);
  },
  false,
);

NavigationBar.hide();

React

Declaration

const useNavigationBar: () => {
  setUp: (autoHideNavigationBar: boolean) => Promise<void>;
  hideNavigationBar: () => Promise<void>;
};

Usages

import { useEffect } from 'react';
import useNavigationBar from '@awesome-cordova-library/navigationbar/lib/react';

function App() {
  const { setUp, hideNavigationBar } = useNavigationBar();
  useEffect(() => {
    setUp(true);
  }, []);

  return <div />;
}