1.0.3 • Published 4 years ago

@uni/navigation-bar v1.0.3

Weekly downloads
-
License
BSD-3-Clause
Repository
github
Last release
4 years ago

setNavigationBarTitle

npm

Dynamically set the title of the current page。

Supported

Install

$ npm install @uni/navigation-bar --save

or

$ npm install @uni/apis --save

Usage

import { setNavigationBarTitle } from '@uni/navigation-bar';

setNavigationBarTitle({
  title: 'title',
});

You can also import from the big package:

import { navigationBar } from '@uni/apis';

navigationBar.setNavigationBarTitle({
  title: 'title',
});

Methods

setNavigationBarTitle(options)

Arguments

PropertyTypeDescriptionrequiredDefaultSupported
optionsobject ✔️--
options.titlestring title of the current page✔️-
options.successFunction The callback function for a successful API call-
options.failFunction The callback function for a failed API call-
options.completeFunction The callback function used when the API call completed (always executed whether the call succeeds or fails)-

setNavigationBarColor

npm

Set the color of the page navigation bar。

Supported

Note: web does not support setNavigationBarColor

Install

$ npm install @uni/navigation-bar --save

or

$ npm install @uni/apis --save

Usage

import { setNavigationBarTitle } from '@uni/navigation-bar';

setNavigationBarColor({
  backgroundColor: '#ff0000',
});

You can also import from the big package:

import { navigationBar } from '@uni/apis';

navigationBar.setNavigationBarColor({
  backgroundColor: '#ff0000',
});

Methods

setNavigationBarColor(options)

Arguments

PropertyTypeDescriptionrequiredDefaultSupported
optionsobject ✔️--
options.backgroundColorstring Background color value, valid value is hexadecimal color✔️-
options.frontColorstring Foreground color value, including button, title, status bar color, only supports #ffffff and #000000-
options.successFunction The callback function for a successful API call-
options.failFunction The callback function for a failed API call-
options.completeFunction The callback function used when the API call completed (always executed whether the call succeeds or fails)-

getMenuButtonBoundingClientRect

npm

Get the layout position information of the menu button (capsule button in the upper right corner). The coordinate information takes the upper left corner of the screen as the origin.

Support

Install

$ npm install @uni/navigation-bar --save

or

$ npm install @uni/apis --save

Usage

import { getMenuButtonBoundingClientRect } from '@uni/navigation-bar';

getMenuButtonBoundingClientRect();

你也可以从大包引入:

import { navigationBar } from '@uni/apis';

navigationBar.getMenuButtonBoundingClientRect();

Method

getMenuButtonBoundingClientRect()

Response

属性类型描述支持
widthnumber 宽度,单位:px-
heightnumber 高度,单位:px
topnumber 上边界坐标,单位:px
rightnumber 右边界坐标,单位:px
bottomnumber 下边界坐标,单位:px
leftnumber 左边界坐标,单位:px

不通用返回(由于破坏了一码多端的能力,不推荐使用)

属性类型描述支持
errMsgstring