Giter VIP home page Giter VIP logo

panda-box's Introduction

Panda Box

A Lightbox plugin written in TypeScript.

Demo

1. Installation

Using npm:

  $ npm install panda-box --save

or yarn:

  $ yarn add panda-box

Then import it in your javascript files:

import PandaBox from 'panda-box';

Also make sure that you include styles:

import 'panda-box/dist/pandaBox.css';

2. Usage

Add attribute data-pandabox to container of gallery and call new PandaBox();

Or pass your own selector to class constructor:

  new PandaBox('.galleryContainer')

2.1 HTML Structure

A gallery must be in a form of <img src="#"> with a <a href="#"> wrap eg.:

  <div data-pandabox>
    <a href="1.jpg">
      <img src="1-thumb.jpg" />
    </a>
    <a href="2.jpg">
      <img src="2-thumb.jpg" />
    </a>  
  </div>

3. Additional options

3.1. data-title=""

Add data-title attribute with string inside it to attach title to image.

3.2. data-description=""

Add data-description attribute with string inside it to attach description to image.

4. Support

IE 11+, all evergreeen browsers

panda-box's People

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.