Sidebar
Summary
An optional component providing a Sidebar jQuery UI plugin. 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-experimental-sidebar |
---|
Experimental since: | 5.1 |
---|
|
|
|
Depends on: | jQuery UI, Underscore |
---|
Code
Javascript
AJS.$("#sidebar").sidebar({
id: "localstorageidstring",
minWidth: function () {
return 200
},
maxWidth: function () {
return jQuery(window).width() - 500;
}
});
Options
Option | Required? | Default | Notes |
---|
id | Yes | no default | Local storage ID string |
minWidth | no | 50px | A function that returns the minimum width the user can resize to. |
maxWidth | no | Window width | A function that returns the maximum width the user can resize to. |
resize | no | $.noop | A callback for when user is resizing sidebar. |