Global

成员 / Members

currentY

源码:: refresher/refresher.vue , line 53

The current touch or mouse event's Y coordinate.

deltaY

源码:: refresher/refresher.vue , line 59

The distance between the start of the pull and the current touch or
mouse event's Y coordinate.

A number representing how far down the user has pulled.
The number 0 represents the user hasn't pulled down at all. The
number 1, and anything greater than 1, represents that the user
has pulled far enough down that when they let go then the refresh will
happen. If they let go and the number is less than 1, then the
refresh will not happen, and the content will return to it's original
position.

startY

源码:: refresher/refresher.vue , line 48

The Y coordinate of where the user started to the pull down the content.

state

源码:: refresher/refresher.vue , line 43

The current state which the refresher is in. The refresher's states include:

inactive - The refresher is not being pulled down or refreshing and is currently hidden.
pulling - The user is actively pulling down the refresher, but has not reached the point yet that if the user lets go, it'll refresh.
cancelling - The user pulled down the refresher and let go, but did not pull down far enough to kick off the refreshing state. After letting go, the refresher is in the cancelling state while it is closing, and will go back to the inactive state once closed.
ready - The user has pulled down the refresher far enough that if they let go, it'll begin the refreshing state.
refreshing - The refresher is actively waiting on the async operation to end. Once the refresh handler calls complete() it will begin the completing state.
completing - The refreshing state has finished and the refresher is in the process of closing itself. Once closed, the refresher will go back to the inactive state.

方法 / Methods

destroy()

源码:: textarea/textarea.vue , line 163

销毁textarea组件

destroy()

源码:: content/scroll-view.js , line 336

dismiss() → {Promise}

源码:: sheet/sheet.vue , line 150

关闭ActionSheet, 如果组件还在动画中, 则执行dismiss没有动作

返回 / Returns:

结果返回Promise, 当动画完毕后执行resolved

dismiss() → {Promise}

源码:: pop-sheet/pop-sheet.vue , line 130

关闭ActionSheet, 如果组件还在动画中, 则执行dismiss没有动作

返回 / Returns:

结果返回Promise, 当动画完毕后执行resolved

dismiss()

源码:: picker/index.js , line 119

关闭

findReorderItem()

源码:: item/item-reorder.vue , line 179

getHeight()

源码:: content/scroll-view.js , line 170

DOM READ

getLeft()

源码:: content/scroll-view.js , line 191

DOM READ

getTitle() → {String}

源码:: title/toolbar-title.vue , line 54

获取Title组件中的title

getTop()

源码:: content/scroll-view.js , line 184

DOM READ

getWidth()

源码:: content/scroll-view.js , line 177

DOM READ

hide()

源码:: footer/footer.vue , line 31

隐藏Footer

hide()

源码:: header/header.vue , line 33

隐藏Header

hideOptionButton()

源码:: navbar/navbar.vue , line 82

设置导航条右侧按钮隐藏(只是对alipay平台的), dingtalk通过url改变

indexForItem()

源码:: item/item-reorder.vue , line 172

present(options) → {Promise}

源码:: action-sheet/action-sheet.vue , line 103

开启ActionSheet组件, 当开启动画过度完毕时触发 Promise 的 resolve 。

参数 / Parameters:

Name Type Description

options

object

传入参数

Properties

Name Type Attributes Default Description

title

String

ActionSheet的标题

subTitle

string

ActionSheet的副标题

cssClass

string

自定义样式

enableBackdropDismiss

Boolean

true

允许点击backdrop关闭actionsheet

dismissOnPageChange

Boolean

true

路由切换关闭组件

buttons

Array

button数组，包含全部role

Properties

Name	Type	Description
`text`	Array	button显示文本
`icon`	Array	button显示的icon的name, 具体参考Icon组件
`role`	Array	可以是cancel(关闭)/destructive(警告/删除)/null
`handler`	Array	默认是关闭组件
`cssClass`	Array	自定义样式

present() → {Promise}

源码:: pop-sheet/pop-sheet.vue , line 119

打开ActionSheet

返回 / Returns:

结果返回Promise, 当动画完毕后执行resolved

present(options)

源码:: picker/index.js , line 104

开启

参数 / Parameters:

Name Type Description

options

object

