Fantastic-admin 文档 (v3)

Appearance

常用 API ​

接口请求 ​

详细可阅读《与服务端交互 - 接口请求》。

ts
import api from '@/api'

api.get()
api.post()
import api from '@/api'

api.get()
api.post()

鉴权 ​

详细可阅读《权限 - 鉴权函数》。

ts
const { auth, authAll } = useAuth()

auth()
authAll()
const { auth, authAll } = useAuth()

auth()
authAll()

主导航 ​

切换 ​

切换主导航，index 为主导航序列数。

ts
const { switchTo } = useMenu()

switchTo(index)
const { switchTo } = useMenu()

switchTo(index)

主页面 ​

刷新 ​

ts
const { reload } = useMainPage()

reload()
const { reload } = useMainPage()

reload()

设置自定义标题 ​

ts
const { setCustomTitle } = useMainPage()

setCustomTitle(title)
const { setCustomTitle } = useMainPage()

setCustomTitle(title)

重置自定义标题 ​

ts
const { resetCustomTitle } = useMainPage()

resetCustomTitle()
const { resetCustomTitle } = useMainPage()

resetCustomTitle()

最大化 ​

ts
const { maximize } = useMainPage()

// status: true / false
maximize(status)
const { maximize } = useMainPage()

// status: true / false
maximize(status)

标签栏 ​

获取当前标签页 tabId ​

ts
const { getId } = useTabbar()

getId()
const { getId } = useTabbar()

getId()

打开新标签页 ​

该方法接收一个 to 参数，该参数与 router.push(to) 一致，点击阅读参数说明。

通过该方式跳转页面，新增的标签页会插入到当前标签页后面，而直接通过路由跳转，新增的标签页会插入到所有标签页的最后。

ts
const { open } = useTabbar()

open(to)
const { open } = useTabbar()

open(to)

后退标签页 ​

该方法接收一个 delta 参数，该参数与 router.go(delta) 一致，点击阅读参数说明。

通过该方式后退页面，可以同时关闭当前标签页，而直接通过路由后退，当前标签页会被保留。

ts
const { go } = useTabbar()

go(delta)
const { go } = useTabbar()

go(delta)

关闭当前标签页 ​

该方法接收一个 to 参数，该参数与 router.push(to) 一致，点击阅读参数说明。

通过该方式跳转页面，可以同时关闭当前标签页，而直接通过路由跳转，当前标签页会被保留。

ts
const { close } = useTabbar()

close(to)
const { close } = useTabbar()

close(to)

关闭指定标签页 ​

该方法接收一个 tabId 参数，如果不传则默认为当前页的 tabId 。

ts
const { closeById } = useTabbar()

closeById(tabId)
const { closeById } = useTabbar()

closeById(tabId)

关闭两侧标签页 ​

该方法接收一个 tabId 参数，如果不传则默认为当前页的 tabId 。

ts
const { closeOtherSide } = useTabbar()

closeOtherSide(tabId)
const { closeOtherSide } = useTabbar()

closeOtherSide(tabId)

关闭左侧标签页 ​

该方法接收一个 tabId 参数，如果不传则默认为当前页的 tabId 。

ts
const { closeLeftSide } = useTabbar()

closeLeftSide(tabId)
const { closeLeftSide } = useTabbar()

closeLeftSide(tabId)

关闭右侧标签页 ​

该方法接收一个 tabId 参数，如果不传则默认为当前页的 tabId 。

ts
const { closeRightSide } = useTabbar()

closeRightSide(tabId)
const { closeRightSide } = useTabbar()

closeRightSide(tabId)

校验指定标签两侧是否有可关闭的标签 ​

该方法接收一个 tabId 参数，如果不传则默认为当前页的 tabId 。

ts
const { checkCloseOtherSide } = useTabbar()

checkCloseOtherSide(tabId)
const { checkCloseOtherSide } = useTabbar()

checkCloseOtherSide(tabId)

校验指定标签左侧是否有可关闭的标签 ​

该方法接收一个 tabId 参数，如果不传则默认为当前页的 tabId 。

ts
const { checkCloseLeftSide } = useTabbar()

checkCloseLeftSide(tabId)
const { checkCloseLeftSide } = useTabbar()

checkCloseLeftSide(tabId)

校验指定标签右侧是否有可关闭的标签 ​

该方法接收一个 tabId 参数，如果不传则默认为当前页的 tabId 。

ts
const { checkCloseRightSide } = useTabbar()

checkCloseRightSide(tabId)
const { checkCloseRightSide } = useTabbar()

checkCloseRightSide(tabId)

事件总线 ​

基于 mitt 简单封装，使用方法请查阅官方文档。

ts
import eventBus from '@/utils/eventBus'

eventBus.on()
eventBus.emit()
eventBus.off()
import eventBus from '@/utils/eventBus'

eventBus.on()
eventBus.emit()
eventBus.off()

日期 ​

基于 dayjs 简单封装，使用方法请查阅官方文档。

ts
import dayjs from '@/utils/dayjs'

dayjs()
import dayjs from '@/utils/dayjs'

dayjs()

Copyright © 2020-present Fantastic-admin