# feather-marko

> Integrate Feather icons with MarkoJS.

Latest version **0.0.4** (published 2021-12-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install feather-marko
pnpm add feather-marko
yarn add feather-marko
bun add feather-marko
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2021-12-10 |
| First published | 2021-05-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 12.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Hunter Stratton |
| Maintainers | paradxil |
| Keywords | feather, icons, marko, markojs, components, marko-components |

## Links

- npm: https://www.npmjs.com/package/feather-marko
- Repository: https://github.com/Paradxil/feather-marko
- Homepage: https://github.com/Paradxil/feather-marko#readme
- Issues: https://github.com/Paradxil/feather-marko/issues
- npm.io page: https://npm.io/package/feather-marko

## Dependencies (2)

- [marko](https://npm.io/package/marko.md) ^5.10.2
- [feather-icons](https://npm.io/package/feather-icons.md) ^4.28.0

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 0.0.4 (latest) — 2021-12-10
- 0.0.3 — 2021-05-14
- 0.0.2 — 2021-05-14
- 0.0.1 — 2021-05-14

## README

# feather-marko
feather-marko provides a simple MarkoJS component to use Feather icons.

## Getting Started
Installation
```
npm i feather-marko
```
Demo
```
npm run demo
```

## Usage

### Component
Only one component is provided:
```
feather-icon
```
Drop the `feather-icon` tag into your Marko templates wherever you want to display an icon.

### Attributes
You can modify the look of the icon with the following attributes:

Attribute | Description | Examples
------------ | ------------- | -----------
icon | Set the icon. See the demo or Feather for a list of icons. | edit, image, chevron-up
color | Set the color. Default behavior also changes stroke color. | #444, red
stroke | Set the stroke color. Defaults to 'currentColor' so the stroke matches the color. | currentColor, green
fill | Set the fill color. | none, #fff, blue
size | Set the icon size. | 24px, 1em, 100%
strokewidth | Set the stroke width. | 2px, 1.5px
strokelinecap | Set the linecap type. | round, square, butt
strokelinejoin | Set the linejoin type. | round, bevel, miter

### Example
![Edit Icon Orange](./assets/edit-example.png)
```marko
feather-icon icon='edit' color='orange' size='48px'
```

### Defaults
You can use CSS variables to change the default icon attributes. Setting an attribute on an icon directly wil override the defaults.

```css
.feather-icon-svg {
        --feather-icon-color: inherit;
        --feather-icon-stroke: currentColor;
        --feather-icon-size: 1em;
        --feather-icon-fill: none;
        --feather-icon-stroke-width: 2px;
        --feather-icon-linecap: round;
        --feather-icon-linejoin: round;
}
```
You can also define the variables in `:root` if you add `!important`.

## License
MIT

## Author
Hunter Stratton

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