https://github.com/omnia-digital/library
https://github.com/omnia-digital/library
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/omnia-digital/library
- Owner: omnia-digital
- License: other
- Created: 2022-02-24T07:03:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-18T03:04:14.000Z (4 months ago)
- Last Synced: 2025-04-11T04:06:35.480Z (2 months ago)
- Language: Blade
- Size: 3.07 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Omnia Library
[](https://packagist.org/packages/omnia-digital/library)
[](https://github.com/omnia-digital/library/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/omnia-digital/library/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
[](https://packagist.org/packages/omnia-digital/library)
Offer a bunch of components for modern web.
## Installation
You can install the package via composer:
```bash
composer require omnia-digital/library
```
Publish the package scripts:
```bash
php artisan vendor:publish --tag="library-assets"
```
Include the assets
```html
...
@libraryStyles
...
@libraryScripts
```
Config Tailwind CSS for all components in `tailwind.config.js`:
```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:
```bash
php artisan vendor:publish --tag="library-config"
```
Optionally, you can publish the views using
```bash
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`:
```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](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Omnia](https://github.com/omnia-digital)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.