Skip to content
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

Jump to bottom

docs(assets): add note to inlining SVG through url() #15534

Merged
merged 5 commits into from
Mar 3, 2024
Merged

docs(assets): add note to inlining SVG through url() #15534

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b8e3d49
docs(assets): add note to inlining SVG through `url()`
chaejunlee Jan 8, 2024
81cf243
fix: remove styled-component example
chaejunlee Jan 8, 2024
aa786ac
fix: add comment to guide the usage
chaejunlee Jan 8, 2024
e5b2b9c
fix: generalize example to javascript
chaejunlee Mar 1, 2024
fbd9313
chore: fix quotes
sapphi-red Mar 2, 2024
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
10 changes: 10 additions & 0 deletions docs/guide/assets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,16 @@ The behavior is similar to webpack's `file-loader`. The difference is that the i

- TypeScript, by default, does not recognize static asset imports as valid modules. To fix this, include [`vite/client`](./features#client-types).

::: tip Inlining SVGs through `url()`
When passing a URL of SVG to a manually constructed `url()` by JS, the variable should be wrapped within double quotes.

```js
import imgUrl from './img.svg'
document.getElementById('hero-img').style.background = `url("${imgUrl}")`
```

:::

### Explicit URL Imports

Assets that are not included in the internal list or in `assetsInclude`, can be explicitly imported as a URL using the `?url` suffix. This is useful, for example, to import [Houdini Paint Worklets](https://houdini.how/usage).
Expand Down