Documentation

Sidebar

Summary

An optional Sidebar component. This plugin was written by Atlassian.

Status

API status:experimental
Included in AUI core?Not in core You must explicitly require the web resource key.
Web resource key:com.atlassian.auiplugin:aui-sidebar
Experimental since:5.6
Depends on:jQuery

Code

Javascript

AJS.$("#sidebar").sidebar({
    id: "localstorageidstring",
    minWidth: function () {
        return 200
    },
    maxWidth: function () {
        return jQuery(window).width() - 500;
    }
});

Options

OptionRequired?DefaultNotes
idYesno defaultLocal storage ID string
minWidthno50pxA function that returns the minimum width the user can resize to.
maxWidthnoWindow widthA function that returns the maximum width the user can resize to.
resizeno$.noopA callback for when user is resizing sidebar.