| Info | Value |
|---|---|
| Component Type | org.primefaces.component.Sidebar |
| Handler Class | None |
| Renderer Type | org.primefaces.component.SidebarRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
appendTo | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Appends the sidebar to the given search expression. |
baseZIndex | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| 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. |
binding | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
blockScroll | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to block scrolling of the document when sidebar is active. |
dynamic | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| 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. Default is false. |
fullScreen | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| No Description |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
modal | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| 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. Default is true. |
onHide | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when sidebar is hidden. |
onShow | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when sidebar is displayed. |
position | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the sidebar. Default is left. |
rendered | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value to specify the rendering of the component, when set to false component will not be rendered. |
showCloseIcon | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Displays a close icon to hide the overlay, default is true. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style of the container element. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| StyleClass of the container element. |
visible | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies the visibility of the sidebar. |
widgetVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
Output generated by Vdldoc View Declaration Language Documentation Generator.