Miss any of our Open RFC calls?Watch the recordings here! »

@mr-hope/vuepress-plugin-components

0.7.0 • Public • Published

@mr-hope/vuepress-plugin-components

Version Downloads Size

Components for vuepress-theme-hope.

Usage

npm i @mr-hope/vuepress-plugin-components

This plugin expose 4 components and 1 global component:

  • BackToTop (Global Components)
  • BreadCrumb
  • MyBadge
  • Pagination
  • ScreenFull

BackToTop

Back-to-top Button

BreadCrumb

Will read these options from themeConfig:

  • breadcrumbIcon: Wether to display icon (default is true)
  • breacurmb: Wether to use path navigator
  • iconPrefix: Icon-font prefix, default is icon-. Set false or '' to cancel auto-prefix。

MyBadge

A badge which allows you to diy it's color.

Pagination

Paging component.

Props

  • currentPage: v-model variable, current page.
  • total: total number of items
  • perPage: number of items per page, default is 10

ScreenFull

A full-screen button


vuepress-theme-hope 的组件。

使用

npm i @mr-hope/vuepress-plugin-components

此插件提供 4 个组件和一个全局组件:

  • BackToTop (全局组件)
  • BreadCrumb
  • MyBadge
  • Pagination
  • ScreenFull

BackToTop

返回顶部按钮

BreadCrumb

会读取主题配置中的以下字段

  • breadcrumbIcon: 是否显示图标(默认显示)
  • breacurmb: 是否启用路径导航
  • iconPrefix: 图标前缀,默认为 icon-,设置 false'' 取消前缀,也可设置其他值。

MyBadge

支持自定义颜色的徽章

Pagination

分页组件。

Props

  • currentPage: V-model 双向绑定,当前为第几个页面。
  • total: 总项数
  • perPage: 每页包含的项目数,默认为 10

ScreenFull

全屏按钮组件

Install

npm i @mr-hope/vuepress-plugin-components

DownloadsWeekly Downloads

375

Version

0.7.0

License

MIT

Unpacked Size

29.4 kB

Total Files

22

Last publish

Collaborators

  • avatar