You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ Svelte Headroom is a [Svelte](https://svelte.dev) component to hide or show your
31
31
32
32
## Props
33
33
34
-
### `tolerance` number {#tolerance}
34
+
### `tolerance` number
35
35
36
36
The number of pixels that need to be scrolled in either direction for the effect to occur. This is useful if you want the user to be able to scroll slowly and not change the header position. Default: `0`.
37
37
@@ -42,7 +42,7 @@ The number of pixels that need to be scrolled in either direction for the effect
42
42
</Headroom>
43
43
44
44
```
45
-
### `offsetTop` number {#offsetTop}
45
+
### `offsetTop` number
46
46
47
47
The number of pixels from the top of the page before the effect is allowed to occur; *controls:*`class:atTop` (useful with hideAtTop, showAtTop). Default: `2`.
48
48
@@ -54,7 +54,7 @@ The number of pixels from the top of the page before the effect is allowed to oc
54
54
55
55
```
56
56
57
-
### `offsetBottom` number {#offsetBottom}
57
+
### `offsetBottom` number
58
58
59
59
The number of pixels from bottom to be considered at the bottom; *controls*`class:atBottom` (useful with hideAtBottom, showAtBottom). Default: `2`.
60
60
@@ -66,7 +66,7 @@ The number of pixels from bottom to be considered at the bottom; *controls* `cla
66
66
67
67
```
68
68
69
-
### `duration` string {#duration}
69
+
### `duration` string
70
70
71
71
The duration of the sliding effect. The value is passed on as a [CSS Transition Duration](https://developer.mozilla.org/en-US/docs/Web/CSS/transition-duration). Default: `"300ms"`.
72
72
@@ -78,7 +78,7 @@ The duration of the sliding effect. The value is passed on as a [CSS Transition
78
78
79
79
```
80
80
81
-
### `easing` string {#easing}
81
+
### `easing` string
82
82
83
83
The timing function (easing) of the sliding effect. The value is passed on as a [CSS Transition Timing Function](https://developer.mozilla.org/en-US/docs/Web/CSS/transition-timing-function). Default: `"linear"`.
84
84
@@ -90,7 +90,7 @@ The timing function (easing) of the sliding effect. The value is passed on as a
90
90
91
91
```
92
92
93
-
### `bottom` boolean {#bottom}
93
+
### `bottom` boolean
94
94
95
95
If this is to be pinned to the bottom, like a return to top button. Default: `false`.
96
96
@@ -108,7 +108,7 @@ You can play with heights and widths and different positioning; *see below for m
108
108
109
109
```
110
110
111
-
### `(show|hide)At(Top|Bottom)` boolean {#ats}
111
+
### `(show|hide)At(Top|Bottom)` boolean
112
112
113
113
If this is to be pinned to the bottom, like a return to top button. Default: `false`.
114
114
@@ -174,4 +174,4 @@ A `svelte-headroom` component emits two events: `pin` and `unpin`.
0 commit comments