@nomensa/pfe-icon

Icon element for PatternFly Elements

Usage no npm install needed!

<script type="module">
  import nomensaPfeIcon from 'https://cdn.skypack.dev/@nomensa/pfe-icon';
</script>

README

WIP 🐣: PFElements Icon Element

Usage

<pfe-icon icon="pfe-icon-server"></pfe-icon>

Attributes

icon (observed)

The name of the icon that you want to use. If the value of this attribute changes, the new icon will show up in the UI.

data-size

Controls the size of the icon. The options for size are:

  • 2x
  • 3x
  • 4x
  • small
  • medium
  • large
<pfe-icon icon="pfe-icon-server" data-size="2x"></pfe-icon>

data-block

By default, pfe-icon is set to display: inline-block. The data-block attribute sets this element to display: block.

<pfe-icon icon="pfe-icon-server" data-block></pfe-icon>

data-bg

Sets the border radius of the element to a circle (border-radius: 50%).

<pfe-icon icon="pfe-icon-server" data-bg></pfe-icon>

Another option for data-bg is to set the attribute equal to transparent. This makes the background transparent.

<pfe-icon icon="pfe-icon-server" data-bg="transparent"></pfe-icon>

Test

npm run test

Build

npm run build

Demo

From the PFElements root directory, run:

npm start

Code style

Icon (and all PFElements) use Prettier to auto-format JS and JSON. The style rules get applied when you commit a change. If you choose to, you can integrate your editor with Prettier to have the style rules applied on every save.