|
|
||
|---|---|---|
| .. | ||
| CHANGELOG.md | ||
| LICENSE | ||
| README.md | ||
| browser.js | ||
| cli.js | ||
| error.js | ||
| index.js | ||
| node.js | ||
| package.json | ||
README.md
Browserslist
Library to share target browsers between different front-end tools. It is used in:
- Autoprefixer
- babel-preset-env
(external config in
package.jsonorbrowserslistwill be supported in 7.0) - postcss-preset-env
- eslint-plugin-compat
- stylelint-no-unsupported-browser-features
- postcss-normalize
All tools that rely on Browserslist will find its config automatically,
when you add the following to package.json:
{
"browserslist": [
"> 1%",
"last 2 versions"
]
}
Or in .browserslistrc config:
# Browsers that we support
> 1%
Last 2 versions
IE 10 # sorry
Developers set browsers list in queries like last 2 version
to be free from updating browser versions manually.
Browserslist will use Can I Use data for this queries.
Browserslist will take browsers queries from tool option,
browserslist config, .browserslistrc config,
browserslist section in package.json or environment variables.
You can test Browserslist queries in online demo.
Tools
browserslist-useragentchecks browser by user agent string to match Browserslist target browsers query.caniuse-apireturns browsers which support some specific feature.- Run
npx browserslistin your project directory to see project’s target browsers. This CLI tool is built-in and available in any project with Autoprefixer.
Queries
Browserslist will use browsers query from one of this sources:
- Tool options. For example
browsersoption in Autoprefixer. BROWSERSLISTenvironment variable.browserslistconfig file in current or parent directories..browserslistrcconfig file in current or parent directories.browserslistkey inpackage.jsonfile in current or parent directories. We recommend this way.- If the above methods did not produce a valid result
Browserslist will use defaults:
> 1%, last 2 versions, Firefox ESR.
You can specify the versions by queries (case insensitive):
last 2 versions: the last 2 versions for each browser.last 2 Chrome versions: the last 2 versions of Chrome browser.> 5%: versions selected by global usage statistics.>=,<and<=work too.> 5% in US: uses USA usage statistics. It accepts two-letter country code.> 5% in alt-AS: uses Asia region usage statistics. List of all region codes can be found atcaniuse-lite/data/regions.> 5% in my stats: uses custom usage data.extends browserslist-config-mycompany: take queries frombrowserslist-config-mycompanynpm package.ie 6-8: selects an inclusive range of versions.Firefox > 20: versions of Firefox newer than 20.>=,<and<=work too.iOS 7: the iOS browser version 7 directly.Firefox ESR: the latest [Firefox ESR] version.unreleased versionsorunreleased Chrome versions: alpha and beta versions.last 2 major versionsorlast 2 iOS major versions: all minor/patch releases of last 2 major versions.since 2015orlast 2 years: all versions released since year 2015 (alsosince 2015-03andsince 2015-03-10).not ie <= 8: exclude browsers selected by previous queries.
You can add not to any query.
Debug
Run npx browserslist in project directory to see what browsers was 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
Notes
Browserslist works with separated versions of browsers.
You should avoid queries like Firefox > 0.
Multiple criteria are combined as a boolean OR. A browser version must match
at least one of the criteria to be selected.
All queries are based on the Can I Use support table,
e.g. last 3 iOS versions might select 8.4, 9.2, 9.3 (mixed major and minor),
whereas last 3 Chrome versions might select 50, 49, 48 (major only).
Browsers
Names are case insensitive:
Androidfor Android WebView.Baidufor Baidu Browser.BlackBerryorbbfor Blackberry browser.Chromefor Google Chrome.ChromeAndroidorand_chrfor Chrome for AndroidEdgefor Microsoft Edge.Electronfor Electron framework. It will be converted to Chrome version.Exploreroriefor Internet Explorer.ExplorerMobileorie_mobfor Internet Explorer Mobile.Firefoxorfffor Mozilla Firefox.FirefoxAndroidorand_fffor Firefox for Android.iOSorios_saffor iOS Safari.Operafor Opera.OperaMiniorop_minifor Opera Mini.OperaMobileorop_mobfor Opera Mobile.QQAndroidorand_qqfor QQ Browser for Android.Safarifor desktop Safari.Samsungfor Samsung Internet.UCAndroidorand_ucfor UC Browser for Android.
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": [
"> 1%",
"last 2 versions"
]
}
Config File
Browserslist config should be named .browserslistrc or browserslist
and have browsers queries split by a new line. Comments starts with # symbol:
# Browsers that we support
> 1%
Last 2 versions
IE 8 # sorry
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 dangerousExtend option:
browserslist(queries, { path, dangerousExtend: true })
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 2 versions',
'ie 9'
]
Environment Variables
If some tool use Browserslist inside, you can change browsers settings by environment variables:
-
BROWSERSLISTwith browsers queries.BROWSERSLIST="> 5%" gulp css -
BROWSERSLIST_CONFIGwith path to config file.BROWSERSLIST_CONFIG=./config/browserslist gulp css -
BROWSERSLIST_ENVwith environments string.BROWSERSLIST_ENV="development" gulp css -
BROWSERSLIST_STATSwith path to the custom usage data for> 1% in my statsquery.BROWSERSLIST_STATS=./config/usage_data.json gulp css -
BROWSERSLIST_DISABLE_CACHEif you want to disable config reading cache.BROWSERSLIST_DISABLE_CACHE=1 gulp css
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 development queries and then use defaults.
In package.json:
"browserslist": {
"production": [
"last 2 version",
"ie 9"
],
"development": [
"last 1 version"
]
}
In .browserslistrc config:
[production]
last 2 version
ie 9
[development]
last 1 version
Custom Usage Data
If you have a website, you can query against the usage statistics of your site:
-
Import your Google Analytics data into Can I Use. Press
Import…button in Settings page. -
Open browser DevTools on Can I Use and paste this snippet into the browser console:
var e=document.createElement('a');e.setAttribute('href', 'data:text/plain;charset=utf-8,'+encodeURIComponent(JSON.stringify(JSON.parse(localStorage['usage-data-by-id'])[localStorage['config-primary_usage']])));e.setAttribute('download','stats.json');document.body.appendChild(e);e.click();document.body.removeChild(e); -
Save the data to a
browserslist-stats.jsonfile in your project.
Of course, 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.
Webpack
If you plan to use Browserslist on client-side (e. g., tools like CodePen) Browserslist could take big part of your bundle (150 KB).
But the biggest part of this size will be region usage statistics, which could
be useless for you. IgnorePlugin could cut it:
const webpackConfig = {
…
plugins: [
new webpack.IgnorePlugin(/caniuse-lite\/data\/regions/)
]
}
This plugin will reduce Browserslist size from 150 KB to 6 KB. But you loose
> 1% in US queries support.
JS API
var browserslist = require('browserslist');
// Your CSS/JS build tool code
var process = function (source, opts) {
var browsers = browserslist(opts.browsers, {
stats: opts.stats,
path: opts.file,
env: opts.env
});
// Your code to add features for selected browsers
}
Queries can be a string "> 5%, last 1 version"
or an array ['> 5%', 'last 1 version'].
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.
For non-JS environment and debug purpose you can use CLI tool:
browserslist "> 1%, last 2 versions"
Coverage
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
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
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.