Skip to content

Latest commit

 

History

History
110 lines (73 loc) · 2.62 KB

README.md

File metadata and controls

110 lines (73 loc) · 2.62 KB
Raw

Omnia Library

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

Offer a bunch of components for modern web.

Installation

You can install the package via composer:

composer require omnia-digital/library

Publish the package scripts:

php artisan vendor:publish --tag="library-assets"

Include the assets

<html>
<head>
    ...
    @libraryStyles
</head>
<body>
    ...
    @libraryScripts
</body>
</html>

Config Tailwind CSS for all components in tailwind.config.js:

module.exports = {
    content: [
        ...
        './vendor/omnia-digital/library/resources/views/**/*.blade.php',
    ]
};

Optional Steps

Config File + Component Views

You can publish the config file with:

php artisan vendor:publish --tag="library-config"

Optionally, you can publish the views using

php artisan vendor:publish --tag="library-views"

Alpine.js Plugins

This package uses focus and collapse plugins for improving UI/UX. Consider adding it in your resources/js/app.js:

import Alpine from 'alpinejs';
import focus from '@alpinejs/focus';
import collapse from '@alpinejs/collapse';

Alpine.plugin(focus)
Alpine.plugin(collapse)

window.Alpine = Alpine;

Alpine.start();

Usage

...

Media Manager

To use the Media Manager component, you need to install this package first: https://github.com/omnia-digital/media-manager

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.