The UI Framework module introduces a custom user interface framework built on top of Spring MVC that will be the basis of the OpenMRS 2.x web application, and can also be used in OpenMRS 1.8.4+.
- Download link: https://modules.openmrs.org/modules/view.jsp?module=uiframework
- Source code: https://github.com/openmrs/openmrs-module-uiframework.
- Release notes and bug reports: UIFR JIRA project.
Version Numbers
Note that the major version numbers of the UI Framework module are significant, and each major version upgrade (1.x, 2.x, 3.x, etc) introduces backwards-incompatible changes. See Backwards-Compatibility across UI Framework major versions.
Getting Started
Curious whether the UI Framework is ready for use yet? It's being used for the Provider Management Module and the Kenya EMR Module, and PIH is building a complete new user interface based on it for Mirebalais Hospital. So yes, it's ready to use!
- Getting Started: Using the UI Framework in Your Module
- Introductory Tutorial: UI Framework Step By Step Tutorial
- OpenMRS University: Using the UI Framework Module
References
- Flexible Method Signatures for UI Framework Controller and Action Methods
- Type Converters: what they are, and how to write and register them
- UI Framework Reference Guide (currently a FAQ, hopefully to expanded into complete documentation)
- Backwards-Compatibility across UI Framework major versions
You should also browse our library of reusable UI elements in the UI Library module.