Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davide-casiraghi/bootstrap-accordion-integrator
Add accordions in your PHP / Laravel application. The accordions are based on the Bootstrap 4 collapse component.
https://github.com/davide-casiraghi/bootstrap-accordion-integrator
accordion accordion-plugin laravel laravel-5-package php
Last synced: 14 days ago
JSON representation
Add accordions in your PHP / Laravel application. The accordions are based on the Bootstrap 4 collapse component.
- Host: GitHub
- URL: https://github.com/davide-casiraghi/bootstrap-accordion-integrator
- Owner: davide-casiraghi
- License: mit
- Created: 2019-03-12T11:32:28.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-07-08T08:54:47.000Z (over 5 years ago)
- Last Synced: 2024-11-06T21:16:47.068Z (2 months ago)
- Topics: accordion, accordion-plugin, laravel, laravel-5-package, php
- Language: CSS
- Homepage:
- Size: 247 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Bootstrap 4 Accordion Integrator
[](https://packagist.org/packages/davide-casiraghi/bootstrap-accordion-integrator)
[](https://styleci.io/repos/175197548)
[](https://scrutinizer-ci.com/g/davide-casiraghi/bootstrap-accordion-integrator/)
[](https://github.com/davide-casiraghi/bootstrap-accordion-integrator)
**Bootstrap 4 Accordion Integrator** is a PHP library to add accordions in your application.
The accordions are based on the Bootstrap 4 **collapse component**.
The library replace all the occurances of this snippet
```
{accordion=Title First Slide}This is the first slide. {/accordion}
```
With the HTML code of a bootstrap 4 accordion.
```html
Title First Slide
This is the first slide.
```
## Installation
To use the package you should import it trough composer.
```bash
composer require davide-casiraghi/bootstrap-accordion-integrator
```
### Import the scss files
Add this line to your **resources/sass/app.scss** file:
```@import 'vendor/bootstrap-accordion-integrator/accordion';```
and then run in console:
```npm run dev```
## Usage
To replace all the occurrance of the accordion snippets:
```php
$accordion = new BootstrapAccordion('caret-svg');
$accordion->replace_accordion_strings_with_template($text);
```
or using the facade
```php
$text = BootstrapAccordion::getAccordions($text, 'plus-minus-circle');
```
## Icon styles (open/close)
At the moment are available these icon styles that can be specified when the class get instantiated
- **caret-svg** (default - use svg with mask-image)
- **angle-svg** (use svg with mask-image)
- **plus-minus-circle** (use default font)
- **angle-fontawesome-pro** (use Font Awesome Pro 5 font-family)
- **angle-fontawesome-free** (use Font Awesome Free 4.7.0 font-family)
- **caret-fontawesome-pro** (use Font Awesome Pro 5 font-family)
- **caret-fontawesome-free** (use Font Awesome Free 4.7.0 font-family)
To use FontAwesome styles you need FontAwesome already loaded in your application.
## Load the CSS and JS files
### Without Laravel
You can import the JS and the CSS files in the vendor/bootstrap-accordion/ folder.
### With Laravel
#### Publish the JS, CSS and IMAGES
It's possible to customize the scss and the js publishing them in your Laravel application.
```php artisan vendor:publish```
This command will publish in your application this folders:
- /resources/scss/vendor/bootstrap-accordion/
- /resources/js/vendor/bootstrap-accordion/
- /public/vendor/bootstrap-accordion-integrator/images/
#### Load the JS file
In your app.js file you can require the accordion.js file before the Vue object get instanciated:
```
require('./bootstrap');
window.Vue = require('vue');
require('./vendor/bootstrap-accordion/accordion');
window.myApp = new Vue({
el: '#app'
});
```
## 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.
## License
[MIT](https://github.com/davide-casiraghi/bootstrap-accordion-integrator/blob/master/LICENSE.md)