# clay-icon

> Clay Icon Component

Latest version **2.24.1** (published 2022-05-30) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install clay-icon
pnpm add clay-icon
yarn add clay-icon
bun add clay-icon
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.24.1 |
| Published | 2022-05-30 |
| First published | 2017-09-29 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.12.0 |
| Dependencies | 5 |
| Unpacked size | 34.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 244 |
| Maintainers | tinycarol, edalgrin, pat270, liferay, bryceosterhaus, carloslancha, diegonvs, matuzalemteles, izaera, gagranta, p2kmgcl, marko.cikos, kresimircoko, jbalsas |
| Keywords | clay, metal |

## Links

- npm: https://www.npmjs.com/package/clay-icon
- Repository: https://github.com/liferay/clay.git#master
- Homepage: https://github.com/liferay/clay/tree/master#readme
- Issues: https://github.com/liferay/clay/issues
- npm.io page: https://npm.io/package/clay-icon

## Dependencies (5)

- [metal-soy](https://npm.io/package/metal-soy.md) ^2.16.0
- [metal-state](https://npm.io/package/metal-state.md) ^2.16.0
- [clay-component](https://npm.io/package/clay-component.md) ^2.24.1
- [metal-component](https://npm.io/package/metal-component.md) ^2.16.0
- [metal-web-component](https://npm.io/package/metal-web-component.md) ^2.16.0

## Recent versions

- 2.24.1 (latest) — 2022-05-30
- 2.23.4 — 2022-02-24
- 2.23.2 — 2021-12-16
- 2.23.0 — 2021-12-14
- 2.22.4 — 2021-06-16
- 2.22.2 — 2021-02-11
- 2.22.1 — 2021-01-27
- 2.22.0 — 2020-12-09
- 2.21.4 — 2020-08-11
- 2.21.3 — 2020-05-21
- 2.21.2 — 2020-04-23
- 2.21.0 — 2020-03-20
- 2.20.2 — 2020-01-28
- 2.20.1 — 2020-01-24
- 2.20.0 — 2020-01-16
- … 77 more at https://npm.io/package/clay-icon/versions

## README

# clay-icon

A Metal Clay component for rendering SVG icons and third-party icon fonts. For third-party fonts, make sure the font file and css are included on the page.

Rendering [Clay SVG Icons](#claySvgIcons):
```javascript
new metal.ClayIcon({
	spritemap: '/path/to/the/spritemap.svg',
	symbol: 'plus'
});
```

Rendering [Clay Font Awesome Icons](#clayFontAwesomeIcons)
```javascript
new metal.ClayIcon({
	elementClasses: 'clay-fa icon-plus'
});
```

Rendering [Glyphicons](http://glyphicons.com/):
```javascript
new metal.ClayIcon({
	elementClasses: 'glyphicon glyphicon-plus'
});
```

Rendering [Font Awesome 4 Icons](http://fontawesome.io/icons/):
```javascript
new metal.ClayIcon({
	elementClasses: 'fa fa-plus'
});
```

## Setup

1. See [metal-clay-components/README.md](https://github.com/metal/metal-clay-components/blob/master/README.md)

2. Build the code:

  ```
  npm run build
  ```

3. Watch task:

  ```
  npm run watch
  ```

## Contribute

We'd love to get contributions from you! Please, check our [Contributing Guidelines](https://github.com/metal/metal-clay-components/blob/master/CONTRIBUTING.md) to see how you can help us improve.

---
_Source: https://npm.io/package/clay-icon · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._