Details

  • View On packagist
  • Created by David Cap
  • Added on Aug 31, 2017
  • Total Downloads: 701
  • Monthly Downloads: 22
  • Daily Downloads: 0
  • Favourites: 6

Slider-module

Slider module for AsgardCMS

Simple Slider module, that allows administration of sliders, and their rendering in the templates.

Supports Bootstrap Carousel out-of-box, with very simple way to provide custom slider templates

Slider Module

Special Thanks

to Nicolas Widart for AsgardCMS and his Menu Module, that was used as a foundation for the Slider Module.

Installation

You can install Slider module using composer: composer require bociancz/slider-module

After the module is installed, you have to give yourself access in AsgardCMS (using Roles/Permissions). New Slider item will appear in the Sidebar

Usage

Prerequisites

By default, Slider module is created using Bootstrap Carousel http://getbootstrap.com/javascript/#carousel so make sure you have all prerequisites loaded for standard Bootstrap carousel (Bootstrap Carousel CSS and JS)

Basic Usage

You can create basic Slider using the AsgardCMS admin interface - you can create and name your slider (pay attention to the System Name field here, it is used later for rendering), and create individual slides. Slides can be linked to images in the Media module, or have URL pointing to external image. They can also contain hyperlink to any page on the site, fixed URI or URL.

When the slider is created, you can render it in your template using {!! Slider::render('slider_system_name') !}}

Advanced Usage

Use your own slider template

If you want to change rendering of your slider, use custom HTML, CSS classes, etc, you can pass a Blade template name as a second parameter to the render() method, i.e. {!! Slider::render('slider_system_name', 'slider/my-own-slider') !}}

Template may look like this:

{-- Themes/MyTheme/views/slider/my-own-slider.blade.php --}
<div id="{{ $slider->system_name }}" class="my-own-slider-class">

    @foreach($slider->slides as $index => $slide)
        <div class="slide">
            <a href="{{ $slide->getLinkUrl() }}">
                <img src="{{ $slide->getImageUrl() }}" />
            </a>
        </div>
    @endforeach

</div>

You will have Modules\Slider\Entities\Slider instance available in the $slider variable

Provide your own Slider instance

You can also pass a Modules\Slider\Entities\Slider instance as a first parameter instead of the slider system_name to render dynamically created slider.

First, create instance of your slider and add slides in your controller and pass it to the view

<?php
...
// import classes needed to create your own instance
use Modules\Slider\Entities\Slider;
use Modules\Slider\Entities\Slide;

class HomepageController {
    ...
    /**
     * controller method
     */
    public function displayHomepage()
    {
        // make a new Slider instance
        $mySlider = new Slider;
        $mySlider ->system_name = 'custom_slider';

        // create slide 1
        $slide1 = new Slide;
        $slide1->title = 'First Slide';
        $slide1->caption = 'First slide text';
        $slide1->external_image_url = 'https://placeholdit.imgix.net/~text?txtsize=33&txt=Slide1&w=800&h=300';

        // create slide 2
        $slide2 = new Slide;
        $slide2->title = 'Second Slide';
        $slide2->caption = 'Second slide text';
        $slide2->external_image_url = 'https://placeholdit.imgix.net/~text?txtsize=33&txt=Slide2&w=800&h=300';

        // add slides to slider
        $mySlider->slides->add($slide1);
        $mySlider->slides->add($slide2);

        // render view
        return View::make('homepage')
            ->with('mySlider', $mySlider);
    }

then, inside of the homepage.blade.php template, you can render slider using {!! Slider::render($mySlider) !!}

Resources

Module Download

Install any module with the php artisan asgard:download:module command.

php artisan asgard:download:module bociancz/slider-module --migrations

This will download the module and run its migrations.

Composer

composer require bociancz/slider-module

This is if the module is perfect for your use-case as-is, and doesn't need any changes to fit your needs.

Note: Don't forget to give yourself the required permissions before you can view the backend entries.

Mobile Analytics