logo polydile dile-components

dile-icon

Web Component to create a container to display an icon.

Installation

npm i @dile/dile-icon

Usage

Import the component.

import '@dile/dile-icon/dile-icon.js';

You need to provide the icon in a icon property.

<dile-icon .icon="${appsIcon}"></dile-icon>

Usualy the provided icon will be a lit-html template.

const appsIcon = html`<svg class="dile-icon" xmlns="http://www.w3.org/2000/svg" height="24px" viewBox="0 0 24 24" width="24px" fill="#000000"><path d="M0 0h24v24H0z" fill="none"/><path d="M4 8h4V4H4v4zm6 12h4v-4h-4v4zm-6 0h4v-4H4v4zm0-6h4v-4H4v4zm6 0h4v-4h-4v4zm6-10v4h4V4h-4zm-6 4h4V4h-4v4zm6 6h4v-4h-4v4zm0 6h4v-4h-4v4z"/></svg>`;

There are some icons in the @dile/icons package. So, you can use them easily in your components.

import { closeIcon } from '@dile/icons';

// Late, in render method
html`<dile-icon .icon="${closeIcon}"></dile-icon>`

Also is possible to use any image or SVG you have.

html`<dile-icon .icon=${html`<img src="./images/loto.png">`}></dile-icon>`

Properties

CSS Custom Properties

You can customize it using CSS Custom Properties.

Custom propertyDescriptionDefault
--dile-icon-sizeIcon size24px
--dile-icon-colorIcon color#888
--dile-icon-rounded-background-colorBackground color when rounded#eee

dile-icon demos

Icons demo

import { appsIcon } from "../../../packages/icons/index.js";
import { descriptionIcon } from "../../../packages/icons/index.js";
import { starIcon } from "../../../packages/icons/index.js";

class MyComponent extends LitElement {
  static get styles() {
    return css`
      :host {
        display: flex;
        align-items: center;
      }
    `
  }

  render() {
    return html`
      <dile-icon class="apps" .icon=${this.appsIcon}></dile-icon>
      <dile-icon class="description" .icon=${this.descriptionIcon}></dile-icon>
      <dile-icon class="star" .icon=${this.starIcon}></dile-icon>
    `
  }

  firstUpdated() {
    // This should not be necessary but the component to show the demo does not work well with interpoplation of strings
    this.shadowRoot.querySelector('dile-icon.apps').icon = appsIcon;
    this.shadowRoot.querySelector('dile-icon.description').icon = descriptionIcon;
    this.shadowRoot.querySelector('dile-icon.star').icon = starIcon;
  }
}
customElements.define('my-component', MyComponent);
export const JsStory = () => html`<my-component></my-component>`;

Styled icons

import { homeIcon } from "../../../packages/icons/index.js";
import { helpIcon } from "../../../packages/icons/index.js";
import { receiptIcon } from "../../../packages/icons/index.js";

class OtherComponent extends LitElement {
  static get styles() {
    return css`
      :host {
        display: flex;
        align-items: center;
        column-gap: 0.5rem;
      }
      .styled {
        --dile-icon-color: red;
        --dile-icon-size: 32px;
      }
      .styled2 {
        --dile-icon-color: #990099;
        --dile-icon-size: 18px;
      }
      .styled3 {
        --dile-icon-color: blue;
        --dile-icon-size: 40px;
      }
    `
  }

  render() {
    return html`
      <dile-icon id="icon1" class="styled">Polydile</dile-icon>
      <dile-icon id="icon2" class="styled2">Polydile</dile-icon>
      <dile-icon id="icon3" class="styled3">Polydile</dile-icon>
    `
  }

  firstUpdated() {
    // This should not be necessary but the component to show the demo does not work well with interpoplation of strings
    this.shadowRoot.querySelector('#icon1').icon = homeIcon;
    this.shadowRoot.querySelector('#icon2').icon = helpIcon;
    this.shadowRoot.querySelector('#icon3').icon = receiptIcon;
  }
}
customElements.define('other-component', OtherComponent);
export const Js2Story = () => html`<other-component></other-component>`;