Skip to content

A REDCap External Module to remove some of REDCap's menus and other UI elements.

License

Notifications You must be signed in to change notification settings

grezniczek/redcap_ui_trimmer

Repository files navigation

UI Trimmer

A REDCap External Module to remove some of REDCap's menus and other UI elements.

Requirements

  • REDCAP 9.5.0 or newer (tested with 9.5.8, 9.8.2).

Installation

  • Clone this repo into <redcap-root>/modules/redcap_ui_trimmer_v<version-number>.
  • Go to Control Center > Technical / Developer Tools > External Modules and enable UI Trimmer.

Configuration

System-level settings

  • Debug mode - when enabled, JavaScript will not be inlined but called as separate script files. This facilitates debugging.
  • Enable for Super Users - Normally, any UI-removals do not apply for Super Users. Activate this setting to have the module remove UI elements even for them.

Project-level settings

Toggle removal of or change the appearance of various UI elements:

  • Remove the My Projects link from the menu
  • Remove the Codebook link from the menu
  • Remove the Video Tutorials link from the menu
  • Remove the Help & FAQ link from the menu
  • Modify the Help & FAQ link (text, link target)
  • Remove the Suggest a New Feature link from the menu
  • Remove all empty menu sections
  • Remove items from Project Home:
    • Current Users
    • Upcoming Calendar Event
  • Remove items from Data Entry pages:
    • Remove actions
  • Remove items from the Login page:
    • Remove the Forgot your password? link
    • Remove the items below the line under the Log In button

Testing

Instructions for testing the module can be found here.

Changelog

Version Changes
1.0.8 Critical Bugfix (a debugger statment was accidentally left in the code).
1.0.7 Bugfix (caused the email users page to blank).
1.0.6 Support impersonation feature.
1.0.5 Do not remove External Modules section when the Manage and Log links are present.
1.0.4 PHP8 compatibility.
1.0.3 Add instructions for testing the module.
1.0.2 Add checks for presence of jQuery to prevent JS errors.
1.0.1 Fix incompatibility with REDCap version 9.5.0.
1.0.0 Initial release.