Home

Awesome

Browserslist Cult Of Martians

<img width="120" height="120" alt="Browserslist logo by Anton Popov" src="https://browsersl.ist/logo.svg" align="right">

The config to share target browsers and Node.js versions between different front-end tools. It is used in:

All tools will find target browsers automatically, when you add the following to package.json:

  "browserslist": [
    "defaults and fully supports es6-module",
    "maintained node versions"
  ]

Or in .browserslistrc config:

# Browsers that we support

defaults and fully supports es6-module
maintained node versions

Developers set their version lists using queries like last 2 versions to be free from updating versions manually. Browserslist will use caniuse-lite with Can I Use data for this queries.

You can check how config works at our playground: browsersl.ist

<a href="https://browsersl.ist/"> <img src="/img/screenshot.webp" alt="browsersl.ist website"> </a> <br> <br> <div align="center"> <a href="https://evilmartians.com/?utm_source=browserslist"><img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>  <a href="https://cube.dev/?ref=eco-browserslist-github"><img src="https://user-images.githubusercontent.com/986756/154330861-d79ab8ec-aacb-4af8-9e17-1b28f1eccb01.svg" alt="Supported by Cube" width="227" height="46"></a> </div>

Table of Contents

Sponsors

Browserslist needs your support. We are accepting donations at Open Collective.

<a href="https://www.springernature.com/"><img src="https://user-images.githubusercontent.com/19343/227742503-cf7fc2b3-9cc4-481c-97b8-68414d762fda.png" alt="Sponsored by Springer Nature Technology" width="154" height="54"></a>      <a href="https://workleap.com/"><img src="https://workleap.com/wp-content/uploads/2023/05/workleap-logo.svg" alt="Sponsored by Workleap" width="154" height="40"></a>

Tools

Analyze your Browserslist Config

Update caniuse-lite

Show “We do not support your browser” Banner

Get Statistics for >5% in my stats:

Others

Text Editors

These extensions will add syntax highlighting for .browserslistrc files.

Best Practices

Queries

Browserslist will use browsers and Node.js versions query from one of these sources:

  1. .browserslistrc config file in current or parent directories.
  2. browserslist key in package.json file in current or parent directories.
  3. browserslist config file in current or parent directories.
  4. BROWSERSLIST environment variable.
  5. If the above methods did not produce a valid result Browserslist will use defaults: > 0.5%, last 2 versions, Firefox ESR, not dead.

Query Composition

An or combiner can use the keyword or as well as ,. last 1 version or > 1% is equal to last 1 version, > 1%.

and query combinations are also supported to perform an intersection of all the previous queries: last 1 version or chrome > 75 and > 1% will select (browser last version or Chrome since 76) and more than 1% marketshare.

There are 3 different ways to combine queries as depicted below. First you start with a single query and then we combine the queries to get our final list.

Obviously you can not start with a not combiner, since there is no left-hand side query to combine it with. The left-hand is always resolved as and combiner even if or is used (this is an API implementation specificity).

Query combiner typeIllustrationExample
or/, combiner <br> (union)Union of queries> .5% or last 2 versions <br> > .5%, last 2 versions
and combiner <br> (intersection)intersection of queries> .5% and last 2 versions
not combiner <br> (relative complement)Relative complement of queriesThese three are equivalent to one another: <br> > .5% and not last 2 versions <br> > .5% or not last 2 versions <br> > .5%, not last 2 versions

A quick way to test your query is to do npx browserslist '> 0.3%, not dead' in your terminal.

Full List

You can specify the browser and Node.js versions by queries (case insensitive):

You can add not to any query.

Grammar Definition

There is a grammar specification about the query syntax, which may be helpful if you're implementing a parser or something else.

Debug

Run npx browserslist in a project directory to see which browsers were selected by your queries.

$ npx browserslist
and_chr 61
and_ff 56
and_qq 1.2
and_uc 11.4
android 56
baidu 7.12
bb 10
chrome 62
edge 16
firefox 56
ios_saf 11
opera 48
safari 11
samsung 5

Browsers

The following table maps browser names & their target devices into identifiers used by browserslist.

Browser NameDesktopAndroidiOSOther Mobile
Android (WebView)Android
BaiduBaidu
BlackBerryBlackBerry bb
ChromeChromeChromeAndroid and_chr↪︎ ios_saf<sup>2</sup>
EdgeEdge↪︎ and_chr↪︎ ios_saf<sup>2</sup>
ElectronElectron
FirefoxFirefox ffFirefoxAndroid and_ff↪︎ ios_saf<sup>2</sup>
Internet ExplorerExplorer ieie_mob
Node.jsNode
KaiOS Browserkaios
OperaOperaop_mob <sup>1</sup>↪︎ ios_saf<sup>2</sup>
Opera Mini<sup>3</sup>OperaMini op_mini
QQ browserand_qq
SafariSafariiOS ios_saf
Samsung InternetSamsung
UC BrowserUCAndroid and_uc

Config File

package.json

If you want to reduce config files in project root, you can specify browsers in package.json with browserslist key:

{
  "private": true,
  "dependencies": {
    "autoprefixer": "^6.5.4"
  },
  "browserslist": [
    "last 1 version",
    "> 1%",
    "not dead"
  ]
}

