redo main/register page

This commit is contained in:
SowinskiBraeden committed 2022-04-13 13:12:19 -07:00
1 parent eaa2febbf2
commit 1ad5eb654b
400 files changed
+93168 -323

No files matched your search

@@ -0,0 +1,58 @@
---
title: Classes
subTitle: API
nav: docs
description: Owl Carousel Documentation
sort: 2
tags:
- API
---
{{#markdown }}
## Classes
This is an example of how html is rendered. With the following options you can change almost every class the way you want
```
<div class="owl-carousel owl-theme owl-loaded">
<div class="owl-stage-outer">
<div class="owl-stage">
<div class="owl-item">...</div>
<div class="owl-item">...</div>
<div class="owl-item">...</div>
</div>
</div>
<div class="owl-nav">
<div class="owl-prev">prev</div>
<div class="owl-next">next</div>
</div>
<div class="owl-dots">
<div class="owl-dot active"><span></span></div>
<div class="owl-dot"><span></span></div>
<div class="owl-dot"><span></span></div>
</div>
</div>
```
### Options
{{#each classes}}
#### {{name}}
Type: `{{type}}`<br />
Default: `{{Default}}`
{{desc}}
------
{{/each}}
### Next Step
####[Events](api-events.html)
{{/markdown }}
@@ -0,0 +1,96 @@
---
title: Events
subTitle: API
nav: docs
description: Owl Carousel Documentation
sort: 3
tags:
- API
---
{{#markdown }}
## Events
> Events are provided by Owl Carousel in strategic code locations. This gives you the ability to listen for any changes and perform your own actions.
```
var owl = $('.owl-carousel');
owl.owlCarousel();
// Listen to owl events:
owl.on('changed.owl.carousel', function(event) {
...
})
```
You could also trigger events by yourself to control Owl Carousel:
```
var owl = $('.owl-carousel');
owl.owlCarousel();
// Go to the next item
$('.customNextBtn').click(function() {
owl.trigger('next.owl.carousel');
})
// Go to the previous item
$('.customPrevBtn').click(function() {
// With optional speed parameter
// Parameters has to be in square bracket '[]'
owl.trigger('prev.owl.carousel', [300]);
})
```
### Callbacks
Instead of attaching an event handler you can also just add a callback to the options of Owl Carousel.
```
$('.owl-carousel').owlCarousel({
onDragged: callback
});
function callback(event) {
...
}
```
### Data
Each event passes very useful information within the [event object](https://api.jquery.com/category/events/event-object/). Based on the example above:
```Javascript
function callback(event) {
// Provided by the core
var element = event.target; // DOM element, in this example .owl-carousel
var name = event.type; // Name of the event, in this example dragged
var namespace = event.namespace; // Namespace of the event, in this example owl.carousel
var items = event.item.count; // Number of items
var item = event.item.index; // Position of the current item
// Provided by the navigation plugin
var pages = event.page.count; // Number of pages
var page = event.page.index; // Position of the current page
var size = event.page.size; // Number of items per page
}
```
{{#each events}}
### {{namespace}}
{{#each events}}
#### {{name}}
Type: `{{type}}`<br />{{#isnt callback undefined}}Callback: `{{callback}}`<br/>{{/isnt}}{{#isnt param undefined}}Parameter: `{{param}}`<br/>{{/isnt}}
{{desc}}
------
{{/each}}
{{/each}}
{{/markdown }}
@@ -0,0 +1,34 @@
---
title: Options
subTitle: API
nav: docs
description: Owl Carousel Documentation
sort: 1
tags:
- API
---
{{#markdown }}
## Options
> List including all options from built-in plugins video, lazyload, autoheight and animate.
{{#each options}}
#### {{name}}
Type: `{{type}}`<br />
Default: `{{Default}}`
{{desc}}
------
{{/each}}
### Next Step
####[Classes](api-classes.html)
{{/markdown }}
@@ -0,0 +1,123 @@
---
title: Built-in Plugins
subTitle: Development
nav: docs
description: Owl Carousel Documentation
sort: 1
tags:
- Development
---
{{#markdown }}
## Built-in Plugins
> Owl Carousel supports plugin modular structure. This means that you can remove plugins that you wont use or create new ones that fit your needs
### Plugins included
Following javascript files are concatenated in distributed owl.carousel.js and owl.carousel.min.js version. If you are looking for individual scripts please visit [Github]({{ pkg.homepage }}) and fork/download the source project
```
src/
└── js/
├── owl.animate.js
├── owl.autoplay.js
├── owl.autoheight.js
├── owl.carousel.js
├── owl.hash.js
├── owl.lazyload.js
├── owl.navigation.js
└── owl.video.js
```
> [See demos of built-in plugins](../demos/demos.html#using-built-in-plugins)
------
Big thanks to [Artus Kolanowski](https://github.com/witrin) for helping me with modular structure and for providing best practice with developing the code.
{{!--
## owl.lazyload.js
LazyLoad require `class="owl-lazy"` and link to image inside data: data-src="url_to_img" or/and data-src-retina="url_to_highres_img".
There is also option to load images into background but this needs to be tested. [See demo](/demos/demo.html)
Usage:
```
$('.owl-carousel').owlCarousel({
lazyLoad:true
});
```
HTML Markup:
```
<div class="owl-carousel">
<img class="owl-lazy" data-src="https://placehold.it/350x250&text=3" alt="">
<img class="owl-lazy" data-src-retina="https://placehold.it/350x250&text=1-retina" data-src="https://placehold.it/350x250&text=1" alt="">
<div class="owl-lazy" data-src-retina="https://placehold.it/350x250&text=1-retina" data-src="https://placehold.it/350x250&text=1"></div>
</div>
```
## owl.video.js
Currently support YouTube, Vimeo, and vzaar videos only.
To add video into carousel just put `<a class="owl-video" href="_straight URL from YouTube, Vimeo, or vzaar"></a>`.
A tag is not mandatory, can be any other tag but `"owl-video"` and href with url link is required.
Thumbnails are automaticaly fetched from servers. [See demo](/demos/demo.html)
#### Usage:
```
$('.owl-carousel').owlCarousel({
video:true,
videoHeight:200, //optional
videoWidth: 200 //optional
});
```
#### HTML Markup:
```
<div class="owl-carousel">
<div class="article-video"><a class="owl-video" href="https://vimeo.com/23924346"></a></div>
<div class="article-video"><a class="owl-video" href="https://www.youtube.com/watch?v=JpxsRwnRwCQ"></a></div>
<div class="article-video"><a class="owl-video" href="https://www.youtube.com/watch?v=FBu_jxT1PkA"></a></div>
<div class="article-video"><a class="owl-video" href="https://www.youtube.com/watch?v=oy18DJwy5lI"></a></div>
</div>
```
## owl.autoheight.js
Adjusts stage height to highest element on viewport. No special HTML markup required. [See demo](/demos/demo.html)
#### Usage:
```
$('.owl-carousel').owlCarousel({
autoHeight:true,
autoHeightClass: 'owl-height' //default
});
```
## owl.animate.js
Owl Carousel CSS has built-in only fade out transition. To get more fancy looking animations you have to create them yourself in CSS or use fantastic Animate.css library created by Daniel Eden https://daneden.github.io/animate.css/
Animate functions works only with one item and only in browsers that support perspective property.
To get fade out effect just set `animateOut: 'fadeOut'`
#### Default options:
```
animateOut:false;
animateIn:false;
```
Read more on demo page. --}}
{{/markdown }}
@@ -0,0 +1,33 @@
---
title: External Libs
subTitle: Development
nav: docs
description: Owl Carousel Documentation
sort: 4
tags:
- Development
---
{{#markdown }}
## External Libraries
> Why not try Owl with other fantastic open source libraries? Check the list of plugins I've used in some of the demos.
### animate.css
This is an awesome library created by Daniel Eden of CSS3 animations that perfectly works with animate functions.
* [Visit Animate.css website](https://daneden.github.io/animate.css/)
* [See Owl animate demo](/demos/animate.html)
-----
### mouse.wheel.js
A jQuery plugin created by Brandon Aaron that adds cross-browser mouse wheel support with delta normalization.
* [Visit jQuery Mousewheel website](https://github.com/brandonaaron/jquery-mousewheel)
* [See Owl mousewheel demo](/demos/mousewheel.html)
-----
Let me know if you find any useful plugins that fits to Owl.
{{/markdown }}
@@ -0,0 +1,55 @@
---
title: Plugin API
subTitle: Development
nav: docs
description: Owl Carousel Documentation
sort: 2
tags:
- Development
---
{{#markdown }}
## Plugin API
> Plugin API allows you to extend carousel object constructor and use internal functions and variables. Use callback events to communicate between host and plugin.
Plugin scaffolding:
```
/**
* Plugin Name
* @since 2.0.0
*/
;(function ( $, window, document, undefined ) {
PluginName = function(scope){
this.owl = scope;
this.owl._options = $.extend({}, PluginName.Defaults, this.owl.options);
//link callback events with owl carousel here
}
PluginName.Defaults = {
optionName: 'value',
optionName2: 'value'
}
//methods:
PluginName.prototype.method = function(){
}
//destroy:
AutoHeight.prototype.destroy = function(){
//events here
};
$.fn.owlCarousel.Constructor.Plugins['pluginName'] = PluginName;
})( window.Zepto || window.jQuery, window, document );
```
{{/markdown }}
@@ -0,0 +1,62 @@
---
title: Sass Styles
subTitle: Development
nav: docs
description: Owl Carousel Documentation
sort: 3
tags:
- Development
---
{{#markdown }}
## Using Sass
> Owl uses the Sass pre-processor to build CSS for all main modules and themes. If you dont know Sass, have a look at their [website](http://sass-lang.com/) and youll love it. Owl uses a faster adaptation of Sass written in C, [libsass](http://libsass.org/) (via [grunt-sass](https://github.com/sindresorhus/grunt-sass)), that doesn't require a Ruby dependency for our build process.
To build the CSS from its Sass source, its required to have:
* [Node.js](https://nodejs.org/)
* [Grunt](http://gruntjs.com/)
Check this [tutorial](https://benfrain.com/lightning-fast-sass-compiling-with-libsass-node-sass-and-grunt-sass/) to learn how to use Sass and libsass in Grunt environment.
### SCSS Files included
Source files can be found on [Github Project]( {{ pkg.homepage }})
```
src/
└── scss/
├── _mixins.scss
├── _theme.scss
├── owl.carousel.scss
├── owl.animate.scss
├── owl.autoheight.scss
├── owl.lazyload.scss
├── owl.video.scss
├── owl.theme.default.scss
└── owl.theme.green.scss
```
### _mixins.scss
_mixins contain basic snippets generators for CSS3 cross-browser styles.
### _theme.scss
Scss structure for theme. Use owl.carousel.default.scss to change variables and generate new styles.
### owl.carousel.scss
Core file to handle basic styles and override some unnecessary browsers behaviors. You shouldnt change this file unless you have to.
### owl.[pluginname].scss
Styles for modules.
### owl.theme.*.scss
Theme files for dots and navigations buttons. Use `owl.theme.default.scss` to upgrade to your own styles or create a new theme.
{{/markdown }}
@@ -0,0 +1,60 @@
---
title: FAQ
subTitle: Getting Started
nav: docs
description: Owl Carousel Documentation
sort: 3
tags:
- Getting Started
---
{{#markdown }}
## FAQ
------
Before you ask a question in the comments/via email please read the FAQs:
#### Can i use it for free?
Yes!
------
#### Can i use it for ecommerce?
Yes!
------
#### Has it any licence?
MIT
------
#### Can i use many owls on one page?
Yes, however remember that you can use only one unique ID on single page.
------
#### Can i ask for a new functionality?
Yes! Go to [Github]({{ pkg.bugs.url }}) issues page and ask for a feature.
------
#### I need help!
First visit [Github]({{ pkg.bugs.url }}), then look again at documentation and demos. Don't forget to add [jsfiddle](https://jsfiddle.net/) or a link to your demo/example website!
------
#### Does it have infinity scroll/circle/loop slides?
Yes, finally it does.
------
#### What's new in latest release?
See Changelog
------
{{/markdown }}
@@ -0,0 +1,71 @@
---
title: Installation
subTitle: Getting Started
nav: docs
description: Owl Carousel Documentation
sort: 2
tags:
- Getting Started
---
{{#markdown }}
## Installation
------
### Include CSS
First, include two CSS files into your HTML head:
```
<link rel="stylesheet" href="owlcarousel/owl.carousel.min.css">
<link rel="stylesheet" href="owlcarousel/owl.theme.default.min.css">
```
> `owl.carousel.css` file is required and should be included before any *.js files.
Second `owl.theme.default.css` file is optional and feel free to edit it. However, it is required if you'd like the default nav controls like dots or next buttons.
Inside the source package you can also find [SCSS](http://sass-lang.com/) files for easy generation of your own themes.
### Include JS
Yep, include jQuery and `owl.carousel.min.js` into the footer.
```
<script src="jquery.min.js"></script>
<script src="owlcarousel/owl.carousel.min.js"></script>
```
### Set HTML
You don't need any special markup. All you need is to wrap your divs(owl works with any type element a/img/span..) inside the container element `<div class="owl-carousel">`.
Class "owl-carousel" is mandatory to apply proper styles that come from owl.carousel.css file. If you want the default nav controls like dots or buttons, you must also include the "owl-theme" class on that same div.
```
<!-- Set up your HTML -->
<div class="owl-carousel">
<div> Your Content </div>
<div> Your Content </div>
<div> Your Content </div>
<div> Your Content </div>
<div> Your Content </div>
<div> Your Content </div>
<div> Your Content </div>
</div>
```
### Call the plugin
Now call the Owl initializer function and your carousel is ready.
```
$(document).ready(function(){
$(".owl-carousel").owlCarousel();
});
```
> See [demos](/OwlCarousel2/demos/demos.html) for customisation and options usage.
### Next Step
####[FAQ](started-faq.html)
{{/markdown }}
@@ -0,0 +1,90 @@
---
title: Welcome
subTitle: Getting Started
nav: docs
description: Owl Carousel Documentation
sort: 1
tags:
- Getting Started
---
{{#markdown }}
## Welcome
> No matter if you are a beginner or an advanced user, starting with Owl is easy.
### New Features
* Infinity Loop
* Center item
* Smart Speed
* Stage Padding
* Item Margin
* Ability to make almost all options responsive
* Various Widths
* Callback Events
* RTL
* YouTube/Vimeo/vzaar support (fetching thumbnails as well)
* Anchors navigation
* Merged Items
* and more...
### Compatibility
Owl Carousel 2.x.x is not compatibile with previous version 1.x.x. The idea stays the same and it has a lot in common with Owl1 but the core code was re-written from scratch and Im very proud with all the new features.
Owl Carousel has been tested in following browsers/devices:
* Chrome
* Firefox
* Opera
* IE7/8/10/11
* iPad Safari
* iPod4 Safari
* Nexus 7 Chrome
* Galaxy S4
* Nokia 8s Windows8
### Library
Download a version that suits your needs:
* [Owl Carousel - {{ pkg.version }}](https://github.com/OwlCarousel2/OwlCarousel2/archive/{{ pkg.version }}.zip) - Distributed version - compiled and minified. Javascript, images and CSS included.
* [Owl Carousel Source - {{ pkg.version }}]({{ app.download }}) - Source files including this documentation. All wrapped in Grunt project.
### Files included
Distributed version structure:
```
owlcarousel/
├── assets/
│ ├── owl.carousel.css
│ ├── owl.carousel.min.css
│ ├── owl.theme.default.css
│ ├── owl.theme.default.min.css
│ ├── owl.theme.green.css
│ ├── owl.theme.green.min.css
│ └── owl.video.play.png
├── owl.carousel.js
├── owl.carousel.min.js
├── LICENSE-MIT
└── README.md
```
### Dependecies
Get the latest [jQuery](https://jquery.com/) or [Zepto](http://zeptojs.com/) library.
Minimum compatible jQuery version is 1.8.3 version.
### Next Step
####[Installation](started-installation.html)
{{/markdown }}
@@ -0,0 +1,54 @@
---
title: Changelog
subTitle: Support
nav: docs
description: Owl Carousel Documentation
sort: 5
tags:
- Support
---
{{#markdown }}
## Changelog
------
##### 2.0.0.beta.2.4
* Refactors Core
* Makes `slideBy` option independet of `nav`
* Corrects update of `navRewind`
* Corrects `change` event for position in carousel
* Replaces `indexOf` with `$.inArray` in navigaiton plugin
* Corrects `to` override in navigation plugin
* Adds core overrides for navigation plugin
* Corrects naming of plugins as object members
* Corrects `navText` option of navigation plugin
* Corrects `slideBy` option and adds events for navigation plugin
* Corrects adaptive behaviour of the navigation plugin
* fixed autoHeight plugin
* fixed animate plugin
* added autoHeight demo
* fixed download link in subpages
##### 2.0.0.beta.2.3
Thanks to Artus Kolanowski for this amazing update
* Separates navigation from core (nav,dots and hash)
* Corrests and completes JSDocs comments
* Replaces `bind` with `$.proxy`
##### 2.0.0.beta.2.2
* fixed some events trigger two times on initilize
* fixed lazyload bug
* fixed stage active class calculation when using stagePadding
* fixed translate callback
* fixed fixed update function and update/updated events
* included stagePadding demo
------
{{/markdown }}
@@ -0,0 +1,23 @@
---
title: Contact
subTitle: Support
nav: docs
description: Owl Carousel Documentation
sort: 5
tags:
- Support
---
{{#markdown }}
## Contact
------
If you are looking for help then the best place to ask a question is [Github]({{ pkg.bugs.url }}). Also don't forget to add a [jsfiddle](https://jsfiddle.net/) or a link to your demo/example website!
### Report a bug
Please use [Github]({{ pkg.bugs.url }}) to report bugs.
{{/markdown }}
@@ -0,0 +1,62 @@
---
title: Contributing
subTitle: Support
nav: docs
description: Owl Carousel Documentation
sort: 1
tags:
- Support
---
{{#markdown }}
## Contributing
> This project is hosted by Smashing Boxes but so many awesome contributors have had a big impact on the code. Thanks to all the amazing people who spent hours helping me with the development and teaching me new tricks!
If you are looking to support Owl Carousel with your amazing ideas (or just fix some nasty bugs) then go to [Github]({{ pkg.homepage }}) and fork the project.
### Some tips for contributors
Owl Carousel is built around Grunt, Bower and Assemble frameworks. If you are not familiar with those tools please visit:
* [Node.js](https://nodejs.org/)
* [Yeoman](http://yeoman.io/)
* [Grunt](http://gruntjs.com/)
* [Bower](http://bower.io/)
* [Assemble](http://assemble.io/)
### Installation dependecies
Open Terminal, go to folder with project and type:
```
npm install
```
Then install bower components
```
bower install
```
### Grunt Tasks
The default task runs two other tasks: `dist` and `docs`. Type grunt to run default:
```
grunt
```
Now that the whole project is generated, run the last grunt task:
```
grunt serve
```
This creates localhost server and opens docs in your default browser. `watch` tasks will look for any changes and will automatically update the project and reload the browser.
Now you are ready to make some cool updates by yourself. Owl project is in `src` folder. Also dont change `src/css/*.css` - all css files are generated from sass.
> Happy Coding
{{/markdown }}