Commit 6842a489 authored by Robert Knight's avatar Robert Knight

Convert `<svg-icon>` component to React

parent 05f003d3
'use strict'; 'use strict';
/** const { createElement } = require('preact');
* The <svg-icon> component renders SVG icons using inline <svg> tags, const propTypes = require('prop-types');
* enabling their appearance to be customized via CSS.
*
* This matches the way we do icons on the website, see
* https://github.com/hypothesis/h/pull/3675
*/
// The list of supported icons // The list of supported icons
const icons = { const icons = {
...@@ -14,21 +9,24 @@ const icons = { ...@@ -14,21 +9,24 @@ const icons = {
cursor: require('../../images/icons/cursor.svg'), cursor: require('../../images/icons/cursor.svg'),
}; };
// @ngInject /**
function SvgIconController($element) { * Component that renders icons using inline `<svg>` elements.
this.$onInit = () => { * This enables their appearance to be customized via CSS.
if (!icons[this.name]) { *
throw new Error('Unknown icon: ' + this.name); * This matches the way we do icons on the website, see
* https://github.com/hypothesis/h/pull/3675
*/
function SvgIcon({ name }) {
if (!icons[name]) {
throw new Error(`Unknown icon ${name}`);
} }
$element[0].innerHTML = icons[this.name]; const markup = { __html: icons[name] };
}; return <span dangerouslySetInnerHTML={markup} />;
} }
module.exports = { SvgIcon.propTypes = {
controllerAs: 'vm',
controller: SvgIconController,
bindings: {
/** The name of the icon to load. */ /** The name of the icon to load. */
name: '<', name: propTypes.string,
},
}; };
module.exports = SvgIcon;
'use strict'; 'use strict';
const angular = require('angular'); const { createElement, render } = require('preact');
const util = require('../../directive/test/util'); const SvgIcon = require('../svg-icon');
describe('svgIcon', function() { describe('SvgIcon', () => {
before(function() { it("sets the element's content to the content of the SVG", () => {
angular.module('app', []).component('svgIcon', require('../svg-icon')); const container = document.createElement('div');
render(<SvgIcon name="refresh" />, container);
assert.ok(container.querySelector('svg'));
}); });
beforeEach(function() { it('throws an error if the icon is unknown', () => {
angular.mock.module('app'); assert.throws(() => {
}); const container = document.createElement('div');
render(<SvgIcon name="unknown" />, container);
it("sets the element's content to the content of the SVG", function() {
const el = util.createDirective(document, 'svgIcon', { name: 'refresh' });
assert.ok(el[0].querySelector('svg'));
});
it('throws an error if the icon is unknown', function() {
assert.throws(function() {
util.createDirective(document, 'svgIcon', { name: 'unknown' });
}); });
}); });
}); });
...@@ -184,7 +184,7 @@ function startAngularApp(config) { ...@@ -184,7 +184,7 @@ function startAngularApp(config) {
.component('sortDropdown', require('./components/sort-dropdown')) .component('sortDropdown', require('./components/sort-dropdown'))
.component('spinner', require('./components/spinner')) .component('spinner', require('./components/spinner'))
.component('streamContent', require('./components/stream-content')) .component('streamContent', require('./components/stream-content'))
.component('svgIcon', require('./components/svg-icon')) .component('svgIcon', wrapReactComponent(require('./components/svg-icon')))
.component('tagEditor', require('./components/tag-editor')) .component('tagEditor', require('./components/tag-editor'))
.component('threadList', require('./components/thread-list')) .component('threadList', require('./components/thread-list'))
.component('timestamp', require('./components/timestamp')) .component('timestamp', require('./components/timestamp'))
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment