integrating AUX into an application it should be sufficient to import
the required widgets or components from the main file
have corresponding WebComponents. All widgets can be found under
src/widgets/ and the corresponding components are located at
src/components/. The document
doc/docs/Components.md describes how
the components work.
Default themes can be found in the
styles directory. The document
doc/docs/Themeing.md describes how to create themes based no the
default theme(s) contained in this repository.
AUX can be installed using
npm. In order to gain access to all components,
simply import them all using
and include the default theme into your web application.
AUX was designed to be lightweight and fast while keeping the full flexibility which comes with CSS. AUX widgets offer consistent and intuitive APIs.
The complete API documentation can be found at [http://docs.deuso.de/].
Alternatively, the documentation can be directly built from the source code. The documentation in the source files uses the common jsdoc syntax and JSDoc 3. can be used to generate the documentation. If you have jsdoc installed, simply run
npm run build
Apart from the documentation inside the source tree, there are several
longer introductory articles and usage examples in the directories
Several component examples can be found in separate HTML files in the
examples/ directory. When serving the repository from a HTTP server
all examples can be viewed when opening the file
Several online demos of interfaces using AUX can be found at [http://demo.deuso.de].
If you find a bug in this software, please report it to our issue tracker at [https://gitlab.deuso.de/WebUI/AUX].
AUX is released unter the the terms of the GPLv3. See the file
file for details.
Copyright (c) 2013-2020 Markus Schmidt email@example.com
Copright (c) 2014-2020 Arne Gödeke firstname.lastname@example.org