README

Basic Bladeicon wrapper package to allow access to Tallboy icons.

For a full list of available icons see the SVG directory.

The icons in this package are a very small set of icons for use as default icons for the Tallboy package. There is almost no reason that you would need (or want) to use this package outside of that context. In fact there's a very good chance that you don't want to use these icons within that context.

They are not very good icons.

Installation

composer require samlev/tallboicons

Usage

Icons can be used as a self-closing Blade component or with the @svg() helper, which will rendered an inline SVG:

<x-tallboicon-alert />
@svg('tallboicon-edit')

View the blade icons usage documentation for more information.

Raw SVG icons

If you want to use the raw SVG icons as assets, you can publish them using:

php artisan vendor:publish --tag=blade-tallboicons --force

Contributing

There is almost no chance that you will need to contribute to this package, but if you do, please feel free to open a PR. Please don't request additional icons unless it is in aid of adding a component to the Tallboy package. Even then, please evaluate if this package actually needs a new icon or not.

Testing

You can test any modifications to this package with:

composer test

You can attempt to automatically fix any linting errors with:

composer lint:fix