Close a tag that is currently open.
Because the tags are added as DOM elements, the tag isn't really "open" in the sense that it would be missing the closing tag. Instead we jump out of the tag and set output focus back to its parent element.
The target window in the Haven engine. This is practically always 0.
Returns true if a tag was open, false if we were already at the top window level and nothing was done.
Set output focus to an element.
A jQuery object or selector
The target window in the Haven engine. This is practically always 0.
Returns true if the focus was set successfully, false if the element wasn't found.
Checks whether user input is blocked.
Returns true if input is blocked, otherwise false.
Create a new HTML element, append it to the target window, and set the output focus to the element.
Example:
vorple.layout.openTag( 'div', 'vorple' ) --> <div class="vorple"></div>
Name of the tag to create
Class names to add to the element
The target window in the Haven engine. This is practically always 0.
Returns true.
Scroll an element into view. Scrolling is initiated only if the element isn't already fully in view or its top position is not in the top half of the page.
If the element doesn't exist, the function doesn't do anything.
The target element
The duration of the scroll animation in milliseconds
Returns a promise that resolves to true when the scroll animation ends, or resolves to false if no scrolling was needed (element doesn't exist or is already in view.)
Scroll to the end of the document.
The duration of the scroll animation in milliseconds
Returns a promise that resolves when the scroll animation ends.
Unblock the UI.
Generated using TypeDoc
Blocks the UI so that the user can't type anything or click any elements. Note that this only applies to built-in input and features, for custom features use isBlocked to check whether input should be accepted.
Use unblock to remove the block.