Skip to content

docs: add Vite example to SVG icons README #844

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
johnfraney wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add Vite example to SVG icons README #844

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions packages/svg-icons/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ regular | filled

## Implementation

### Webpack

A common use case is to use [svg-inline-loader](https://www.npmjs.com/package/svg-inline-loader) in your Webpack config.

```bash
Expand Down Expand Up @@ -69,3 +71,16 @@ Or `require`:
```ts
var icon = require('@fluentui/svg-icons/icons/add_20_filled.svg');
```

### Vite

If your project uses [Vite](https://vite.dev/), you can use an icon either as an SVG or inlined (note the URL query params):
```ts
import AddIconInline from "@fluentui/svg-icons/icons/add_20_filled.svg?inline";
import AddIconRaw from "@fluentui/svg-icons/icons/add_20_filled.svg?raw";

`<img src="${AddIconInline}">`
`<div>${AddIconRaw}</div>`
```

See <https://vite.dev/guide/assets.html> for more information on asset handling with Vite.