shoelace/docs/components/icon-button.md

1.4 KiB

Icon Button

[component-header:sl-icon-button]

Icons buttons are simple, icon-only buttons that can be used for actions and in toolbars.

For a full list of icons that come bundled with Shoelace, refer to the icon component.

<sl-icon-button name="gear"></sl-icon-button>
<sl-icon-button name="sliders"></sl-icon-button>
<sl-icon-button name="x"></sl-icon-button>

Examples

Sizes

Icon buttons inherit their parent element's font-size.

<sl-icon-button name="pencil" style="font-size: 1.5rem;"></sl-icon-button>
<sl-icon-button name="pencil" style="font-size: 2rem;"></sl-icon-button>
<sl-icon-button name="pencil" style="font-size: 2.5rem;"></sl-icon-button>

Colors

You can customize icon button's color by styling its base part.

<sl-icon-button name="x-circle-fill" class="icon-button-colors"></sl-icon-button>

<style>
  .icon-button-colors::part(base) {
    color: tomato;
  }

  .icon-button-colors::part(base):hover {
    color: #e64a2e;
  }
</style>

Icon Button with Tooltip

Wrap a tooltip around an icon button to provide contextual information to the user.

<sl-tooltip content="Settings">
  <sl-icon-button name="gear"></sl-icon-button>
</sl-tooltip>

Disabled

<sl-icon-button name="gear" disabled></sl-icon-button>

[component-metadata:sl-icon-button]