Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory :  /home/corals/vreg/node_modules/owl.carousel/docs_src/templates/pages/docs/

Upload File : current_dir [ Writeable ] document_root [ Writeable ]

---
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 }}