Skip to content
a CSS selector parser
TypeScript
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Create FUNDING.yml Jun 24, 2019
src Port tests to Jest Aug 2, 2019
.eslintrc.json Convert module to TypeScript Jul 13, 2019
.gitignore Port tests to Jest Aug 2, 2019
.travis.yml Port tests to Jest Aug 2, 2019
LICENSE added license Oct 12, 2012
package-lock.json Bump @types/jest from 24.0.16 to 24.0.18 Aug 28, 2019
package.json Add coveralls dependency Aug 3, 2019
readme.md Update readme.md Jul 17, 2019
tsconfig.json Port tests to Jest Aug 2, 2019

readme.md

css-what Build Status

a CSS selector parser

Example

const CSSwhat = require("css-what")
CSSwhat.parse("foo[bar]:baz")

~> [
    [
        { type: "tag", name: "foo" },
        {
            type: "attribute",
            name: "bar",
            action: "exists",
            value: "",
            ignoreCase: false
        },
        { type: "pseudo", name: "baz", data: null }
    ]
]

API

CSSwhat.parse(str, options) - Parses str, optionally with the passed options.

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:

name attributes example output
tag name div { type: 'tag', name: 'div' }
universal - * { type: 'universal' }
pseudo name, data :name(data) { type: 'pseudo', name: 'name', data: 'data' }
pseudo name, data :name { type: 'pseudo', name: 'name', data: null }
pseudo-element name ::name { type: 'pseudo-element', name: 'name' }
attribute name, action, value, ignoreCase [attr] { type: 'attribute', name: 'attr', action: 'exists', value: '', ignoreCase: false }
attribute name, action, value, ignoreCase [attr=val] { type: 'attribute', name: 'attr', action: 'equals', value: 'val', ignoreCase: false }
attribute name, action, value, ignoreCase [attr^=val] { type: 'attribute', name: 'attr', action: 'start', value: 'val', ignoreCase: false }
attribute name, action, value, ignoreCase [attr$=val] { type: 'attribute', name: 'attr', action: 'end', value: 'val', ignoreCase: false }
child - > { type: 'child' }
parent - < { type: 'parent' }
sibling - ~ { type: 'sibling' }
adjacent - + { type: 'adjacent' }
descendant - { type: 'descendant' }

Options:

  • lowerCaseTags: When false, tag names will not be lowercased. Defaults to true.
  • lowerCaseAttributeNames: When false, attribute names will not be lowercased. Defaults to true.
  • xmlMode: When true, xmlMode implies both lowerCaseTags and lowerCaseAttributeNames are set to false.

CSSwhat.stringify(selector) - Turns selector back into a string.


License: BSD-2-Clause

Get supported css-what with the Tidelift Subscription

Security contact information

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

You can’t perform that action at this time.