• Settings
    • Locale
    • Change the locale of the datepicker, schedule and client side validation messages.

      Language
      English
      English
      English
      French
      German
      German
      German
      Italian
      Korean
      Spanish
      Catalan
      Dutch
      Portuguese
      Portuguese
      Arabic
      Arabic
      Bulgarian
      Bangla
      Bosnian
      Czech
      Greek
      Estonian
      Persian
      Finnish
      Danish
      Hindi
      Indonesian
      Icelandic
      Croatian
      Japanese
      Hungarian
      Hebrew
      Georgian
      Central Kurdish
      Khmer
      Kyrgyz
      Kazakh
      Lithuanian
      Latvian
      Malay
      Norwegian
      Polish
      Romanian
      Russian
      Slovak
      Slovenian
      Serbian
      Serbian
      Swedish
      Thai
      Turkish
      Ukrainian
      Uzbek
      Vietnamese
      Chinese
      Chinese
  • Resources

Sidebar

Sidebar is a panel component displayed as an overlay.

Sidebar Tag Documentation

Sidebar is a panel component displayed as an overlay.

NameTypeRequiredDefaultDescription
id String false generated Unique identifier of the component in a namingContainer.
rendered boolean false true Boolean value to specify the rendering of the component, when set to false component will not be rendered.
binding UIComponent false generated An EL expression referring to a server side UIComponent instance in a backing bean.
widgetVar String false generated ('widget_' + componentClientId) Name of the client side widget.
appendTo String false Appends the sidebar to the given search expression.
baseZIndex int false 0 Base zIndex value to use in layering. Only use this attribute if you are having issues with your sidebar displaying as this may cause issues with overlay components inside the sidebar.
blockScroll boolean false false Whether to block scrolling of the document when sidebar is active.
dynamic boolean false false Defines if dynamic loading is enabled for the element's panel. If the value is "true", the overlay is not rendered on page load to improve performance.
fullScreen boolean false false When enabled, sidebar is displayed in full screen mode.
modal boolean false true Boolean value that specifies whether the document should be shielded with a partially transparent mask to require the user to close the Panel before being able to activate any elements in the document.
onHide String false Client side callback to execute when sidebar is hidden.
onShow String false Client side callback to execute when sidebar is displayed.
position String false left Position of the sidebar.
showCloseIcon boolean false true Displays a close icon to hide the overlay.
style String false Inline style of the component.
styleClass String false Style class of the component.
visible boolean false false Specifies the visibility of the sidebar.
Loading...
Tag DocumentationNew DocumentationNew Documentation JSDoc

Left Sidebar

Right Sidebar

Top Sidebar

Bottom Sidebar

Full Screen Sidebar

Usage


<div class="card">

    <p:sidebar widgetVar="sidebar1">
        <h3>Left Sidebar</h3>
    </p:sidebar>

    <p:sidebar widgetVar="sidebar2" position="right">
        <h3>Right Sidebar</h3>
    </p:sidebar>

    <p:sidebar widgetVar="sidebar3" position="top">
        <h3>Top Sidebar</h3>
    </p:sidebar>

    <p:sidebar widgetVar="sidebar4" position="bottom">
        <h3>Bottom Sidebar</h3>
    </p:sidebar>

    <p:sidebar widgetVar="sidebar5" fullScreen="true">
        <h3>Full Screen Sidebar</h3>
    </p:sidebar>

    <p:commandButton icon="pi pi-arrow-right" type="button" onclick="PF('sidebar1').show()" styleClass="mr-2" />
    <p:commandButton icon="pi pi-arrow-left" type="button" onclick="PF('sidebar2').show()" styleClass="mr-2" />
    <p:commandButton icon="pi pi-arrow-down" type="button" onclick="PF('sidebar3').show()" styleClass="mr-2" />
    <p:commandButton icon="pi pi-arrow-up" type="button" onclick="PF('sidebar4').show()" styleClass="mr-2" />
    <p:commandButton icon="pi pi-external-link" type="button" onclick="PF('sidebar5').show()"/>

</div>