Skip to content

add information about valid selectors #27137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Johann-S merged 2 commits into from
Aug 31, 2018
Merged

add information about valid selectors #27137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7ee333
add information about valid selectors
Johann-S Aug 26, 2018
a8699db
Merge branch 'v4-dev' into v4-dev-jo-selectors
Johann-S Aug 31, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 1 addition & 8 deletions js/src/util.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,20 +77,13 @@ const Util = (($) => {

getSelectorFromElement(element) {
let selector = element.getAttribute('data-target')
let method = 'querySelector'

if (!selector || selector === '#') {
selector = (element.getAttribute('href') || '').trim()
}

const validSelector = selector
if (selector.charAt(0) === '#' && selector.indexOf(',') === -1) {
selector = selector.substr(1)
method = 'getElementById'
}

try {
return document[method](selector) ? validSelector : null
return document.querySelector(selector) ? selector : null
} catch (err) {
return null
}
Expand Down
25 changes: 0 additions & 25 deletions js/tests/unit/util.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,31 +20,6 @@ $(function () {
assert.strictEqual(Util.getSelectorFromElement($el2[0]), null)
})

QUnit.test('Util.getSelectorFromElement should use getElementById', function (assert) {
assert.expect(2)

var spy = sinon.spy(document, 'getElementById')

var $el = $('<div data-target="#7"></div>').appendTo($('#qunit-fixture'))
$('<div id="7" />').appendTo($('#qunit-fixture'))

assert.strictEqual(Util.getSelectorFromElement($el[0]), '#7')
assert.ok(spy.called)
})

QUnit.test('Util.getSelectorFromElement should use querySelector when there are multi ids', function (assert) {
assert.expect(2)

var spy = sinon.spy(document, 'querySelector')

var $el = $('<div data-target="#j7, #j8"></div>').appendTo($('#qunit-fixture'))
$('<div id="j7" />').appendTo($('#qunit-fixture'))
$('<div id="j8" />').appendTo($('#qunit-fixture'))

assert.strictEqual(Util.getSelectorFromElement($el[0]), '#j7, #j8')
assert.ok(spy.called)
})

QUnit.test('Util.typeCheckConfig should thrown an error when a bad config is passed', function (assert) {
assert.expect(1)
var namePlugin = 'collapse'
Expand Down
6 changes: 4 additions & 2 deletions site/docs/4.1/getting-started/javascript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,10 @@ $(document).off('.alert.data-api')
{% endhighlight %}

{% capture callout %}
##### Escaping selectors
If you use special selectors, for example: `collapse:Example`, be sure to escape them, because they'll be passed through jQuery.
## Selectors

Currently to query DOM elements we use the native methods `querySelector` and `querySelectorAll` for performance reasons, so you have to use [valid selectors](https://www.w3.org/TR/CSS21/syndata.html#value-def-identifier).
If you use special selectors, for example: `collapse:Example` be sure to escape them.
{% endcapture %}
{% include callout.html content=callout type="warning" %}

Expand Down