File: BackToTop.md

package info (click to toggle)
cockpit 354-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 308,956 kB
  • sloc: javascript: 775,606; python: 40,351; ansic: 35,655; cpp: 11,117; sh: 3,511; makefile: 580; xml: 261
file content (30 lines) | stat: -rw-r--r-- 666 bytes parent folder | download | duplicates (4)
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
---
id: 'Back to top'
section: components
cssPrefix: pf-v6-c-back-to-top
---import './BackToTop.css'

## Examples

### Basic

```html
<div class="pf-v6-c-back-to-top">
  <a class="pf-v6-c-button pf-m-primary" href="#">
    <span class="pf-v6-c-button__text">Back to top</span>
    <span class="pf-v6-c-button__icon pf-m-end">
      <i class="fas fa-angle-up" aria-hidden="true"></i>
    </span>
  </a>
</div>

```

## Documentation

### Usage

| Class | Applied to | Outcome |
| -- | -- | -- |
| `.pf-v6-c-back-to-top` | `<div>` | Initiates the back to top component. **Required** |
| `.pf-m-hidden` | `.pf-v6-c-back-to-top` | Modifies the component to be hidden. |