Required Rights UI

Last modified by Admin on 2026/05/27 13:46

cogManage the required rights of a document.
TypeJAR
CategoryUI Extension
Developed by

XWiki Development Team

Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Standard

Success

Installable with the Extension Manager

Description

This extension provides two UI extensions and a modal to configure the required rights of a page.

Information tab

A UI extension for the org.xwiki.platform.template.information UIXP (order: 600) informs about the currently set required rights and allows opening the modal to review required rights for users with the appropriate rights:

RequiredRightMightBeMissingInformation.png
The UI extension for required rights in the information tab.

Warning for missing required rights

A UI extension for the org.xwiki.platform.template.content.header.after UIXP displays a warning when the document misses required rights according to the analysis of required rights:

RequiredRightsWarning.png
The UI extension that warns about missing required rights above the document.

Modal for setting required rights

A modal allows configuring required rights. It can be triggered with a button with the data-xwiki-requiredrights-dialog="show" attribute: <button type="button" class="btn btn-default" disabled data-xwiki-requiredrights-dialog="show">…</button> when the js/security/requiredrights/requiredRightsDialog.js and css/security/requiredrights/requiredRightsDialog.css JSRX/SSRX resources are loaded. The modal automatically reloads the content in view mode and the WYSIWYG editor in edit mode after saving. Further, after all save operations, the above-mentioned UI extensions are refreshed.

RequiredRightsModal.png
The modal for setting required rights

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager).

You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.

Dependencies

Dependencies for this extension (org.xwiki.platform:xwiki-platform-security-requiredrights-ui 18.4.0):

Get Connected