1.0.0 • Published 10 months ago
jest-svg v1.0.0
jest-svg
This library transforms .SVG files for jest in React components.
The transformed item will have the following properties on it.
- data-jest-file-name: The name of the file (e.g. 'some-image.svg')
- data-jest-svg-name: Only the name portion of the file (e.g. 'some-image')
- data-testid: Same as data-jest-svg-name, but works with @testing-library/react getByTestId()
Works with both of these formats:
import MySvg from '../images/an-image.svg';
import { ReactComponent as MySvg} from '../images/an-image.svg';
The following JavaScript
const MyComponent = () => {
return (
<div>
<MySvg/>
</div>
);
}
The resulting HTML:
<div>
<svg data-jest-file-name='an-image.svg'
data-jest-svg-name='an-image'
data-testid='an-image'/>
</div>
Usage
Configuring Jest, the example below uses package.json, but you can see: https://jestjs.io/docs/en/configuration for other examples.
{
"jest": {
"transform": {
"\\.svg$": "jest-svg"
}
}
}
1.0.0
10 months ago