position ⇒ Weavy.plugins.position

Collapsing dock and drag'n'drop positioning

Kind: global plugin

Instance members

weavy.nodes ⇐ weavy.nodes

The nodes placeholder in Weavy

Kind: instance property of position
Extends: weavy.nodes

weavy.nodes.hiddenDragImage : Element

The element used for hiding default visual representation when dragging.

Kind: instance property of weavy.nodes
Created: Widget event: load

weavy.collapse()

Set collapsed weavy, which is a compact visual representation of the full dock.

Kind: instance method of position
Emits: weavy.collapse

weavy.minimize()

Set minimized weavy, which is a mimial visual representation of the dock only containing a small floating button. If the dock is in normal state it will also trigger collapse.

Kind: instance method of position
Emits: weavy.collapse , weavy.minimize

weavy.restore()

Unset collapse/minimize states and return to normal dock mode.

Kind: instance method of position

Events

"collapse"

Triggered when the dock is collapsed.

Kind: event emitted by position
Category: events

"minimize"

Triggered when the dock is minimized.

Kind: event emitted by position
Category: events

"restore"

Triggered when the moduel:dock leaves collapse/minimize states and returns to normal state.

Kind: event emitted by position
Category: events

Static members

.defaults : Object

Default plugin options

Kind: static property of position
Properties
NameTypeDefaultDescription
positionClassNamestring "weavy-collapsed"

Classname added to weavy.nodes.container at load.

snappingXint 4

Horizontal snapping in rem when dragging

snappingYint 4

Vertical snapping in rem when dragging

minimizeDelayint 15000

Time before the dock is automatically minimized

Example
Weavy.plugins.position.defaults = {
    positionClassName: 'weavy-collapsed',
    snappingX: 4,
    snappingY: 4,
    minimizeDelay: 15000
};

.dependencies : Array.<string>

Non-optional dependencies.

Kind: static property of position