.browserslistrc

Separated Browserslist config should be named .browserslistrc and have browsers queries split by a new line. Each line is combined with the or combiner. Comments starts with # symbol:

# Browsers that we support

last 1 version
> 1%
not dead # no browsers without security updates

Browserslist will check config in every directory in path. So, if tool process app/styles/main.css, you can put config to root, app/ or app/styles.

You can specify direct path in BROWSERSLIST_CONFIG environment variables.

Shareable Configs

You can use the following query to reference an exported Browserslist config from another package:

  "browserslist": [
    "extends browserslist-config-mycompany"
  ]

For security reasons, external configuration only supports packages that have the browserslist-config- prefix. npm scoped packages are also supported, by naming or prefixing the module with @scope/browserslist-config, such as @scope/browserslist-config or @scope/browserslist-config-mycompany.

If you don’t accept Browserslist queries from users, you can disable the validation by using the or BROWSERSLIST_DANGEROUS_EXTEND environment variable.

BROWSERSLIST_DANGEROUS_EXTEND=1 npx webpack

Because this uses npm's resolution, you can also reference specific files in a package:

  "browserslist": [
    "extends browserslist-config-mycompany/desktop",
    "extends browserslist-config-mycompany/mobile"
  ]

When writing a shared Browserslist package, just export an array. browserslist-config-mycompany/index.js:

module.exports = [
  'last 1 version',
  '> 1%',
  'not dead'
]

You can also include a browserslist-stats.json file as part of your shareable config at the root and query it using > 5% in browserslist-config-mycompany stats. It uses the same format as extends and the dangerousExtend property as above.

You can export configs for different environments and select environment by BROWSERSLIST_ENV or env option in your tool:

module.exports = {
  development: [
    'last 1 version'
  ],
  production: [
    'last 1 version',
    '> 1%',
    'not dead'
  ]
}

Configuring for Different Environments

You can also specify different browser queries for various environments. Browserslist will choose query according to BROWSERSLIST_ENV or NODE_ENV variables. If none of them is declared, Browserslist will firstly look for production queries and then use defaults.

In package.json:

  "browserslist": {
    "production": [
      "> 1%",
      "not dead"
    ],
    "modern": [
      "last 1 chrome version",
      "last 1 firefox version"
    ],
    "ssr": [
      "node 12"
    ]
  }

In .browserslistrc config:

[production]
> 1%
not dead

[modern]
last 1 chrome version
last 1 firefox version

[ssr]
node 12

Custom Usage Data

If you have a website, you can query against the usage statistics of your site. browserslist-ga will ask access to Google Analytics and then generate browserslist-stats.json:

npx browserslist-ga

Or you can use browserslist-ga-export to convert Google Analytics data without giving a password for Google account.

You can generate usage statistics file by any other method. File format should be like:

{
  "ie": {
    "6": 0.01,
    "7": 0.4,
    "8": 1.5
  },
  "chrome": {
    …
  },
  …
}

Note that you can query against your custom usage data while also querying against global or regional data. For example, the query > 1% in my stats, > 5% in US, 10% is permitted.

JS API

const browserslist = require('browserslist')

// Your CSS/JS build tool code
function process (source, opts) {
  const browsers = browserslist(opts.overrideBrowserslist, {
    stats: opts.stats,
    path:  opts.file,
    env:   opts.env
  })
  // Your code to add features for selected browsers
}

Queries can be a string "> 1%, not dead" or an array ['> 1%', 'not dead'].

If a query is missing, Browserslist will look for a config file. You can provide a path option (that can be a file) to find the config file relatively to it.

Options:

For non-JS environment and debug purpose you can use CLI tool:

browserslist "> 1%, not dead"

You can get total users coverage for selected browsers by JS API:

browserslist.coverage(browserslist('> 1%'))
//=> 81.4

browserslist.coverage(browserslist('> 1% in US'), 'US')
//=> 83.1

browserslist.coverage(browserslist('> 1% in my stats'), 'my stats')
//=> 83.1

browserslist.coverage(browserslist('> 1% in my stats', { stats }), stats)
//=> 82.2

Or by CLI:

$ browserslist --coverage "> 1%"
These browsers account for 81.4% of all users globally

$ browserslist --coverage=US "> 1% in US"
These browsers account for 83.1% of all users in the US

$ browserslist --coverage "> 1% in my stats"
These browsers account for 83.1% of all users in custom statistics

$ browserslist --coverage "> 1% in my stats" --stats=./stats.json
These browsers account for 83.1% of all users in custom statistics

Environment Variables

If a tool uses Browserslist inside, you can change the Browserslist settings with environment variables:

Cache

Browserslist caches the configuration it reads from package.json and browserslist files, as well as knowledge about the existence of files, for the duration of the hosting process.

To clear these caches, use:

browserslist.clearCaches()

To disable the caching altogether, set the BROWSERSLIST_DISABLE_CACHE environment variable.

Security Contact

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

For Enterprise

Available as part of the Tidelift Subscription.

The maintainers of browserslist 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.

Browsers Data Updating

See update-browserslist-db docs