# j-Dockable

> The dockable component expects Array of objects.

Framework: jcomponent20
Product: jComponent 20 (jcomponent@20)
Language: en
Content-SHA256: f10964828307c6a7e2b210407fd64d649bd67202eaa0b782fe43ab419aa61341
Snapshot: c0700e321579725c5cf4f5ace1ad7d2866d1b4f93c24a63c0b41b6b7998e976c
Sources: components@910ed1a86f6e72b4f031d3ad0dc7844f9fc5cb8e
Review: not-recorded

- Works only with `+v18`
- Supports touches
- Movable
- Resizable


__Configuration__:

- `style {Number}` `1` bottom panel will be fullwidth, `2` bottom panel will be between the left and right panel
- `parent {String}` jquery selector due to container height (default: `window`)
- `margin {Number}` a bottom margin (default: `0`)
- __NEW__ `reoffsetresize {Boolean}` all floated panels will be re-offset according to `main` window dimension (default: `false`)

The `dockable` component expects `Array` of objects.

```javascript
// Component declaration
var panel = {

	// Component ID
	id: 'PANEL_ID',

	// Positioning
	// You can define specific display size and if the display size is not specified then the window tries to find a size for larger display
	html: 'THE CONTENT OF PANEL', // or can be raw HTMLElement

	offset: { x: 200, y: 100, width: 600, height: 400, minwidth: 200, minheight: 200, maxwidth: 1000, maxheight: 1000, dockminwidth: 200, dockminheight: 200, dockmaxwidth: 400, dockmaxheight: 400 }, // minwidth, maxwidth, maxheight, minheight, dockminheight, dockminwidth, dockmaxheight, dockmaxwidth are optional

	// Default settings
	actions: { move: true, close: true, hide: true, resize: true, autosave: false, resizeX: true, resizeY: true },
	// GOOD TO KNOW:
	// "undefined" close or "close:false" and "hide:true" doesn't destroy the instance of panel (it will be hidden only)

	// A window title
	title: 'Title for the panel',

	// Handlers (optional):
	destroy: function() {
		// @el {jQuery} a content of the window
		// @this {Instance}

		// is executed when the window is destroyed
	},

	make: function(el) {

		// @el {jQuery} a content of the window
		// @this {Instance}

		// this.meta {Object} a reference to window object
		// this.element {jQuery} a content element of the window
		// this.container {jQuery} a main content element of the window
		// this.main {Object} a reference to "Windows" component
		// this.width {Number} a width of window
		// this.height {Number} a height of the content of the window
		// this.x {Number} offset X
		// this.y {Number} offset Y

		// Methods:
		// this.setsize(width, height);
		// this.setcommand(cmd); Allowed commands: "close", "maximize", "resetmaximize", "togglemaximize", "minimize", "resetminimize", "toggleminimize", "resize", "move", "focus"
		// this.setoffset(x, y);

		// is executed when the window is making
	},

	data: function(type, data, el) {

		// @type {String}
		// @data {Object}
		// @el {jQuery} a content element of the window
		// @this {Instance}

		// is executed when data are sent via SETTER('windows', 'send', 'TYPE', 'DATA')
	},

	resize: function(width, height, el, x, y) {

		// @width {Number}
		// @height {Number}
		// @el {jQuery} a content of the window
		// @this {Instance}

		// is executed when the window is resized
	},

	move: function(x, y, el) {

		// @x {Number}
		// @y {Number}
		// @el {jQuery} a content of the window
		// @this {Instance}

		// is executed when the window is moved
	},

	service: function(counter, el) {

		// @counter {Number} count of calls
		// @el {jQuery} a content of the window
		// @this {Instance}

		// the component will execute this handler each 5 seconds
	}
};

PUSH('panels', panel);
```

__Methods__:

- `component.finditem(panel_id)` finds the specific panel according to `ID`
- __NEW__ `component.show(panel_id)` shows a panel
- __NEW__ `component.hide(panel_id)` hides a panel
- __NEW__ `component.toggle(panel_id)` toggles a panel

Use it with `<ui-component name="dockable">`. When the component is not loaded yet, jComponent downloads it on first use from the address in `DEF.fallback` (the Componentator CDN by default). Author: Peter Širka. Source: the Componentator components repository, MIT license.

```html example.html
<style>
	body{padding:0;margin:0;overflow:hidden;}
</style>

<ui-component name="dockable" path="mypanels">

	<div class="padding">
		YOUR CONTENT
	</div>

</ui-component>

<script>

	var mypanels = [];

	mypanels.push({
		id: 'A',
		offset: { x: 200, y: 100, width: 250, height: 400, minwidth: 200, minheight: 200, docked: 'left' },
		title: 'Components',
		html: '<div class="padding">Lorem ipsum dolor sit amet.</div>',
		actions: { move: true, resize: true, close: false, dockable: 'left right bottom' }
	});

	mypanels.push({
		id: 'B',
		offset: { x: 600, y: 300, width: 250, height: 400, minwidth: 200, minheight: 200, docked: 'right' },
		title: 'Properties',
		html: '<div class="padding">Lorem ipsum dolor sit amet.</div>',
		actions: { move: true, resize: true, close: true, dockable: 'left right bottom' }
	});

	mypanels.push({
		id: 'C',
		offset: { x: 600, y: 300, width: 300, height: 200, minwidth: 200, minheight: 200, docked: 'bottom' },
		title: 'Console',
		html: '<div class="padding">Lorem ipsum dolor sit amet.</div>',
		actions: { move: true, resize: true, close: true, dockable: 'right bottom' }
	});

</script>
```