当前最新版本的 Vben Admin 框架，提供了很多的 hooks 函数，以下是一些常用的hooks函数及其作用：
| Hook 名称 | 作用 |
|---|---|
| useWindowSize | 获取窗口的尺寸信息 |
| useDarkMode | 获取或修改暗黑模式状态 |
| useLocalStorage | 获取或修改本地存储的值 |
| useFullscreen | 获取或修改全屏状态 |
| useDeviceDetect | 检测用户使用的设备类型 |
| useMousePosition | 获取鼠标的位置信息 |
| useRouteMeta | 获取当前的路由元信息 |
| usePageLoading | 控制页面加载状态 |
| usePageTitle | 控制页面标题 |
| usePageLocale | 控制页面多语言 |
| usePageProps | 控制页面属性 |
| useMessage | 显示提示信息 |
| useNotification | 显示通知信息 |
| useDialog | 显示弹窗 |
| useRouter | 获取路由信息 |
| useRouteQuery | 获取路由查询参数 |
| useRouteParams | 获取路由动态参数 |
| useScrollTop | 获取或修改页面的 scrollTop 值 |
| useUpdateLayout | 强制更新布局 |
| useDebounce | 给某个函数添加防抖功能 |
| useThrottle | 给某个函数添加节流功能 |
| usePageVisibility | 检测页面是否处于可见状态 |
| 函数名(web) | 作用 |
|---|---|
| useCopyToClipboard | 使用“复制到粘贴版” |
| copyTextToClipboard | 将文本复制到粘贴版 |
| useEcharts | 封装了echarts，返回值参考下面 |
| useFullContent | 全屏 |
| useI18n | 中英文 |
| useMessage | 全局提示框，返回值参考下面 |
| usePage | 跟页面有关的，useGo 跳转 redo 刷新 |
| usePermission | 用户权限相关 |
| useScript | 使用js脚本 |
| useSortable | 排序表格 |
| useTabs | 表格相关，返回先关函数 参考下方 |
| useTitle | 动态更改网站标题，监听网站标题被更改 |
| useWatermark | 水印 |
| useEventListener | 监听事件hooks |
useEcharts
// 返回
setOptions,
resize,
echarts,
getInstance,
useMessage
//
createMessage: Message, // 普通message
notification: notification as NotifyApi, // 轻提示
createConfirm: createConfirm,
createSuccessModal, // 成功的提示窗
createErrorModal, // 失败
createInfoModal,// 消息
createWarningModal, // 警告
useTabs
refreshPage: () => handleTabAction(TableActionEnum.REFRESH),// 刷新
closeAll: () => handleTabAction(TableActionEnum.CLOSE_ALL),// 关闭全部
closeLeft: () => handleTabAction(TableActionEnum.CLOSE_LEFT),// 关闭左侧
closeRight: () => handleTabAction(TableActionEnum.CLOSE_RIGHT),// 关闭右侧
closeOther: () => handleTabAction(TableActionEnum.CLOSE_OTHER),// 关闭其他
closeCurrent: () => handleTabAction(TableActionEnum.CLOSE_CURRENT),// 关闭当前
close: (tab?: RouteLocationNormalized) => handleTabAction(TableActionEnum.CLOSE, tab),
setTitle: (title: string, tab?: RouteLocationNormalized) => updateTabTitle(title, tab),// 设置页码title
updatePath: (fullPath: string, tab?: RouteLocationNormalized) => updateTabPath(fullPath, tab),// 更新地址
| 名称（setting） | 作用 |
|---|---|
| useGlobSetting | 获取全部全局配置，智慧获取到VITE_GLOB开头的配置 |
| useHeaderStting | 获取同步配置，返回函数参考下方 |
| useMenuSetting | menu的配置 |
| useMultipleTabSetting | 标签相关配置的hooks |
| useRootSetting | 根配置相关hooks |
| useIntersectionObserver | 指定位置是否显示，和vueuse一样的hooks |
| useScroll | 滚动条相关 |
useGlobSetting：
setHeaderSetting, // 设置头部配置
getShowDoc,
getShowSearch,
getHeaderTheme,
getUseLockPage,
getShowFullScreen,
getShowNotice,
getShowBread,
getShowContent,
getShowHeaderLogo,
getShowHeader,
getFixed,
getShowMixHeaderRef,
getShowFullHeaderRef,
getShowInsetHeaderRef,
getUnFixedAndFull,
getHeaderBgColor,
| 名称（event） | 作用 |
|---|---|
| useBreakpoint | 获取当前屏幕断点 |
| useEventListener | 快速创建浏览器监听事件，可指定dom元素 |
| useIntersectionObserver | 指定位置是否显示，和vueuse一样的hooks |
| useScroll | 控制滚动条，返回滚动条位置 |
| useScrollTo | 滚动到顶部 |
| useWindowSizeFn | 监听屏幕大小变化 |
| 名称 | 作用 |
|---|---|
| useAttrs | 获取到全部属性 |
| useContext | |
| useLockFn | |
| useRefs | 讲HTMElement类型转换成ref |
