https://github.com/ableco/baseline-icons

Baseline Icon Collection
https://github.com/ableco/baseline-icons

Last synced: 3 months ago
JSON representation

Baseline Icon Collection

• Host: GitHub
• URL: https://github.com/ableco/baseline-icons
• Owner: ableco
• License: mit
• Created: 2020-03-26T00:39:13.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T17:13:17.000Z (over 3 years ago)
• Last Synced: 2025-04-30T13:15:12.581Z (about 1 year ago)
• Language: TypeScript
• Homepage: https://baseline.able.co/docs/foundations/icons
• Size: 941 KB
• Stars: 3
• Watchers: 51
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Baseline Icons

[![CI Workflow](https://github.com/ableco/baseline-icons/workflows/CI/badge.svg)](https://github.com/ableco/baseline-icons/actions?workflow=CI)

[![Release Workflow](https://github.com/ableco/baseline-icons/workflows/Release/badge.svg)](https://github.com/ableco/baseline-icons/actions?workflow=Release)

[![Maintainability](https://api.codeclimate.com/v1/badges/dc8ca837f0443633fda0/maintainability)](https://codeclimate.com/repos/5d965fea478d1f6328000720/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/dc8ca837f0443633fda0/test_coverage)](https://codeclimate.com/repos/5d965fea478d1f6328000720/test_coverage)

![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=ableco/baseline-icons&identifier=211389596)

## How to Use

Configure yarn to use Able's registry.

```bash

yarn config set registry https://registry.able.co

```

> For npm or pnpm check more at https://registry.able.co.

Once you have done that install it as a normal npm package.

```bash

yarn add @baseline/icons

# npm i @baseline/icons

```

Once it's installed in your project import the icon you want to use.

```tsx

import { Lock } from "@baseline/icons";

```

And render it as a normal React component.

```tsx

```

All icons receive a single `className` prop which could be:

- A string of classes separated by spaces

- An object with the classes as keys and a boolean as value, falsy keys will not be added.

## Development Setup

1. Clone the repository.

2. Install the dependencies using `yarn install` command, or just `yarn`.

3. Add the new icon in `src/index.tsx`, remember to test everything.

4. When you are done, run the tests using the `yarn test` command.