Skip to content

Latest commit

 

History

History
executable file
·
81 lines (50 loc) · 4.27 KB

README.md

File metadata and controls

executable file
·
81 lines (50 loc) · 4.27 KB
Raw

wcomponents

Accessible Web UI Framework for Enterprise

Born in 2005 - Open source since August 2015

WComponents is an opinionated Java framework for building accessible web applications for enterprise and government.

Its goal is to enable Java developers to build AJAX enabled, WCAG 2.0 compliant web applications without the need for expertise in accessibility or client side technologies.

Status

Build Status Quality Gate Status Reliability Rating Coverage Javadocs Maven Central

Contributing

Contributions welcome: See the CONTRIBUTING and CODE_OF_CONDUCT files in this project.

Why Use WComponents

WComponents is yet another Java UI framework, so why would you bother?

  1. WComponents is designed to make it possible to build applications which meet WCAG 2.0 at level AA or better. This is a mandatory requirement for Australian Government web-based applications which is where WComponents started life in 2005.
  2. WComponents is extremely scaleable: we have had very large applications running thousands of components per view and still functioning in IE6!
  3. WComponents based applications can be pure Java: it is possible (though not mandatory) to build an application with no browser code in the application space. Someone who can build a Java application can build a Java web application without a need to know extensive web-client libraries etc.
  4. WComponents makes it easy to implement a common corporate style because every client side aspect of every component is controlled within the theme, even to the extent of being able to prevent the use of templates, inline HTML or some of the Java API designed to allow overrides of themes. A common look & feel for a suite of applications should lead to lower development and maintenance burden and lower training costs for users of intranet applications.
  5. We are nice so you would like to use this framework just because of that.

Supported Browsers

Out of the box WComponents supports all modern desktop and mobile browsers including:

Mobile

  • Mobile Safari
  • Chrome
  • Mobile Firefox

Desktop

  • Chrome
  • Firefox
  • Safari
  • Microsoft Edge

WComponents client side code is extensible and configurable therefore it is perfectly feasible to add support for older browsers not listed above.

Building

If you wish to build WComponents you will need Apache Maven installed.

Run these commands to fetch the source and build:

  1. git clone https://github.com/bordertech/wcomponents.git
  2. cd wcomponents
  3. mvn install

Running the Examples

Running the executable jar file

After following the steps above to build WComponents you may run the wcomponents-examples-lde

  1. cd wcomponents-examples-lde/target/
  2. java -jar wcomponents-examples-lde-VERSION-jar-with-dependencies.jar (replace VERSION with the version you built, e.g. 1.0.0-SNAPSHOT)

Note: you may also be able to simply double-click the jar file.

Running the examples project

The examples project is most easily run from the project view of your IDE.

For example:

  1. Right click the wcomponents-examples-lde project.
  2. Select the main class to run: com.github.bordertech.wcomponents.examples.lde.PlainLauncherProxy