Make replaceElement function part of the public API by emirdaponte · Pull Request #1129 · feathericons/feather · GitHub
Skip to content

Make replaceElement function part of the public API #1129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
emirdaponte wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Make replaceElement function part of the public API #1129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b3054cb
Make replaceElement function part of the public API
emirdaponte Jan 28, 2022
32ad9af
Add documentation to README for replaceElement funtion
emirdaponte Jan 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions README.md
View file
Open in desktop
3 changes: 2 additions & 1 deletion src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import icons from './icons';
import toSvg from './to-svg';
import replace from './replace';
import replaceElement from './replace-element';

module.exports = { icons, toSvg, replace };
module.exports = { icons, toSvg, replace, replaceElement };
43 changes: 43 additions & 0 deletions src/replace-element.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/* eslint-env browser */
import classnames from 'classnames/dedupe';

import icons from './icons';

/**
* Replace a single HTML element with SVG markup
* corresponding to the element's `data-feather` attribute value.
* @param {HTMLElement} element
* @param {Object} attrs
*/
function replaceElement(element, attrs = {}) {
const elementAttrs = getAttrs(element);
const name = elementAttrs['data-feather'];
delete elementAttrs['data-feather'];

const svgString = icons[name].toSvg({
...attrs,
...elementAttrs,
...{ class: classnames(attrs.class, elementAttrs.class) },
});
const svgDocument = new DOMParser().parseFromString(
svgString,
'image/svg+xml',
);
const svgElement = svgDocument.querySelector('svg');

element.parentNode.replaceChild(svgElement, element);
}

/**
* Get the attributes of an HTML element.
* @param {HTMLElement} element
* @returns {Object}
*/
function getAttrs(element) {
return Array.from(element.attributes).reduce((attrs, attr) => {
attrs[attr.name] = attr.value;
return attrs;
}, {});
}

export default replaceElement;
41 changes: 1 addition & 40 deletions src/replace.js
View file
Open in desktop