Back to Top Module
On this page
AKA return to top, a button to back to top.
| Module | github.com/hbstack/back-to-top |
|---|---|
| Repository | ⭐ Please consider giving a star if your like it. |
| Stars |  |
| Version |  |
| Used by |  |
| Requirements |  |
| License |  |
| Usage | See how to use modules. |
Site Parameters
| Name | Type | Require | Default | Description |
|---|---|---|---|---|
animation | boolean | - | true | Disable the default animation if false. |
icon_height | string | - | 2em | The height of icon. |
icon_name | number | - | rocket | The name of Bootstrap icon. |
icon_width | number | - | 2em | The width of icon. |
position_bottom | number | - | 1rem | The bottom property of the button. |
position_end | number | - | 1rem | The right (LTR) or left (RTL) property of the button. |
hugo.toml
1[params]
2 [params.hb]
3 [params.hb.back_to_top]
4 animation = true
5 icon_height = '2em'
6 icon_name = 'rocket'
7 icon_width = '2em'
8 position_bottom = '1rem'
9 position_end = '1rem'
hugo.yaml
1params:
2 hb:
3 back_to_top:
4 animation: true
5 icon_height: 2em
6 icon_name: rocket
7 icon_width: 2em
8 position_bottom: 1rem
9 position_end: 1rem
hugo.json
1{
2 "params": {
3 "hb": {
4 "back_to_top": {
5 "animation": true,
6 "icon_height": "2em",
7 "icon_name": "rocket",
8 "icon_width": "2em",
9 "position_bottom": "1rem",
10 "position_end": "1rem"
11 }
12 }
13 }
14}