Skip to content

Latest commit

 

History

History
86 lines (54 loc) · 1.54 KB

README.md

File metadata and controls

86 lines (54 loc) · 1.54 KB

svelte-bootstrap-icons

NPM

Bootstrap SVG icons as Svelte components with zero dependencies.

This package uses svelvg to convert source SVG files into Svelte components.

Try it in the Svelte REPL.


Installation

# NPM
npm i svelte-bootstrap-icons

# pnpm
pnpm i svelte-bootstrap-icons

# Bun
bun add svelte-bootstrap-icons

# Yarn
yarn add svelte-bootstrap-icons

Usage

See ICON_INDEX.md for a list of supported icons.

Base import

<script>
  import { Alarm, Bank, CloudMoon } from "svelte-bootstrap-icons";
</script>

<Alarm />
<Bank />
<CloudMoon />

Direct import (recommended)

Import the icon directly for faster compiling during development.

<script>
  import Alarm from "svelte-bootstrap-icons/lib/Alarm.svelte";
</script>

Custom size

$$restProps are forwarded to the svg element.

Use the width and height attributes to customize the icon size. The default is 16px.

<Alarm width={24} height={24} />

Custom color

Use the fill attribute to specify a custom color.

<Alarm fill="red" />

Changelog

Changelog

Contributing

See the contributing guidelines.

License

MIT