传入参数

Properties

Name	Type	Attributes	Default	Description
`buttons`	Object			组件初始化的button数据
`columns`	Array			组件初始化的column数据
`column.name`	String			组件初始化的column数据
`columns.align`	String			组件初始化的column数据
`theme`	String	<optional>	`'ios'`	模式
`cssClass`	String	<optional>		样式
`enableBackdropDismiss`	Boolean	<optional>	`true`	点击backdrop是否能关闭
`onChange`	function	<optional>	`noop`	picker数据变化时触发, 某一个col变化也触发, 返回最新值
`onSelect`	function	<optional>	`noop`	某一列发生变化时触发

present() → {Promise}

源码:: sheet/sheet.vue , line 139

打开ActionSheet

返回 / Returns:

结果返回Promise, 当动画完毕后执行resolved

present(options)

源码:: choose-city/chose-city.js , line 5

开启ChooseCity组件

参数 / Parameters:

Name Type Description

options

Boolean

传入参数

Properties

Name Type Attributes Default Description

showLocatedCity

Boolean

false

是否显示当前定位城市，默认 false

showHotCities

Boolean

true

是否显示热门城市，默认 true

showBackdrop

Boolean

true

modal 是否显示背景色

enableBackdropDismiss

Boolean

true

modal 点击背景是否关闭

cities

Array

城市数据，默认本地数据

Properties

Name	Type	Attributes	Description
`city`	Array	<optional>	城市名称
`adCode`	Array	<optional>	城市编码
`spell`	Array	<optional>	城市拼音

hotCities

Array

热门城市，默认本地数据

Properties

Name	Type	Attributes	Description
`city`	Array	<optional>	城市名称
`adCode`	Array	<optional>	城市编码
`spell`	Array	<optional>	城市拼音

mode

String

'ios'

模式, 可以是如下取值: ios, md, fade, zoom, fade-right

isH5

Boolean

false'

是否强制使用H5模式，默认是自动的

ak

String

'8d1b...90a2'

如果是H5模式并且开启了'当前定位城市'，则使用高德地图定位，这个是AK

onDismiss

function

当选择点击后的回调，传入参数是当前选择的城市

reset()

源码:: navbar/navbar.vue , line 186

重置之前的样式设置

reset()

源码:: title/toolbar-title.vue , line 99

重置Title文字的颜色, 目前可用平台: Alipay

resize()

源码:: content/content.vue , line 219

当动态添加Header/Footer/Tabs或者修改了他的属性时, 重新计算Content组件的尺寸.

scrollBy(x, y, durationopt, doneopt) → {Promise}

源码:: content/content.vue , line 191

滚动到指定位置, 这个和scrollTo类似, 只不过是相对当前位置的滚动

当前位置为scrollTop为100px, 执行myScroll.scrollBy(0, -10), 则滚动到110px位置

参数 / Parameters:

Name	Type	Attributes	Default	Description
`x`	Number			滚动到指定位置的x值
`y`	Number			滚动到指定位置的y值
`duration`	Number	<optional>	`300`	滚动动画的时间
`done`	function	<optional>		当滚动结束时触发的回调

返回 / Returns:

当回调done未定义的时候, 才返回Promise, 如果定义则返回undefined

scrollTo(xopt, yopt, durationopt, doneopt) → {Promise}

源码:: content/content.vue , line 157

滚动到指定位置

参数 / Parameters:

Name	Type	Attributes	Default	Description
`x`	Number	<optional>	`0`	滚动到指定位置的x值
`y`	Number	<optional>	`0`	滚动到指定位置的y值
`duration`	Number	<optional>	`300`	滚动动画的时间
`done`	function	<optional>		当滚动结束时触发的回调

返回 / Returns:

当回调done未定义的时候, 才返回Promise, 如果定义则返回undefined

scrollToBottom(durationopt) → {Promise}

源码:: content/content.vue , line 180

滚动到顶部

参数 / Parameters:

Name	Type	Attributes	Default	Description
`duration`	Number	<optional>	`300`	滚动动画的时间, 默认是300ms

返回 / Returns:

当滚动动画完毕后返回promise

scrollToElement(el, durationopt, doneopt) → {Promise}

源码:: content/content.vue , line 207

滚动到指定元素

