<commit_before># Icon Component Template

An element is made into an icon by adding either the `c-icon` class, and/or
adding the `data-icon-name` attribute with an existing value from the
`$icon-list` map.

Optionally, you can set any icon to replace any text by adding the `c-icon--replace`
class, or by setting the attribute `data-icon-replace` to true
<commit_msg>Fix icon readme to match the new readme template<commit_after># Icon Component

Icons are font-based symbols with a wide array of meaning and utility. They can be used to convey directions, importance, social media, interface elements, and more.


## Installation

Refer to the main [installation instructions for Stencil](https://github.com/mobify/stencil#installation).

Use the following to import the Icon Component into your project with Sass:

```
@import '../bower_components/stencil/dist/components/icon';
```


## Using the Icon Component

An element is made into an icon by adding either the `c-icon` class, and/or adding the `data-icon-name` attribute with an existing value from the `$icon-list` map.

Optionally, you can set any icon to replace any text by adding the `c-icon--replace` class, or by setting the attribute `data-icon-replace` to true


### Markup

```
<span class="c-icon" data-icon-name="hamburger"></span>
```

Or, optionally...

```
<span class="c-icon c--replace" data-icon-name="hamburger">Menu</span>
```


## Demo

Example of the [Icon Component](https://mobify.github.io/stencil/visual/components/icon/index.html)

{'fraction_non_alphanumeric': 0.10876730388925511, 'fraction_numerical': 0.0, 'mean_word_length': 4.52, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1758662', 'n_tokens_mistral': 450, 'n_tokens_neox': 435, 'n_words': 183}