mirror of
https://github.com/facebook/docusaurus.git
synced 2025-04-28 17:57:48 +02:00
55 lines
1.1 KiB
Text
55 lines
1.1 KiB
Text
---
|
|
sidebar_position: 7
|
|
slug: /api/plugins/@docusaurus/plugin-svgr
|
|
---
|
|
|
|
# 📦 plugin-svgr
|
|
|
|
import APITable from '@site/src/components/APITable';
|
|
|
|
An [SVGR](https://react-svgr.com/) plugin to transform SVG files into React components automatically at build time.
|
|
|
|
## Installation {#installation}
|
|
|
|
```bash npm2yarn
|
|
npm install --save @docusaurus/plugin-svgr
|
|
```
|
|
|
|
:::tip
|
|
|
|
If you use the preset `@docusaurus/preset-classic`, you don't need to install this plugin as a dependency.
|
|
|
|
You can configure this plugin through the [preset options](../../using-plugins.mdx#docusauruspreset-classic).
|
|
|
|
:::
|
|
|
|
## Configuration {#configuration}
|
|
|
|
Accepted fields:
|
|
|
|
```mdx-code-block
|
|
<APITable>
|
|
```
|
|
|
|
| Name | Type | Default | Description |
|
|
| --- | --- | --- | --- |
|
|
| `svgrConfig` | `object` | `{}` | The [SVGR config options](https://react-svgr.com/docs/options/), forwarded as is |
|
|
|
|
```mdx-code-block
|
|
</APITable>
|
|
```
|
|
|
|
### Example configuration {#ex-config}
|
|
|
|
You can configure this plugin through plugin options.
|
|
|
|
```js config-tabs
|
|
// Preset Options: svgr
|
|
// Plugin Options: @docusaurus/plugin-svgr
|
|
|
|
const config = {
|
|
svgrConfig: {
|
|
/* SVGR config */
|
|
},
|
|
};
|
|
```
|