Skip to content

Commit fdb44bf

Browse files
committed
maint(pat scroll): Update documentation.
1 parent a9b5035 commit fdb44bf

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

src/pat/scroll/documentation.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,11 @@ Automatically scrolling once the page loads
4747
Scrolling can be configured through a `data-pat-scroll` attribute.
4848
The available options are:
4949

50-
| Field | Default | Options | Description |
51-
| ----------- | ------------------------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
52-
| `trigger` | `click` | `click`, `auto`, `manual` | `auto` means that the scrolling will happen as soon as the page loads, additional to `click` events. `click` means that the configured element needs to be clicked first. `manual` does only scroll when initialized via JavaScript. |
53-
| `direction` | `top` | `top`, `left` | The direction in which the scrolling happens. |
54-
| `selector` | | CSS selector, `top`, `bottom` or `self` | A CSS selector for the element which will be scrolled into view. `self` if it is the pat-scoll element itself. `top` to scroll to the very top of the scroll container, `bottom` to scroll to the very bottom. |
55-
| `offset` | | A number | `offset` in pixels to stop scrolling before the target position. Can also be a negative number. |
50+
| Field | Default | Options | Description |
51+
| --------- | --------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
52+
| trigger | `click` | `click`, `auto`, `manual` | `auto` means that the scrolling will happen as soon as the page loads, additional to `click` events. `click` means that the configured element needs to be clicked first. `manual` does only scroll when initialized via JavaScript. |
53+
| direction | `top` | `top`, `left` | The direction in which the scrolling happens. |
54+
| selector | | CSS selector, `top`, `bottom` or `self` | A CSS selector for the element which will be scrolled into view. `self` if it is the pat-scoll element itself. `top` to scroll to the very top of the scroll container, `bottom` to scroll to the very bottom. |
55+
| offset | `0` | A number | `offset` in pixels to stop scrolling before the target position. Can also be a negative number. |
56+
| delay | | A number | A delay in ms, after which scrolling should start. |
57+

0 commit comments

Comments
 (0)