From 35ee4b0b8f5b5396e0b665cd2570390567011578 Mon Sep 17 00:00:00 2001
From: Daniel Kurowski <daniel.kurowski@grifart.cz>
Date: Mon, 7 Nov 2022 20:25:06 +0100
Subject: [PATCH] update readme
---
README.md | 16 +++++++---------
1 file changed, 7 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index f22c531..8bc95ac 100644
--- a/README.md
+++ b/README.md
@@ -43,17 +43,15 @@ jumping on the page up and down due to browser native behaviour.
### scrollToX functions
-|Function|Parameters|
-|---|---|
-|`scrollToElement(element[, onScrollFinishedCallback])`|`element`: element to scroll to; `onScrollFinishedCallback` (optional): callback to trigger when scrolling is finished|
-|`scrollToOffset(topOffset[, onScrollFinishedCallback])`|`topOffset`: scroll offset from top of document; `onScrollFinishedCallback` (optional): callback to trigger when scrolling is finished|
-|`scrollToTarget(hashTarget[, onScrollFinishedCallback])`|`hashTarget`: instance of `HashTarget` object\* or `string`\*\*; `onScrollFinishedCallback` (optional): callback to trigger when scrolling is finished|
+| Function | Parameters |
+|----------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `scrollToElement(element[, onScrollFinishedCallback])` | `element`: element to scroll to; `onScrollFinishedCallback` (optional): callback to trigger when scrolling is finished |
+| `scrollToOffset(topOffset[, onScrollFinishedCallback])` | `topOffset`: scroll offset from top of document; `onScrollFinishedCallback` (optional): callback to trigger when scrolling is finished |
+| `scrollToTarget(targetHash[, onScrollFinishedCallback])` | `targetHash`: instance of `Hash` value object\* or hash a `string`; `onScrollFinishedCallback` (optional): callback to trigger when scrolling is finished |
-\* `HashTarget` is a value object representing a target to scroll to.
+\* `Hash` is a value object representing a hash being requested.
You can easily initalize it with named constructor:
-`HashTarget.fromString('#some-identifier', document)`
-\*\* In case of passing `string`, `HashTarget` object will be
-instantiated automatically with current `document` context.
+`Hash.fromString('#some-identifier')`
## More about
--
GitLab