ryangjchandler/laravel-bunny-fonts

Manage Bunny Fonts programatically in your Laravel projects.

v1.0.0 2024-05-02 16:39 UTC

This package is auto-updated.

Last update: 2024-10-08 13:28:08 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

This package provides a small set of utilities for managing Bunny Fonts programatically.

Installation

You can install the package via Composer:

composer require ryangjchandler/laravel-bunny-fonts

Usage

Inside of your AppServiceProvider::boot() method, use the BunnyFonts class to register font families and variants.

use RyanChandler\BunnyFonts\Facades\BunnyFonts;
use RyanChandler\BunnyFonts\FontFamily;

public function boot()
{
    BunnyFonts::add(FontFamily::AbhayaLibre, weights: [400, 500, 600])
        ->add(FontFamily::FiraCode, weights: [
            400
        ]);
}

This package provides a FontFamily enum that contains all fonts available on Bunny!

If you want to preview a font, click through to the enum and use the handy link in the comment above the case.

Inside of your Blade templates, use the <x-bunny-fonts /> component or @bunnyFonts() directive to render the necessary HTML tags and load your fonts.

Sets

Out of the box this package provides a default set of fonts. Calling add() directly on the BunnyFonts class will register fonts under the default set.

If your site uses different fonts in different places, it's still possible to register them using this package by creating a custom "set".

public function boot()
{
    BunnyFonts::set('shop')
        ->add(FontFamily::Inter, [400, 500, 700]);
}

Then when you use the Blade component or directive, you can provide the set you wish to render.

<x-bunny-fonts set="shop" />
<!-- or... -->
@bunnyFonts('shop')

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.