Plugin Options

Mr.Hope ... 2022-6-1 Less than 1 minute

# backToTop

Type: boolean | number
Default: false

Whether enabling backToTop button. When setting a number, it will be used as BackToTop button threshold distance (in pixels), default is 300.

Type: boolean
Default: false

Whether register breadcrumb component

# badge

Type: boolean
Default: false

Whether register badge component

# pageinfo

Type: boolean
Default: false

Whether register pageinfo component

# pagination

Type: boolean
Default: false

Whether register pagination component

# wordPerminute

Type: number
Default: 300

Reading words per minute.

# screenFull

Type: boolean
Default: false

Whether register scrennfull button component

# locales

interface ComponentLocaleData {
  /**
   * Back to top button label text
   */
  backToTop: string;

  /**
   * Open in new window text
   */
  openInNewWindow: string;
}

1
2
3
4
5
6
7
8
9
10
11

Component locales config.

# pageInfoLocales

interface PageInfoLocaleData {
  /**
   * Author label text
   */
  author: string;

  /**
   * Writing date label text
   */
  date: string;

  /**
   * Label text marked as original
   */
  origin: string;

  /**
   * Page views label text
   */
  views: string;

  /**
   * Tag label text
   */
  tag: string;

  /**
   * Category label text
   */
  category: string;

  /**
   * Expect reading time label text
   */
  readingTime: string;

  /**
   * Words label Text
   */
  words: string;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

Locales Config for page information.

# paginationLocales

interface PaginationLocaleData {
  /**
   * Previous page button label text
   */
  prev: string;

  /**
   * Next page button label text
   */
  next: string;

  /**
   * Navigation hint label text
   */
  navigate: string;

  /**
   * Navigation button label text
   */
  button: string;

  /**
   * Error text when invalid page number, `$page` will be replaced by total page number automatically
   */
  errorText: string;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

Pagination locales config.

Page information