aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEvgeny Kuznetsov <evgeny@kuznetsov.md>2022-12-01 10:55:30 +0300
committerEvgeny Kuznetsov <evgeny@kuznetsov.md>2022-12-01 10:55:30 +0300
commit64402ae947df8ca23271b8495586491793559afe (patch)
treea796c3b927849da6bebed79a6e79f352362ca1d1
parent6c0724ac273746addd4aa322bb2cc2c6f7bba7c2 (diff)
downloadhovercard.js-64402ae947df8ca23271b8495586491793559afe.tar.gz
hovercard.js-64402ae947df8ca23271b8495586491793559afe.zip
docs: document data-class usage
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index fbc10d6..806ac4a 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ This is a fork of the [original project](https://github.com/capjamesg/hovercard.
## Getting Started
-The `hovercard.js` script searches for all `<a>` tags enclosed within an `<article>` tag on a web page. Mouse hover and focus listeners are added to each link. When the mouse hovers over a link, `hovercard.js` looks for the `href` value of the link in a JSON object called `hovercards`. If the link is found in the JSON object, a hovercard is added directly below the link on the page.
+The `hovercard.js` script searches for all `<a>` tags enclosed within the tags marked with a specified class on a web page. Mouse hover and focus listeners are added to each link. When the mouse hovers over a link, `hovercard.js` looks for the `href` value of the link in a JSON object called `hovercards`. If the link is found in the JSON object, a hovercard is added directly below the link on the page.
When a user hovers off the link or moves focus onto another element (i.e. by using the keyboard to navigate links on the page), the hovercard will disappear.
@@ -18,9 +18,9 @@ When a user hovers off the link or moves focus onto another element (i.e. by usi
To use the hovercard script, first download a copy and upload it to your site. Then, add this code above the closing `</body>` tag on your web page:
- <script src="./path/to/hovercard.js"></script>
+ <script src="./path/to/hovercard.js" data-class="use-hovercards"></script>
-Substitute the path of the script in the example above with the location of the script on your site.
+Substitute the path of the script in the example above with the location of the script on your site, and `"use-hovercards"` with any class name to your liking. If the `data-class` part is omitted, the script will look in the `"content"` class by default.
## Roadmap