Extend Vite with ability to use SVG files as Solid.js components.
- SVGO optimization
- Hot Module Replacement support
- Support for
?url
and?component
query string - SSR
2.4.4 or above
yarn add --dev vite-plugin-solid-svg
npm i -D vite-plugin-solid-svg
// vite.config.js
import solidPlugin from "vite-plugin-solid";
import solidSvg from "vite-plugin-solid-svg";
module.exports = {
plugins: [
solidPlugin(),
solidSvg(),
],
};
SolidSvg({
// Default behavior when importing `.svg` files, possible options are: 'url' and `component`
defaultExport: 'component',
svgo: {
enabled: true, // optional, by default is true
svgoConfig: <svgo config> // optional, if defined, the file svgo.config.js is not loaded.
}
})
If you need to configure svgo
, you can also create a config file svgo.config.js
in the project's root, following the instructions at svgo docs. The svgo.svgoConfig
has precedence over the file.
Import as a Solid.js component:
import MyIcon from './svgs/my-icon.svg';
const App = () => {
return (
<div>
<h1> Title </h1>
<MyIcon />
</div>
);
};
export default App;
Import as url:
import myIconUrl from './svgs/my-icon.svg?url';
const App = () => {
return (
<div>
<p>url to icon: {myIconUrl} </p>
</div>
);
};
export default App;
To import all svg inside a folder, use [name].svg
as the file value. This will import an object, where the keys are the matched names (without extension), and the values are the corresponding component or url.
import iconsDic from './svgs/[name].svg';
/*
iconsDic = {
icon1: () => import("./svgs/icon1.svg"),
icon2: () => import("./svgs/icon2.svg")
}
*/
const App = () => {
const Icon1 = lazy(() => iconsDic.icon1())
return (
<div>
<p>hello</p><Icon1 />
</div>
);
};
export default App;
vite add its own definition for "*.svg"
and it define them as string
. So far as I know this can't be overrided.
To propertly have type inference, you must use the imports with querystring.
import MyIcon from './svgs/my-icon.svg'; // <-- this will match vite module definition, and therefore identified as string
import MyIcon from './svgs/my-icon.svg?component'; // <-- this will match the definition in this plugin, and therefore identified as Solid Component
In a Solidjs + vite project, you can easily add an svg image using:
import iconUrl from '/svgs/icon.svg'
const App = () => {
return (
<div>
<img href={iconUrl}>
</div>
)
}
However the fill color of the image cannot be overriden. Importing the svg as a component solves this and allows css styles to cascade into the svg content. Furthermore there may be situations where you'll need to ensure the image has been fully loaded, for example, before starting an animation. This module gives you a component that you can control when it's loaded.
This plugin is based on the work from the following projects: