Welcome to the OmniFaces Showcase application!

Live examples of the OmniFaces components and utilities can be tried out here. Check out the left side menu for all of 'em!
Please note that OmniFaces is a JSF utility library, not a JSF UI/component library. The UI which you see on this showcase is done by PrimeFaces.

Download - Showcase - API docs - VDL docs - Sources - Issues

What is OmniFaces?

Tired of reinventing JSFUtils or FacesUtils utility classes for every JSF web application and/or homebrewing custom components, taghandlers, etc to workaround or enhance some general shortcomings in JSF? OmniFaces may be what you're looking for!

OmniFaces is a utility library for JSF 2 that focusses on utilities that ease everyday tasks with the standard JSF API. OmniFaces is a response to frequently recurring problems encountered during ages of professional JSF development of the JDevelopment team and from questions being asked on Stack Overflow.

Contrary to some of the other excellent JSF 2 libraries out there (like PrimeFaces, or RichFaces), OmniFaces does not contain much if any of the beautiful visually oriented components that those other libraries are already known and loved for. As such, OmniFaces does not and probably will never contain things like rich table or datagrid components. OmniFaces is more geared toward "utilities" that solve everyday practical problems and workarounds for small shortcomings in the JSF API. Such utilities and workarounds can be based on components, but OmniFaces does not necessarily strive to be a "component library" perse. OmniFaces can just be used together with any component library.

Besides utility classes for working with the JSF API from Java code, such as Faces and Messages, and utility and enhanced components, such as o:highlight and o:viewParam, OmniFaces will include various general converters, validators and Facelets tag handlers. These will range from "all-or-none" validators to converters which automatically convert Java models for usage in f:selectItem(s). There are also specialized handlers, such as a full ajax exception handler which will automatically handle all ajax exceptions with the default web.xml error-page mechanisms and a combined resource handler which will automatically combine all separate CSS/JS resources into a single resource. CDI specific features are available such as transparent support for injection in @FacesConverter and @FacesValidator. For a full overview of what's all available in OmniFaces and several live examples, look at the showcase.

Minimum requirements

An important design goal will be to have as few dependencies as possible and to be minimally invasive. So far, OmniFaces 1.x only requires Java 1.6, JSF 2.0, EL 2.1 and Servlet 2.5 APIs (Java EE 6 details) which is already minimally available in a fairly modern servlet container serving a JSF 2.x web application. OmniFaces 2.x goes a step further by requiring Java 1.7, JSF 2.2, EL 2.2, Servlet 3.0 and CDI 1.0 APIs which is already minimally available in a fairly modern servlet container serving a JSF 2.2 web application.

Since OmniFaces 1.6 there is an optional dependency on CDI, which turned out to be troublesome in some outdated environments, so they were since version 1.10 removed from version 1.x for a better compatibility with those environments. The CDI specific features remain in version 2.x whereby the CDI dependency is thus made required. Version 1.x users who are already using CDI specific features on a JSF 2.1 environment should be able to effortlessly migrate to version 2.x. As of now, OmniFaces 2.x is backwards compatible with JSF 2.1, but not with JSF 2.0 anymore due to the new <o:viewParamValidationFailed> tag.

All versions have an optional dependency on JSR303 Bean Validation which is only required when you actually use <o:validateBean> or JsfLabelMessageInterpolator.

OmniFaces should principally integrate perfectly well with most other JSF component libraries. Even more, the OmniFaces showcase application uses PrimeFaces. Note that OmniFaces is due to the mandatory Servlet API dependency not compatible with portlets.

Installation

It is a matter of dropping the OmniFaces 1.8.1 JAR file in /WEB-INF/lib. If you like to play around with the newest of the newest, hereby accepting the risk that new classes/methods may be moved/renamed without notice, then grab the OmniFaces 2.0 SNAPSHOT JAR file instead. If you want to test the new 1.x without CDI, then grab OmniFaces 1.10 SNAPSHOT JAR file.

Maven users can add OmniFaces by adding the following Maven coordinates to pom.xml:

<dependency>
    <groupId>org.omnifaces</groupId>
    <artifactId>omnifaces</artifactId>
    <version>1.8.1</version> <!-- Or 2.0-SNAPSHOT or 1.10-SNAPSHOT -->
</dependency>

The OmniFaces UI components/taghandlers and EL functions are available under the following XML namespaces:

xmlns:o="http://omnifaces.org/ui"
xmlns:of="http://omnifaces.org/functions"

Download

Documentation

Demo

Support

If you have specific programming problems or questions related to the OmniFaces library, feel free to post a question on Stack Overflow using at least the jsf and omnifaces tags.

If you have found bugs or have new ideas, feel free to open a new issue.

If you have general feedback that's not either a question, bug report or feature request, or if you have a review/rating, please feel free to leave it at Devrates or Ohloh

OmniFaces in the worldwide news and literature