-
Notifications
You must be signed in to change notification settings - Fork 91
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: set list of used selector types in options
- Loading branch information
Showing
4 changed files
with
259 additions
and
129 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,7 +7,7 @@ It should work fine in any modern browser. It has no external dependencies. | |
## How to use | ||
|
||
```javascript | ||
// first, create instance of the object | ||
// first, create instance of the object with default options | ||
my_selector_generator = new CssSelectorGenerator | ||
|
||
// create (or find reference to) any element | ||
|
@@ -32,6 +32,35 @@ document.body.addEventListener('click', function (event) { | |
}); | ||
``` | ||
|
||
## Options | ||
|
||
You can set the options either when creating an instance, or you can set them via `setOptions()` method: | ||
|
||
```javascript | ||
custom_options = {selectors: ['tag', 'id', 'class']} | ||
|
||
// set options when creating an instance | ||
my_selector_generator = new CssSelectorGenerator(custom_options); | ||
|
||
// or set options later | ||
my_selector_generator.setOptions(custom_options); | ||
``` | ||
|
||
### selectors | ||
|
||
default: `['tag', 'id', 'class', 'nthchild']` | ||
|
||
So far the only option you can use is list of types of selectors, that will be used when constructing unique CSS selector. You may want to adjust this list for browser compatibility. | ||
|
||
Available values: | ||
|
||
- `'tag'` - Tag selector. E.g. `P`, `DIV`. | ||
- `'id'` - ID selector. E.g. `#myElement`. | ||
- `'class'` - Class selector. It will get all class names of the element. E.g. `.myClass`, `.firstClass.secondClass`. | ||
- `'nthchild'` - N-th child selector. It is supported from IE9 and higher, but it is necessary to create unique CSS selector for every possible element. You can remove it from the list for backwards browser compatibility, but then make sure to use IDs or class names on each element you want to target. E.g. `:nth-child(0)` | ||
- `'attribute'` - Attribute selector. Compatible wth IE7 and higher. It will not create matching pairs for element's ID and class name attributes. This type of selector is disabled by default. E.g. `[rel=someRel]` | ||
|
||
|
||
## Bug reports, feature requests and contact | ||
|
||
If you found any bugs, if you have feature requests or any questions, please, either [file an issue at GitHub][1] or send me an e-mail at [[email protected]][2] | ||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.