vite-plugin-browserslist-useragent weekly downloads statistics

vite-plugin-browserslist-useragent

A vite plugin wrapping browserslist-useragent-regexp which provides utility RegExps compiled by browserslist query to test browser useragent.

Simplest example: you can detect supported browsers on client-side.

1. Create .browserslistrc config, for example like this:

2. Add plugin to vite.config.*:

3. Import RegExp from virtual module:

Auto-generated virtual:supported-browsers:

Install

Why?

https://github.com/browserslist/browserslist-useragent-regexp#why

Why wrap browserslist-useragent-regexp with vite plugin?

Let Vite transform and bundle for you and no need to run CLI every time you change browserslist.

Virtual Module

Virtual module virtual:supported-browsers exposes two variables returned by the following two methods of browserslist-useragent-regexp whose arguments are passed from plugin's options:

getUserAgentRegex(options)=> browsersRegexp: RegExp

Compile browserslist query to one regex.

[getUserAgentRegexs(options)=> browsersRegexps: BrowserVersionedRegex[]](https://browserslist.github.io/browserslist-useragent-regexp/functions/getUserAgentRegexes.html)

Compile browserslist query to regexes for each browser.

Options

| Option | Type | Default | Description |

| browsers | string \| string[] | — | Manually provide a browserslist query (or an array of queries). Specifying this overrides the browserslist configuration specified in your project. | | env | string | — | When multiple browserslist environments are specified, pick the config belonging to this environment. | | ignorePatch | boolean | true | Ignore differences in patch browser numbers. | | ignoreMinor | boolean | false | Ignore differences in minor browser versions. | | allowHigherVersions | boolean | false | For all the browsers in the browserslist query, return a match if the useragent version is equal to or higher than the one specified in browserslist. | | allowZeroSubversions | boolean | false | Ignore match of patch or patch and minor, if they are 0. |

RegExp info object

| Property | Type | Description |

| family | string | Browser family. | | requestVersions | [number, number, number][] | Versions provided by browserslist. | | regex | RegExp | Regex to match useragent with family and versions. | | sourceRegex | RegExp | Original useragent regex, without versions. | | version | [number, number, number] \| null | Useragent version of regex. | | minVersion | [number, number, number] \| null | Useragent min version of regex. | | maxVersion | [number, number, number] \| null | Useragent max version of regex. |

Client Types

If you want type definition of virtual:supported-browsers, add vite-plugin-browserslist-useragent/client to compilerOptions.types of your tsconfig:

License

MIT License © 2022 Yue JIN

Description from the npm listing.