README

It's an extension kit for our theme https://github.com/hieu-pv/nf-theme

Before Installation

Step 1: Install Nf-Theme-Option package

nf-theme-option

Installation

Step 1: Install Through Composer

composer require nf/slider-for-nftheme

Step 2: Add the Service Provider

Open config/app.php and register the required service provider.

  'providers'  => [
        // .... Others providers 
        \NF\Slider\SliderServiceProvider::class
    ],

Step 3: Register your option scheme

You can add your option scheme to functions.php

All supported type can be found here

• Size
• SliderType

use NF\Slider\Abstracts\Size;
use NF\Slider\Abstracts\SliderType;
use NF\Slider\Facades\SliderManager;

SliderManager::add([
    'name'    => 'Slider Homepage',
    'type'    => SliderType::SLICK,
    'style'   => 'style-1',
    'size'    => Size::SIZE_3X1,
    'fields'  => [
        [
            'label'       => 'Slider',
            'name'        => 'slider',
            'type'        => Input::GALLERY,
            'description' => 'Gallery with meta field, for now we support text and textarea on meta field.',
        ],
    ],
    'options' => [
        'slidesToShow'   => 1,
        'slidesToScroll' => 1,
        'autoplay'       => true,
        'pauseOnHover'   => true,
        'infinite'       => true,
        'dots'           => true,
    ],
]);

Step 4: Add shortcode

Automatic create a shortcode name nf-slider with a attribute name is require:

[nf-slider name="{slider name}"]

Example:

[nf-slider name="Banner homepage"]

Step 5: Insert shortcode wherever you need

Very easy

do_shortcode("[nf-slider name='Banner homepage']")

Last step

{tip} Drink tea and relax !