参数 / Parameters:

Name	Type	Attributes	Default	Description
`el`	Element
`duration`	Number	<optional>	`300`	滚动动画的时间
`done`	function	<optional>		当滚动结束时触发的回调

返回 / Returns:

当回调done未定义的时候, 才返回Promise, 如果定义则返回undefined

scrollToTop(durationopt) → {Promise}

源码:: content/content.vue , line 169

滚动到顶部

参数 / Parameters:

Name	Type	Attributes	Default	Description
`duration`	Number	<optional>	`300`	滚动动画的时间, 默认是300ms

返回 / Returns:

当滚动动画完毕后返回promise

setClass(className, isAddopt)

源码:: app/app.vue , line 124

设置根组件的class样式, 比如全局颜色替换或者结构变更

参数 / Parameters:

Name	Type	Attributes	Default	Description
`className`	string			样式名称
`isAdd`	boolean	<optional>	`false`	是否添加

setDisableScroll(isScrollDisabled, duration)

源码:: app/app.vue , line 104

是否点击滚动, 这个需要自己设置时间解锁

示例 / Example

this.$app && this.$app.setDisableScroll(true, 400) -> 400ms内页面不可滚动, 400ms过后可正常使用
this.$app && this.$app.setDisableScroll(false) ->立即解除锁定

参数 / Parameters:

Name	Type	Description
`isScrollDisabled`	Boolean	是否禁止滚动点击 true:禁止滚动/false:可以滚动
`duration`	number	时间过后则自动解锁

setDocTitle(_title)

源码:: app/app.vue , line 137

设置document.title的值, 如果传入的是string, 则为title的字符串, 如果是对象, 则title字段为标题名称

参数 / Parameters:

Name Type Description

_title

String | Object

设置标题

Properties

Name	Type	Description
`title`	String	标题

setEnabled(isEnabled, duration)

源码:: app/app.vue , line 72

设置当前页面是否能点击滑动, 一般使用在像ActionSheet/Alert/Modal等弹出会出现transition动画,
当transition动画进行中，页面是锁定的不能点击，因此使用该函数设定App的状态, 保证动画过程中, 用户不会操作页面

示例 / Example

this.$app && this.$app.setEnabled(false, 400) -> 400ms内页面不可点击, 400ms过后可正常使用
this.$app && this.$app.setEnabled(true) -> 64ms后解除锁定

参数 / Parameters:

Name	Type	Description
`isEnabled`	boolean	`true` for enabled, `false` for disabled
`duration`	number	isEnabled=false的过期时间当 `isEnabled` 设置为`false`, 则duration之后，`isEnabled`将自动设为`true`

setFocus()

源码:: searchbar/searchbar.vue , line 130

手动设置当前input的focus状态

setLeft()

源码:: content/scroll-view.js , line 205

DOM WRITE

setStyle(style)

源码:: header/header.vue , line 60
参考:: https://cn.vuejs.org/v2/guide/class-and-style.html#对象语法-1

设置Header的样式

参数 / Parameters:

Name	Type	Description
`style`	object	传入的样式对象

setStyle(style)

源码:: footer/footer.vue , line 58
参考:: https://cn.vuejs.org/v2/guide/class-and-style.html#对象语法-1

设置Footer的样式

参数 / Parameters:

Name	Type	Description
`style`	object	传入的样式对象

setTitle(title, changeDocTitleopt)

源码:: title/toolbar-title.vue , line 74

修改Header的title, 目前可用平台: H5/Alipay/Dingtalk

参数 / Parameters:

Name Type Attributes Default Description

title

String | Object

title

Properties

Name	Type	Description
`title`	String \| Object	title
`image`	String \| Object	image

changeDocTitle

boolean

true

是否设置doc的title, 默认是同步设置的

setTop()

源码:: content/scroll-view.js , line 198

DOM WRITE

show()

源码:: header/header.vue , line 42

显示Header

show()

源码:: footer/footer.vue , line 40

显示Footer

showOptionButton()

源码:: navbar/navbar.vue , line 74

设置导航条右侧按钮显示(只是对alipay平台的), dingtalk通过url改变

showPopMenu(dataList) → {Promise}

源码:: navbar/navbar.vue , line 90

