| Nikolay Vitkov | 1037198 | 2025-02-03 17:08:07 | [diff] [blame] | 1 | # css-what |
| Tim van der Lippe | 706ec96 | 2021-06-04 12:24:42 | [diff] [blame] | 2 | |
| Nikolay Vitkov | 1037198 | 2025-02-03 17:08:07 | [diff] [blame] | 3 | [](https://github.com/fb55/css-what/actions/workflows/nodejs-test.yml) |
| 4 | [](https://coveralls.io/github/fb55/css-what?branch=master) |
| 5 | |
| 6 | A CSS selector parser. |
| Tim van der Lippe | 706ec96 | 2021-06-04 12:24:42 | [diff] [blame] | 7 | |
| 8 | ## Example |
| 9 | |
| 10 | ```js |
| Nikolay Vitkov | 1037198 | 2025-02-03 17:08:07 | [diff] [blame] | 11 | import * as CSSwhat from "css-what"; |
| 12 | |
| Tim van der Lippe | 706ec96 | 2021-06-04 12:24:42 | [diff] [blame] | 13 | CSSwhat.parse("foo[bar]:baz") |
| 14 | |
| 15 | ~> [ |
| 16 | [ |
| 17 | { type: "tag", name: "foo" }, |
| 18 | { |
| 19 | type: "attribute", |
| 20 | name: "bar", |
| 21 | action: "exists", |
| 22 | value: "", |
| Nikolay Vitkov | 1037198 | 2025-02-03 17:08:07 | [diff] [blame] | 23 | ignoreCase: null |
| Tim van der Lippe | 706ec96 | 2021-06-04 12:24:42 | [diff] [blame] | 24 | }, |
| 25 | { type: "pseudo", name: "baz", data: null } |
| 26 | ] |
| 27 | ] |
| 28 | ``` |
| 29 | |
| 30 | ## API |
| 31 | |
| Nikolay Vitkov | 1037198 | 2025-02-03 17:08:07 | [diff] [blame] | 32 | **`CSSwhat.parse(selector)` - Parses `selector`.** |
| Tim van der Lippe | 706ec96 | 2021-06-04 12:24:42 | [diff] [blame] | 33 | |
| 34 | The function returns a two-dimensional array. The first array represents selectors separated by commas (eg. `sub1, sub2`), the second contains the relevant tokens for that selector. Possible token types are: |
| 35 | |
| Nikolay Vitkov | 1037198 | 2025-02-03 17:08:07 | [diff] [blame] | 36 | | name | properties | example | output | |
| 37 | | ------------------- | --------------------------------------- | ------------- | ---------------------------------------------------------------------------------------- | |
| 38 | | `tag` | `name` | `div` | `{ type: 'tag', name: 'div' }` | |
| 39 | | `universal` | - | `*` | `{ type: 'universal' }` | |
| 40 | | `pseudo` | `name`, `data` | `:name(data)` | `{ type: 'pseudo', name: 'name', data: 'data' }` | |
| 41 | | `pseudo` | `name`, `data` | `:name` | `{ type: 'pseudo', name: 'name', data: null }` | |
| 42 | | `pseudo-element` | `name` | `::name` | `{ type: 'pseudo-element', name: 'name' }` | |
| 43 | | `attribute` | `name`, `action`, `value`, `ignoreCase` | `[attr]` | `{ type: 'attribute', name: 'attr', action: 'exists', value: '', ignoreCase: false }` | |
| 44 | | `attribute` | `name`, `action`, `value`, `ignoreCase` | `[attr=val]` | `{ type: 'attribute', name: 'attr', action: 'equals', value: 'val', ignoreCase: false }` | |
| 45 | | `attribute` | `name`, `action`, `value`, `ignoreCase` | `[attr^=val]` | `{ type: 'attribute', name: 'attr', action: 'start', value: 'val', ignoreCase: false }` | |
| 46 | | `attribute` | `name`, `action`, `value`, `ignoreCase` | `[attr$=val]` | `{ type: 'attribute', name: 'attr', action: 'end', value: 'val', ignoreCase: false }` | |
| 47 | | `child` | - | `>` | `{ type: 'child' }` | |
| 48 | | `parent` | - | `<` | `{ type: 'parent' }` | |
| 49 | | `sibling` | - | `~` | `{ type: 'sibling' }` | |
| 50 | | `adjacent` | - | `+` | `{ type: 'adjacent' }` | |
| 51 | | `descendant` | - | | `{ type: 'descendant' }` | |
| 52 | | `column-combinator` | - | `\|\|` | `{ type: 'column-combinator' }` | |
| Tim van der Lippe | 706ec96 | 2021-06-04 12:24:42 | [diff] [blame] | 53 | |
| 54 | **`CSSwhat.stringify(selector)` - Turns `selector` back into a string.** |
| 55 | |
| 56 | --- |
| 57 | |
| 58 | License: BSD-2-Clause |
| 59 | |
| 60 | ## Security contact information |
| 61 | |
| 62 | To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). |
| 63 | Tidelift will coordinate the fix and disclosure. |
| 64 | |
| 65 | ## `css-what` for enterprise |
| 66 | |
| 67 | Available as part of the Tidelift Subscription |
| 68 | |
| 69 | The maintainers of `css-what` and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-css-what?utm_source=npm-css-what&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) |
