Skip to content

README.md

Latest commit

 

History

History
46 lines (29 loc) · 965 Bytes

README.md

File metadata and controls

46 lines (29 loc) · 965 Bytes

Bootstrap Icons React Component

This package contains a simple React Component, which implements the latest version of Bootstrap Icons into React.

Install

To add the package to your existing React project just type in one of the following commands:

npm i @reacticons/bootstrap-icons

or

yarn add @reacticons/bootstrap-icons

Usage

import React from 'react';
import Icon from '@reacticons/bootstrap-icons';

export const Component = () => (
  <>
    <Icon name="award" />
  </>
);

Supported Icons

This package supports all Bootstrap Icons of the matching version. To see a full list of them, you can take a look at the official Bootstrap Icons website.

Hint

By the way, the <Icon> Component has the same attributes as a typical <div> element.

License

MIT

This package is based on the open source Bootstrap Icons project.