This repository has been archived by the owner on Mar 17, 2021. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(readme): Update CI status badge
- Loading branch information
Showing
1 changed file
with
165 additions
and
165 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,165 +1,165 @@ | ||
| [![npm][npm]][npm-url] | ||
| [![node][node]][node-url] | ||
| [![deps][deps]][deps-url] | ||
| [![tests][tests]][tests-url] | ||
| [![coverage][cover]][cover-url] | ||
| [![chat][chat]][chat-url] | ||
|
|
||
| <div align="center"> | ||
| <a href="https://github.com/webpack/webpack"> | ||
| <img width="200" height="200" | ||
| src="https://cdn.rawgit.com/webpack/media/e7485eb2/logo/icon.svg"> | ||
| </a> | ||
| <h1>URL Loader</h1> | ||
| <p>Loads files as `base64` encoded URL</p> | ||
| </div> | ||
|
|
||
| <h2 align="center">Install</h2> | ||
|
|
||
| ```bash | ||
| npm install --save-dev url-loader | ||
| ``` | ||
|
|
||
| <h2 align="center"><a href="https://webpack.js.org/concepts/loaders">Usage</a></h2> | ||
|
|
||
| The `url-loader` works like the [`file-loader`](https://github.com/webpack-contrib/file-loader), but can return a DataURL if the file is smaller than a byte limit. | ||
|
|
||
|
|
||
| ```js | ||
| import img from './image.png' | ||
| ``` | ||
|
|
||
| **webpack.config.js** | ||
| ```js | ||
| module.exports = { | ||
| module: { | ||
| rules: [ | ||
| { | ||
| test: /\.(png|jpg|gif)$/, | ||
| use: [ | ||
| { | ||
| loader: 'url-loader', | ||
| options: { | ||
| limit: 8192 | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| <h2 align="center">Options</h2> | ||
|
|
||
| |Name|Type|Default|Description| | ||
| |:--:|:--:|:-----:|:----------| | ||
| |**[`limit`](#limit)**|`{Number}`|`undefined`|Byte limit to inline files as Data URL| | ||
| |**[`mimetype`](#mimetype)**|`{String}`|`extname`|Specify MIME type for the file (Otherwise it's inferred from the file extension)| | ||
| |**[`fallback`](#fallback)**|`{String}`|`file-loader`|Specify `loader` for the file when file is greater than the limit (in bytes)| | ||
|
|
||
| ### `limit` | ||
|
|
||
| If the file is greater than the limit (in bytes) the [`file-loader`](https://github.com/webpack-contrib/file-loader) is used by default and all query parameters are passed to it. | ||
| You can use other loader using `fallback` option. | ||
|
|
||
| The limit can be specified via loader options and defaults to no limit. | ||
|
|
||
| **webpack.config.js** | ||
| ```js | ||
| { | ||
| loader: 'url-loader', | ||
| options: { | ||
| limit: 8192 | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### `mimetype` | ||
|
|
||
| Set the MIME type for the file. If unspecified the file extensions will be used to lookup the MIME type. | ||
|
|
||
| **webpack.config.js** | ||
| ```js | ||
| { | ||
| loader: 'url-loader', | ||
| options: { | ||
| mimetype: 'image/png' | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### `fallback` | ||
|
|
||
| **webpack.config.js** | ||
| ```js | ||
| { | ||
| loader: 'url-loader', | ||
| options: { | ||
| fallback: 'responsive-loader' | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| <h2 align="center">Maintainers</h2> | ||
|
|
||
| <table> | ||
| <tbody> | ||
| <tr> | ||
| <td align="center"> | ||
| <a href="https://github.com/bebraw"> | ||
| <img width="150" height="150" src="https://github.com/bebraw.png?v=3&s=150"> | ||
| </br> | ||
| Juho Vepsäläinen | ||
| </a> | ||
| </td> | ||
| <td align="center"> | ||
| <a href="https://github.com/d3viant0ne"> | ||
| <img width="150" height="150" src="https://github.com/d3viant0ne.png?v=3&s=150"> | ||
| </br> | ||
| Joshua Wiens | ||
| </a> | ||
| </td> | ||
| <td align="center"> | ||
| <a href="https://github.com/sapegin"> | ||
| <img width="150" height="150" src="https://github.com/sapegin.png?v=3&s=150"> | ||
| </br> | ||
| Artem Sapegin | ||
| </a> | ||
| </td> | ||
| <td align="center"> | ||
| <a href="https://github.com/michael-ciniawsky"> | ||
| <img width="150" height="150" src="https://github.com/michael-ciniawsky.png?v=3&s=150"> | ||
| </br> | ||
| Michael Ciniawsky | ||
| </a> | ||
| </td> | ||
| <td align="center"> | ||
| <a href="https://github.com/evilebottnawi"> | ||
| <img width="150" height="150" src="https://github.com/evilebottnawi.png?v=3&s=150"> | ||
| </br> | ||
| Alexander Krasnoyarov | ||
| </a> | ||
| </td> | ||
| </tr> | ||
| <tbody> | ||
| </table> | ||
|
|
||
|
|
||
| [npm]: https://img.shields.io/npm/v/url-loader.svg | ||
| [npm-url]: https://npmjs.com/package/url-loader | ||
|
|
||
| [node]: https://img.shields.io/node/v/url-loader.svg | ||
| [node-url]: https://nodejs.org | ||
|
|
||
| [deps]: https://david-dm.org/webpack-contrib/url-loader.svg | ||
| [deps-url]: https://david-dm.org/webpack-contrib/url-loader | ||
|
|
||
| [tests]: http://img.shields.io/travis/webpack-contrib/url-loader.svg | ||
| [tests-url]: https://travis-ci.org/webpack-contrib/url-loader | ||
|
|
||
| [cover]: https://coveralls.io/repos/github/webpack-contrib/url-loader/badge.svg | ||
| [cover-url]: https://coveralls.io/github/webpack-contrib/url-loader | ||
|
|
||
| [chat]: https://badges.gitter.im/webpack/webpack.svg | ||
| [chat-url]: https://gitter.im/webpack/webpack | ||
| [![npm][npm]][npm-url] | ||
| [![node][node]][node-url] | ||
| [![deps][deps]][deps-url] | ||
| [![tests][tests]][tests-url] | ||
| [![coverage][cover]][cover-url] | ||
| [![chat][chat]][chat-url] | ||
|
|
||
| <div align="center"> | ||
| <a href="https://github.com/webpack/webpack"> | ||
| <img width="200" height="200" | ||
| src="https://cdn.rawgit.com/webpack/media/e7485eb2/logo/icon.svg"> | ||
| </a> | ||
| <h1>URL Loader</h1> | ||
| <p>Loads files as `base64` encoded URL</p> | ||
| </div> | ||
|
|
||
| <h2 align="center">Install</h2> | ||
|
|
||
| ```bash | ||
| npm install --save-dev url-loader | ||
| ``` | ||
|
|
||
| <h2 align="center"><a href="https://webpack.js.org/concepts/loaders">Usage</a></h2> | ||
|
|
||
| The `url-loader` works like the [`file-loader`](https://github.com/webpack-contrib/file-loader), but can return a DataURL if the file is smaller than a byte limit. | ||
|
|
||
|
|
||
| ```js | ||
| import img from './image.png' | ||
| ``` | ||
|
|
||
| **webpack.config.js** | ||
| ```js | ||
| module.exports = { | ||
| module: { | ||
| rules: [ | ||
| { | ||
| test: /\.(png|jpg|gif)$/, | ||
| use: [ | ||
| { | ||
| loader: 'url-loader', | ||
| options: { | ||
| limit: 8192 | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| <h2 align="center">Options</h2> | ||
|
|
||
| |Name|Type|Default|Description| | ||
| |:--:|:--:|:-----:|:----------| | ||
| |**[`limit`](#limit)**|`{Number}`|`undefined`|Byte limit to inline files as Data URL| | ||
| |**[`mimetype`](#mimetype)**|`{String}`|`extname`|Specify MIME type for the file (Otherwise it's inferred from the file extension)| | ||
| |**[`fallback`](#fallback)**|`{String}`|`file-loader`|Specify `loader` for the file when file is greater than the limit (in bytes)| | ||
|
|
||
| ### `limit` | ||
|
|
||
| If the file is greater than the limit (in bytes) the [`file-loader`](https://github.com/webpack-contrib/file-loader) is used by default and all query parameters are passed to it. | ||
| You can use other loader using `fallback` option. | ||
|
|
||
| The limit can be specified via loader options and defaults to no limit. | ||
|
|
||
| **webpack.config.js** | ||
| ```js | ||
| { | ||
| loader: 'url-loader', | ||
| options: { | ||
| limit: 8192 | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### `mimetype` | ||
|
|
||
| Set the MIME type for the file. If unspecified the file extensions will be used to lookup the MIME type. | ||
|
|
||
| **webpack.config.js** | ||
| ```js | ||
| { | ||
| loader: 'url-loader', | ||
| options: { | ||
| mimetype: 'image/png' | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### `fallback` | ||
|
|
||
| **webpack.config.js** | ||
| ```js | ||
| { | ||
| loader: 'url-loader', | ||
| options: { | ||
| fallback: 'responsive-loader' | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| <h2 align="center">Maintainers</h2> | ||
|
|
||
| <table> | ||
| <tbody> | ||
| <tr> | ||
| <td align="center"> | ||
| <a href="https://github.com/bebraw"> | ||
| <img width="150" height="150" src="https://github.com/bebraw.png?v=3&s=150"> | ||
| </br> | ||
| Juho Vepsäläinen | ||
| </a> | ||
| </td> | ||
| <td align="center"> | ||
| <a href="https://github.com/d3viant0ne"> | ||
| <img width="150" height="150" src="https://github.com/d3viant0ne.png?v=3&s=150"> | ||
| </br> | ||
| Joshua Wiens | ||
| </a> | ||
| </td> | ||
| <td align="center"> | ||
| <a href="https://github.com/sapegin"> | ||
| <img width="150" height="150" src="https://github.com/sapegin.png?v=3&s=150"> | ||
| </br> | ||
| Artem Sapegin | ||
| </a> | ||
| </td> | ||
| <td align="center"> | ||
| <a href="https://github.com/michael-ciniawsky"> | ||
| <img width="150" height="150" src="https://github.com/michael-ciniawsky.png?v=3&s=150"> | ||
| </br> | ||
| Michael Ciniawsky | ||
| </a> | ||
| </td> | ||
| <td align="center"> | ||
| <a href="https://github.com/evilebottnawi"> | ||
| <img width="150" height="150" src="https://github.com/evilebottnawi.png?v=3&s=150"> | ||
| </br> | ||
| Alexander Krasnoyarov | ||
| </a> | ||
| </td> | ||
| </tr> | ||
| <tbody> | ||
| </table> | ||
|
|
||
|
|
||
| [npm]: https://img.shields.io/npm/v/url-loader.svg | ||
| [npm-url]: https://npmjs.com/package/url-loader | ||
|
|
||
| [node]: https://img.shields.io/node/v/url-loader.svg | ||
| [node-url]: https://nodejs.org | ||
|
|
||
| [deps]: https://david-dm.org/webpack-contrib/url-loader.svg | ||
| [deps-url]: https://david-dm.org/webpack-contrib/url-loader | ||
|
|
||
| [tests]: https://circleci.com/gh/webpack-contrib/url-loader/tree/master.svg?style=svg | ||
| [tests-url]: https://circleci.com/gh/webpack-contrib/url-loader/tree/master | ||
|
|
||
| [cover]: https://coveralls.io/repos/github/webpack-contrib/url-loader/badge.svg | ||
| [cover-url]: https://coveralls.io/github/webpack-contrib/url-loader | ||
|
|
||
| [chat]: https://badges.gitter.im/webpack/webpack.svg | ||
| [chat-url]: https://gitter.im/webpack/webpack |