Skip to content

Commit 4a59dc7

Browse files
committed
docs: add new feature to documentation
1 parent ded58a7 commit 4a59dc7

File tree

2 files changed

+18
-5
lines changed

2 files changed

+18
-5
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,4 +220,16 @@ tag: {
220220
type: String,
221221
default: 'nav',
222222
},
223+
224+
/**
225+
* If true the screen will be scrolled to the element present in the URL when the component
226+
* is mounted.
227+
*
228+
* @default true
229+
* @type {Boolean}
230+
*/
231+
scrollOnStart: {
232+
type: Boolean,
233+
default: true,
234+
},
223235
```

src/scrollactive.vue

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -152,11 +152,12 @@
152152
},
153153
154154
/**
155-
* Scroll to the anchor present if the current URL when the component is mounted.
156-
*
157-
* @default true
158-
* @type {Boolean}
159-
*/
155+
* If true the screen will be scrolled to the element present in the URL when the component
156+
* is mounted.
157+
*
158+
* @default true
159+
* @type {Boolean}
160+
*/
160161
scrollOnStart: {
161162
type: Boolean,
162163
default: true,

0 commit comments

Comments
 (0)