@infrasym/laravel-favicon-vite-plugin

v1.0.3

Published

2 years ago

A simple favicon generator for Laravel projects using Vite 3+.

Downloads

282

0High
0Medium
0Low

devjmd

vite-plugin blade laravel favicon icons generator

Laravel Vite Favicon Plugin

A basic plugin to generate favicons and Blade template for your Laravel Vite application.

This will do two things:

Generate favicons for your application.
1. By default, the favicons will be generated in the public/favicons folder.
Generate a Blade template for your application.
1. By default, the Blade template will be generated in the resources/views/includes/favicons.blade.php file.

Installation

Install with NPM:

npm i @infrasym/laravel-favicon-vite-plugin -D

Yarn:

yarn add @infrasym/laravel-favicon-vite-plugin -D

PNPM:

pnpm i @infrasym/laravel-favicon-vite-plugin -D

Usage

Import the plugin to your vite.config.js file:

import favicons from '@infrasym/laravel-favicon-vite-plugin';

Add the plugin to your vite.config.js file:

export default defineConfig({
    plugins: [
        /**
         * Laravel Vite Favicon Plugin
         * 
         * [1] Path to your base favicon image.
         * [2] Configuration options for the favicons plugin.
         */
        favicons('/resources/images/favicons/favicon.png' /** [1] */, {
            /** [2] */
            favicon: {
                // Path to the favicon image in the `public` folder.
                path: '/favicons/',
                // Your application name.
                appName: 'Laravel Vite',
                // Your application short name.
                appShortName: 'Laravel Vite',
                // Your application description.
                appDescription: 'This is a Laravel Vite project',
                // Your application author.
                developerName: 'Laravel Vite',
                // Your application Start URL.
                start_url: '/',
                // Your application theme color.
                theme_color: '#1a1065',
                // Your application background color.
                background_color: '#1a1065',
                // Your application background color.
                background: '#1a1065',
            }
        })
    ],
});

Favicon Configuration

The plugin is based on the favicons package. The options.favicon object accepts all the options that the favicons package accepts.

You can find the full list of parameters here.

Blade Template

The Blade template will be generated in the resources/views/includes/favicons.blade.php file. You can now use this like so:

<head>
    @include('includes.favicons')
</head>

And that's it! You can now run npm run dev or npm run build to generate the favicons and Blade template.

License

MIT License. See LICENSE file.

Roadmap

[x] Generate favicons.
[x] Generate Blade template.
[ ] Add support for custom Blade template and folder.
[ ] Add support for custom favicons folder.
[ ] Clean up the configuration options.
[ ] Better testing scalability.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.

To set up the project, run the following commands:

git clone https://github.com/Infrasym/laravel-favicon-vite-plugin.git
cd laravel-favicon-vite-plugin
npm install
npm run husky
npm run build

Now use the build directory as your local package.

Bugs and Issues

If you encounter any bugs or issues, please open an issue.

Release History

1.0.0
- Initial release.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme