https://github.com/keeganstreet/specificity

A JavaScript module for calculating the specificity of CSS selectors
https://github.com/keeganstreet/specificity

Last synced: 3 days ago
JSON representation

A JavaScript module for calculating the specificity of CSS selectors

• Host: GitHub
• URL: https://github.com/keeganstreet/specificity
• Owner: keeganstreet
• License: mit
• Created: 2012-08-20T09:52:18.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2023-06-23T10:52:21.000Z (over 1 year ago)
• Last Synced: 2024-11-06T09:41:42.301Z (7 days ago)
• Language: TypeScript
• Size: 82 KB
• Stars: 622
• Watchers: 16
• Forks: 39
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Specificity Calculator

A JavaScript module for calculating and comparing the [specificity of CSS selectors](https://www.w3.org/TR/selectors-4/#specificity). The module is used on the [Specificity Calculator](https://specificity.keegan.st/) website.

Note that version 1 is a complete re-write with support for CSS Selectors Level 4, and has a different API than earlier versions.

## calculate(selector)

### Parameters

- `selector`: `string` - should be a valid CSS selector

### Returns

A `Specificity` object with a type of `Record<"A" | "B" | "C", number>`.

### Examples

```js

calculate("#id");

{

  A: 1,

  B: 0,

  C: 0

}

calculate(".classname");

{

  A: 0,

  B: 1,

  C: 0

}

calculate("element");

{

  A: 0,

  B: 0,

  C: 1

}

calculate('ul#nav li.active a');

{

  A: 1,

  B: 1,

  C: 3

}

```

## compare(a, b)

### Parameters

- `a`: `Specificity` object with a type of `Record<"A" | "B" | "C", number>`

- `b`: `Specificity` object with a type of `Record<"A" | "B" | "C", number>`

### Returns

Returns a positive number if `a` has a higher specificity than `b`

Returns a negative number if `a` has a lower specificity than `b`

Returns `0` if `a` has the same specificity than `b`

### Examples

```js

[

  "element",

  ".classname",

  "#id",

]

  .map(calculate)

  .sort(compare);

[ { A: 0, B: 0, C: 1 }, { A: 0, B: 1, C: 0 }, { A: 1, B: 0, C: 0 } ]

```

## compareDesc(a, b)

Same as `compare` but returns the opposite value, for use in sorting specificity objects with the highest specificity first.