1.1.0 • Published 4 years ago
@api-modeling/modeling-icons v1.1.0
api-icons
A set of icons for the API modeling initiative applications.
Installation
npm i -S @api-modeling/modeling-icons
Usage
In an html file
<script type="module">
import '@api-modeling/modeling-icons/modeling-icon.js';
</script>
<modeling-icon icon="add"></modeling-icon>
In a LitElement
import { LitElement, html, svg } from 'lit-element';
import '@api-modeling/modeling-icons/modeling-icon.js';
import * as Icons from '@api-modeling/modeling-icons';
class SampleElement extends LitElement {
render() {
return html`
<!-- using an icon property -->
<modeling-icon icon="add"></modeling-icon>
<!-- passing an icon template as a child-->
<modeling-icon>${Icons.add}</modeling-icon>
<!-- using own container-->
<span class="icon">${Icons.add}</span>
<!-- using custom icon -->
<modeling-icon>${Icons.iconWrapper(svg`...`)}</modeling-icon>
`;
}
}
customElements.define('sample-element', SampleElement);
Development
git clone https://github.com/api-modeling/modeling-icons
cd modeling-icons
npm install
Running the demo locally
npm start
Running the tests
npm test