Implement new UI component for icons #230
- Introduce `AppIcon.vue`, offering improved performance over the previous `fort-awesome` dependency. This implementation reduces bundle size by 67.31KB (tested for web using `npm run build -- --mode prod`). - Migrate Font Awesome 5 icons to Font Awesome 6. This commit facilitates migration to Vue 3.0 (#230) and ensures no Vue component remains tightly bound to a specific Vue version, enhancing code portability. Font Awesome license is not included because Font Awesome revokes its right: > "Attribution is no longer required as of Font Awesome 3.0" > > Sources: > > - https://fontawesome.com/v4/license/ (archived: https://web.archive.org/web/20231003213441/https://fontawesome.com/v4/license/, https://archive.ph/Yy9j5) > - https://github.com/FortAwesome/Font-Awesome/wiki (archived: https://web.archive.org/web/20231003214646/https://github.com/FortAwesome/Font-Awesome/wiki, https://archive.ph/C6sXv) This commit removes following third-party production dependencies: - `@fortawesome/vue-fontawesome` - `@fortawesome/free-solid-svg-icons` - `@fortawesome/free-regular-svg-icons` - `@fortawesome/free-brands-svg-icons` - `@fortawesome/fontawesome-svg-core`
This commit is contained in:
100
tests/unit/presentation/components/Shared/Icon/AppIcon.spec.ts
Normal file
100
tests/unit/presentation/components/Shared/Icon/AppIcon.spec.ts
Normal file
@@ -0,0 +1,100 @@
|
||||
import {
|
||||
describe, it, expect,
|
||||
} from 'vitest';
|
||||
import { shallowMount } from '@vue/test-utils';
|
||||
import { nextTick } from 'vue';
|
||||
import AppIcon from '@/presentation/components/Shared/Icon/AppIcon.vue';
|
||||
import { IconName } from '@/presentation/components/Shared/Icon/IconName';
|
||||
import { UseSvgLoaderStub } from '@tests/unit/shared/Stubs/UseSvgLoaderStub';
|
||||
|
||||
describe('AppIcon.vue', () => {
|
||||
it('renders the correct SVG content based on the icon prop', async () => {
|
||||
// arrange
|
||||
const expectedIconName: IconName = 'magnifying-glass';
|
||||
const expectedIconContent = '<svg id="expected-svg" />';
|
||||
const svgLoaderStub = new UseSvgLoaderStub();
|
||||
svgLoaderStub.withSvgIcon(expectedIconName, expectedIconContent);
|
||||
|
||||
// act
|
||||
const wrapper = mountComponent({
|
||||
iconPropValue: expectedIconName,
|
||||
loader: svgLoaderStub,
|
||||
});
|
||||
await nextTick();
|
||||
|
||||
// assert
|
||||
const actualSvg = extractAndNormalizeSvg(wrapper.html());
|
||||
const expectedSvg = extractAndNormalizeSvg(expectedIconContent);
|
||||
expect(actualSvg).to.equal(
|
||||
expectedSvg,
|
||||
`Expected:\n\n${expectedSvg}\n\nActual:\n\n${actualSvg}`,
|
||||
);
|
||||
});
|
||||
it('updates the SVG content when the icon prop changes', async () => {
|
||||
// arrange
|
||||
const initialIconName: IconName = 'magnifying-glass';
|
||||
const updatedIconName: IconName = 'copy';
|
||||
const updatedIconContent = '<svg id="updated-svg" />';
|
||||
const svgLoaderStub = new UseSvgLoaderStub();
|
||||
svgLoaderStub.withSvgIcon(initialIconName, '<svg id="initial-svg" />');
|
||||
svgLoaderStub.withSvgIcon(updatedIconName, updatedIconContent);
|
||||
|
||||
// act
|
||||
const wrapper = mountComponent({
|
||||
iconPropValue: initialIconName,
|
||||
loader: svgLoaderStub,
|
||||
});
|
||||
await wrapper.setProps({ icon: updatedIconName });
|
||||
await nextTick();
|
||||
|
||||
// assert
|
||||
const actualSvg = extractAndNormalizeSvg(wrapper.html());
|
||||
const expectedSvg = extractAndNormalizeSvg(updatedIconContent);
|
||||
expect(actualSvg).to.equal(
|
||||
expectedSvg,
|
||||
`Expected:\n\n${expectedSvg}\n\nActual:\n\n${actualSvg}`,
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
function mountComponent(options: {
|
||||
readonly iconPropValue: IconName,
|
||||
readonly loader: UseSvgLoaderStub,
|
||||
}) {
|
||||
return shallowMount(AppIcon, {
|
||||
propsData: {
|
||||
icon: options.iconPropValue,
|
||||
},
|
||||
provide: {
|
||||
useSvgLoaderHook: options.loader.get(),
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
function extractAndNormalizeSvg(svgString: string): string {
|
||||
const svg = extractSvg(svgString);
|
||||
return normalizeSvg(svg);
|
||||
}
|
||||
|
||||
function extractSvg(svgString: string): string {
|
||||
const svgMatches = svgString.match(/<svg[\s\S]*?(<\/svg>|\/>)/g);
|
||||
if (!svgMatches || svgMatches.length === 0) {
|
||||
throw new Error(`No SVG found in: ${svgString}`);
|
||||
}
|
||||
if (svgMatches.length > 1) {
|
||||
throw new Error(`Multiple SVGs found in: ${svgString}`);
|
||||
}
|
||||
const svgContent = svgMatches[0];
|
||||
return svgContent;
|
||||
}
|
||||
|
||||
function normalizeSvg(svgString: string): string {
|
||||
return svgString
|
||||
.replace(/\n/g, '') // Remove newlines
|
||||
.replace(/\s+/g, ' ') // Replace all whitespace sequences with a single space
|
||||
.replace(/> </g, '><') // Remove spaces between tags
|
||||
.replace(/ <\//g, '</') // Remove spaces before closing tags
|
||||
.replace(/\s+\/>/g, '/>') // Remove spaces before self-closing tag end
|
||||
.replace(/<(\w+)([^>]*)><\/\1>/g, '<$1$2/>') // Convert to self-closing SVG tags
|
||||
.trim(); // Remove leading and trailing spaces
|
||||
}
|
||||
Reference in New Issue
Block a user