Skip to content

Commit afc4373

Browse files
authored
Update README.md
1 parent 176d67e commit afc4373

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,14 @@ myMagicLine.init();
2727
## This is how it looks like:
2828
![Alt text](https://raw.githubusercontent.com/basticodes/Vanilla-JS-Magic-Line-Navigation/master/demo/screenshot.PNG)
2929

30+
## Options
31+
| Option | Value | | Default |
32+
| ------------- |:-------------:|:---------------------------------------------:|:---------------:|
33+
| navElements | a query Selector, you can even define multiple like 'a, span' | 'a' |
34+
| mode | might be either 'line' or 'pill' | 'line' |
35+
| lineStrength | thickness of your line in px | 2 |
36+
| lineClass | The classname of the floating-line element | 'floating-line' |
37+
| wrapper | DOMNode to be inserted as a wrapper | 'div' |
38+
| animationCallback | a callBack Function used for animation | null |
39+
3040
Check out the [Demo](https://codepen.io/bastian_fiessinger/pen/MWYMWJN) on Codepen

0 commit comments

Comments
 (0)