Documentation/  

UI.X 2

Sidebar

Scrollable sidebar - Adds a scrollable container around the sidebar.

  • (NOTE: Not recommended when Sticky sidebar is set to "Sticky top and bottom")

Share widget modal - Replace the contents of the share widget with a button that opens a modal. This is useful to help differentiate between the share social icons, and the social links.

Scrollable sidenav - Adds a scrollable container around sidenav.

  • NOTE: In later versions this functionality is combined with the Scrollable sidebarstyle property.

Sidebar mobile canvas - Adds the sidebar to an off canvas for mobile.

Collapsible Sidebar - Allows you to collapse and expand the sidebar if it is enabled.

The sidebar collapse function uses "sessions" which allows the browser to remember the users choice. This works for both guests as well as registered users.

Sidebar breakpoint - Allows you to set the width at which the sidebar breaks under the main content. This also disables the collapsible sidebar functionality, as well as sticky functionality.

Sidebar Heading Icons - Adds icons to the sidebar headings when enabled.

This adds icons to all widgets, not just those in the sidebar. It does not, however, add an icon to HTML widgets, as XenForo does not add widget-related markup to them.

Add default sidebar icons for custom HTML widgets - Adds the default icon to custom HTML widgets.

Sidebar location - Set whether the sidebar is on the left or the right of the main content.

The sidebar trigger will follow the sidebar (I.E. When sidebar is on the left, the trigger is also floated left.)

Sidebar trigger position - Sets the location for the sidebar collapse trigger. Options are:

Section Links
Top breadcrumb

Show sidebar trigger phrase - Adds the sidebar phrase to the trigger.

If the sidebar trigger is in the breadcrumb, it will force the breadcrumb to show regardless of other options.

Sticky sidebar - Enables the sticky sidebar, and allows you to set to to sticky top only, is sticky top and bottom

  • Sticky Top and Bottom: This allows the sidebar to stick to the bottom and bottom of the page depending on scroll directions, which allows the user to always easily see the whole sidebar. This is done in JavaScript, and does have slight performance implications. It is supported in many older browsers, unlike sticky top only.
  • Sticky Top Only: The sticky functionality is being added purely with CSS. This means that it has no performance drawbacks. However, it is not supported in older browsers.

Visitor Panel Stats as icons - Allows you to change the visitor stats to icons instead of text if it is enabled.

Widget Padding - Allows you to set the default padding for the sidebar widgets.

Sticky sidebar recalc delay - Sets the amount (milliseconds) to delay an additional calculation for the sticky sidebar.

Copyright © 2024 Audentio, LLC. All Rights Reserved.