README.md

OpenMRS UI Framework

Overview

• The UI Framework module introduces a custom user interface framework built on top of Spring MVC and leveraging Groovy templates for views that will be the basis of the OpenMRS 2.x web application, and can also be used in OpenMRS 1.8.4+.

• The UI framework has conventions for page and fragment controller classes and allows you to give flexible method signatures for page controller, fragment controller, and fragment action methods.

Download

Note

• 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
• This module provides only a framework and no real content. The UI Commons module provides reusable UI content.

Download the UI Framework module here.

Getting Started

• Getting Started: Using the UI Framework in Your Module

In this tutorial, it is assumed that you have created a module, and you have configured things so it runs in development mode.

• 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.

For more information

• Visit the UI Framework Wiki Page

• View/download the Source Code

• View release notes and report bugs on the UIFR JIRA project