设置右侧弹出的按钮菜单, 右侧可以没有按钮, 但是pop固定在右上角

示例 / Example

this.navbarComponent.showPopMenu([
   {
      title: '周边美食',
      icon: 'https://zos.alipayobjects.com/rmsportal/mzorSIxVEdkTuxumzzau.png',
      badge: '-1',
      handler () {
        console.log('index:0 选择了: 周边美食')
      }
    },
    {
      title: '购物攻略',
      icon: 'https://zos.alipayobjects.com/rmsportal/UoBNIZJosEXNQtAxCEUg.png',
      badge: '100',
      handler () {
        console.log('index:1 选择了: 购物攻略')
      }
    },
    {
      title: '摄影技巧',
      icon: 'https://zos.alipayobjects.com/rmsportal/QJeWMNUFFiDCQawMLPTr.png',
      badge: '12',
      handler () {
        console.log('index:2 选择了: 摄影技巧')
      }
    },
    {
      title: '搞笑段子',
      icon: 'data:image/png;base64,iVBORw0K...YII=',
      badge: '0',
      handler () {
        console.log('index:3 选择了: 搞笑段子')
      }
    }
])

参数 / Parameters:

Name Type Description

dataList

Array

menu的数据数组

Properties

Name	Type	Description
`title`	String	标题
`icon`	String	标题左边的icon(建议使用https下的图片链接, 而不是本地图片. 可以使用base64格式的图片)
`badge`	String	右上角徽章
`handler`	function	点击的处理函数

toggle()

源码:: header/header.vue , line 51

Toggle显示Header

toggle()

源码:: footer/footer.vue , line 49

Toggle显示Footer

update()

源码:: textarea/textarea.vue , line 154

更新textarea组件

类型定义 / Type Definitions

DateTimeData

源码:: datetime/datetime-util.js , line 2

属性 / Properties:

Name	Type	Description
`year`	number	year
`month`	number	month
`day`	number	day
`hour`	number	hour
`minute`	number	minute
`second`	number	second
`millisecond`	number	millisecond
`tzOffset`	number	tzOffset

DateTimeData

类型 / Type:

Object

LocaleData

源码:: datetime/datetime-util.js , line 13

属性 / Properties:

Name	Type	Description
`monthNames`	Array.<string>	monthNames
`monthShortNames`	Array.<string>	monthShortNames
`dayNames`	Array.<string>	dayNames
`dayShortNames`	Array.<string>	dayShortNames

LocaleData

类型 / Type:

Object

Global

成员 / Members

currentY

deltaY

fabLists

listsActive

mainButton

progress

startY

state

方法 / Methods

destroy()

destroy()

dismiss() → {Promise}

返回 / Returns:

dismiss() → {Promise}

返回 / Returns:

dismiss()

findReorderItem()

getHeight()

getLeft()

getTitle() → {String}

getTop()

getWidth()

hide()

hide()

hideOptionButton()

indexForItem()

present(options) → {Promise}

参数 / Parameters:

Properties

Properties

present() → {Promise}

返回 / Returns:

present(options)

参数 / Parameters:

Properties

present() → {Promise}

返回 / Returns:

present(options)

参数 / Parameters:

Properties

Properties

Properties

reset()

reset()

resize()

scrollBy(x, y, durationopt, doneopt) → {Promise}

参数 / Parameters:

返回 / Returns:

scrollTo(xopt, yopt, durationopt, doneopt) → {Promise}

参数 / Parameters:

返回 / Returns:

scrollToBottom(durationopt) → {Promise}

参数 / Parameters:

返回 / Returns:

scrollToElement(el, durationopt, doneopt) → {Promise}

参数 / Parameters:

返回 / Returns:

scrollToTop(durationopt) → {Promise}

参数 / Parameters:

返回 / Returns:

setClass(className, isAddopt)

参数 / Parameters:

setDisableScroll(isScrollDisabled, duration)

示例 / Example

参数 / Parameters:

setDocTitle(_title)

参数 / Parameters:

Properties

setEnabled(isEnabled, duration)

示例 / Example

参数 / Parameters:

setFocus()

setLeft()

setStyle(style)

参数 / Parameters:

setStyle(style)

参数 / Parameters:

setTitle(title, changeDocTitleopt)