Skip to content
This repository has been archived by the owner on Feb 17, 2021. It is now read-only.

Commit

Permalink
Improve documentation of the target attribute of step elements. (#253)
Browse files Browse the repository at this point in the history
  • Loading branch information
kemaldaggen authored and timlindvall committed Jun 24, 2016
1 parent dad1b5d commit ff4b76f
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions demo/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ <h2 id="basic-step-options">Basic step options</h2>
steps: [
{
// MANDATORY
target: STRING/ELEMENT - id of the target DOM element or DOM element itself,
target: STRING/ELEMENT - id of the target DOM element or CSS selector of DOM element or DOM element itself,
placement: STRING - ["top", "bottom", "right", "left"]
// OPTIONAL
title: STRING - step title,
Expand Down Expand Up @@ -196,7 +196,9 @@ <h2 id="all-step-options">All step options</h2>
<h3>Mandatory</h3>

<ul>
<li><p><code>target</code> [STRING/ELEMENT/ARRAY] - id of the target DOM element or DOM element itself. It is also possible to define an array of several targets. If an array is provided, Hopscotch will use the first target that exists on the page and disregard the rest.</p></li>
<li><p><code>target</code> [STRING/ELEMENT/ARRAY] - id of the target DOM element or CSS selector for target DOM element or DOM element itself. It is also possible to define an array of several targets. If an array is provided, Hopscotch will use the first target that exists on the page and disregard the rest.</p>
<p>If this parameter is given string, hopscotch will first try <code>document.getElementById</code> to test if it is an ID selector. If not it will in order try JQuery, Sizzle and finally <code>document.querySelector</code>. If target is not an ID selector, hopscotch will use the first element from the matched element list. </p>
</li>
<li><p><code>placement</code> [STRING] - specifies where the bubble should appear in relation to the target. Valid values are "top", "bottom", "right", "left".</p></li>
</ul>

Expand Down

0 comments on commit ff4b76f

Please sign in to comment.