Skip to content

CoreyDH/Course-Tour

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Course Tour

Features

  • Carousel like interface between holes, and images
  • Optional multi images/video for each hole
  • FCK based hole description
  • Single page viewing
  • Easy implementation
  • Mobile responsive

Future Features

  • Layout selection

Dependencies

  • jQuery
  • Bootstrap
  • Owl Carousel 2
  • Flexslider 2

Implementation

$('#selector').coursetour();

Options

holes (default: 18) integer - Number of holes that will be generated and displayed.

info (default: true) boolean - Display information panel, holds stats and descriptions.

infoPos (default: 'right') 'right', 'left' - Side panel sits on.

infoColWidth (default: 4) integer - Info panel column width based on bootstrap grid.

media (default: 4) integer - Display media panel, holds images and videos.

mediaPos (default: right) right, left - Side panel sits on.

mediaColWidth (default: 4) integer - Media panel column width based on bootstrap grid.

videos (default: false) object - Load any youtube links via object with hole# for keys, and array for value.

Example:

$('#selector').coursetour({
  videos: {
    hole1: ['ytlink1', 'ytlink2', 'ytid'],
    hole2: ['ytlink1', 'ytlink2', 'ytid'],
    hole6: ['ytlink1', 'ytlink2', 'ytid'],
  }
});

images (default: true) boolean - Display images.

imagesPath (default: 'images/coursetour') string - Path to the image folder, will read folders inside and relate to hole # in ascending order.

File structure should be

pathFolder
|-hole1
|-hole2
|-hole3
|-etc..

smoothHeight (default: false) boolean - Flexslider smoothHeight feature.

description (default: true) boolean - Display descriptions.

stats (default: true) boolean - Display stats.

loader (default: true) boolean - Display load screen.

ajaxInfo (default: false) boolean - Retrieve description and stats information with AJAX rather than through the DOM tree.

infoPath (default: '.') string - Description/Stats directory, needed if ajaxInfo is set to true

carouselSpeed (default: 350) integer - Transition speed of the wrapper carousel.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published