2
0
mirror of https://github.com/iconify/iconify.git synced 2025-01-07 07:34:22 +00:00

jsdocs: explanation for width and height on usedProps

This commit is contained in:
Joaquín Sánchez Jiménez 2022-03-17 13:38:24 +01:00
parent 248b1f9d39
commit a1c7087cf2

View File

@ -144,7 +144,10 @@ export type IconifyLoaderOptions = {
/**
* Holder to include the properties added to the svg.
*
* If you need that properties just add an empty object here, usefull for example when using it on `CSS`.
* The `width` and `height` will not be set to the `svg` if already present on it, and so, the `width` and `height` will be those you configure on the customizations.
* If you omit the `width/height/scale` options and the `svg` contains the `width` and/or `height`, then, both will be extracted from the `svg`.
*
* If you need that properties just add an empty object here, useful for example when using the `svg` on `CSS`.
*/
usedProps?: Record<string, string>;
};