astro-feather-icons2
v1.0.0
Published
Feather icons for Astro (based on svelte-feather-icons by dylanblokhuis)
Downloads
29
Maintainers
Readme
Astro Feather Icons2
This is a fork of astro-feather-icons. Edaz seems won't come back to Github, so I continue his project. This fork is fixing the error Typescripts.
Feather is a collection of simply beautiful open source icons. Each icon is designed on a 24x24 grid with an emphasis on simplicity, consistency, and flexibility.
npm install astro-feather-icons2
Usage
All of the icons are available from a single import.
---
import { AirPlay, AtSign, Zap } from 'astro-feather-icons2'
---
<AirPlay />
<AtSign />
<Zap size="60" fill="gold" />
When importing all of the icons, only the ones that get used will be added to the page
---
import * as Icon from 'astro-feather-icons2'
---
<Icon.AirPlay />
<Icon.AtSign />
<Icon.Zap size="60" fill="gold" />
The icons are also available as individual imports.
---
import AirPlayIcon from 'astro-feather-icons2/AirPlay'
import AtSignIcon from 'astro-feather-icons2/AtSign'
import ZapIcon from 'astro-feather-icons2/Zap'
---
<AirPlayIcon />
<AtSignIcon />
<ZapIcon size="60" fill="gold" />
Prop Types
The following Props
interface is available to every icon:
export interface Props {
'fill'?: string;
'fill-opacity'?: number | string;
'fill-rule'?: "nonzero" | "evenodd" | "inherit";
'height'?: number | string;
'size'?: number | string;
'stroke'?: string;
'stroke-dasharray'?: string | number;
'stroke-dashoffset'?: string | number;
'stroke-linecap'?: "butt" | "round" | "square" | "inherit";
'stroke-linejoin'?: "miter" | "round" | "bevel" | "inherit";
'stroke-miterlimit'?: number | string;
'stroke-opacity'?: number | string;
'stroke-width'?: number | string;
'viewBox'?: string;
'width'?: number | string;
}
- The
Props
interface additionally includes:- All HTML global attributes.
- All WAI-ARIA attributes and the WAI-ARIA role attribute.
- The
title
attribute transforms into a<title>
element within the<svg>
. - The
size
attribute transforms values like1.5x
into1.5em
. - The
size
attribute is used as the default values forwidth
andheight
.
Acknowledgements
This package is maintained by aalfiann and based on svelte-feather-icons by dylanblokhuis.
Licensed under the MIT License. Feather Icons & Feather name Copyright © 2013–present Cole Bemis.