Skip to content

Commit

Permalink
Revert re-branding: A.UX -> AUX
Browse files Browse the repository at this point in the history
  • Loading branch information
boomshop committed May 15, 2020
1 parent 9f99a00 commit e667831
Show file tree
Hide file tree
Showing 145 changed files with 796 additions and 791 deletions.
Binary file removed A.UX.png
Binary file not shown.
Binary file added AUXLogo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
350 changes: 177 additions & 173 deletions A.UX.svg → AUXLogo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions CHANGES
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
A.UX 1.0: Changes since Toolkit 1.3
AUX 1.0: Changes since Toolkit 1.3
--------------------------------------

Toolkit has been re-branded as 'A.UX'. The first version is 1.0. In the Toolkit
Toolkit has been re-branded as 'AUX'. The first version is 1.0. In the Toolkit
version history this would have been Toolkit version 1.4. Toolkit 1.3 will be
maintained as a stable release with bugfixes.

Expand Down
22 changes: 11 additions & 11 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
icons: Makefile
./tools/icongen -p aux- styles/fonts/A.UX
./tools/icongen -p aux- styles/fonts/Shapes
./tools/icongen -c -h styles/fonts/Shapes100
./tools/icongen -c -h styles/fonts/Shapes200
./tools/icongen -c -h styles/fonts/Shapes300
./tools/icongen -c -h styles/fonts/Shapes400
./tools/icongen -c -h styles/fonts/Shapes500
./tools/icongen -c -h styles/fonts/Shapes600
./tools/icongen -c -h styles/fonts/Shapes700
./tools/icongen -c -h styles/fonts/Shapes800
./tools/icongen -c -h styles/fonts/Shapes900
./tools/icongen -p aux- styles/fonts/AUXIcons
./tools/icongen -p aux- styles/fonts/AUXShapes
./tools/icongen -c -h styles/fonts/AUXShapes100
./tools/icongen -c -h styles/fonts/AUXShapes200
./tools/icongen -c -h styles/fonts/AUXShapes300
./tools/icongen -c -h styles/fonts/AUXShapes400
./tools/icongen -c -h styles/fonts/AUXShapes500
./tools/icongen -c -h styles/fonts/AUXShapes600
./tools/icongen -c -h styles/fonts/AUXShapes700
./tools/icongen -c -h styles/fonts/AUXShapes800
./tools/icongen -c -h styles/fonts/AUXShapes900
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# ![A.UX](logo.png)
# ![AUX](logo.png)

A.UX is a JavaScript widget library with special focus on building low
AUX is a JavaScript widget library with special focus on building low
latency user interfaces for audio applications. It contains a wide range
of widgets such as faders, knobs, levelmeters and equalizers.

## Repository structure

The JavaScript code in this repository uses ES6 modules. When
integrating A.UX into an application it should be sufficient to import
integrating AUX into an application it should be sufficient to import
the required widgets or components from the main file `src/index.js`.

A.UX widgets are implemented as JavaScript widgets. Some of those widgets
AUX widgets are implemented as JavaScript widgets. Some of those widgets
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
Expand All @@ -22,7 +22,7 @@ default theme(s) contained in this repository.

## Installation

A.UX can be installed using `npm`. In order to gain access to all components,
AUX can be installed using `npm`. In order to gain access to all components,
simply import them all using

import '@deutschesoft/a.ux';
Expand All @@ -31,7 +31,7 @@ and include the default theme into your web application.

## Design Goals

A.UX is written in pure JavaScript and has no external dependencies. It
AUX is written in pure JavaScript and has no external dependencies. It
is supposed to run in browsers which support ECMAScript 6. When transpiled to
ECMAScript 5 it should work in modern versions of Chrome, Edge, Firefox and
Safari.
Expand All @@ -46,8 +46,8 @@ can't be replaced by transpilation.
| ES6 Modules | 16 | 60 | 61 | 11 | 11 |
| WebComponents | 79 | 63 | 67 | 10.1 | 10.3 |

A.UX was designed to be lightweight and fast while keeping the full
flexibility which comes with CSS. A.UX widgets offer consistent and intuitive
AUX was designed to be lightweight and fast while keeping the full
flexibility which comes with CSS. AUX widgets offer consistent and intuitive
APIs.

## Documentation
Expand Down Expand Up @@ -75,7 +75,7 @@ all examples can be viewed when opening the file `examples.html`.

## Demos

Several online demos of interfaces using A.UX can be found at
Several online demos of interfaces using AUX can be found at
[http://demo.deuso.de].

## Reporting Bugs
Expand All @@ -85,7 +85,7 @@ tracker at [https://gitlab.deuso.de/WebUI/AUX].

## License

A.UX is released unter the the terms of the GPLv3. See the file `COPYING`
AUX is released unter the the terms of the GPLv3. See the file `COPYING`
for details.

Copyright (c) 2013-2020 Markus Schmidt <[email protected]>
Expand Down
4 changes: 2 additions & 2 deletions angular/resize.directive.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ export class AuxResizeDirective extends OnDestroy
{
if (element.tagName.startsWith('AUX-'))
{
throw new Error("The A.UX WebComponent has not been upgraded, yet. "+
throw new Error("The AUX WebComponent has not been upgraded, yet. "+
"Are you missing and import?");
}
throw new Error("The element is not an A.UX WebComponent.");
throw new Error("The element is not an AUX WebComponent.");
}

o.subscribe(() => {
Expand Down
4 changes: 2 additions & 2 deletions angular/subscriptions.model.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@ export abstract class AuxSubscriptions implements OnDestroy
{
if (element.tagName.startsWith('AUX-'))
{
throw new Error("The A.UX WebComponent has not been upgraded, yet. "+
throw new Error("The AUX WebComponent has not been upgraded, yet. "+
"Are you missing and import?");
}
throw new Error("The element is not an A.UX WebComponent.");
throw new Error("The element is not an AUX WebComponent.");
}

const last = this.last || {};
Expand Down
4 changes: 2 additions & 2 deletions backstop/htdocs/frame.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
<html lang="en">
<head>
<meta charset="utf-8" />
<title>A.UX Examples</title>
<title>AUX Examples</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<script type=module src="/src/index.js"></script>

<link rel="stylesheet" id=stylesheet href="/styles/A.UX.css" />
<link rel="stylesheet" id=stylesheet href="/styles/default.css" />

HEAD

Expand Down
2 changes: 1 addition & 1 deletion backstop/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "aux-backstop",
"version": "1.0.0",
"description": "backstop tests for A.UX",
"description": "backstop tests for AUX",
"main": "index.html",
"scripts": {
"serve": "node serve.js",
Expand Down
40 changes: 20 additions & 20 deletions doc/docs/Angular.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# Using A.UX with Angular
# Using AUX with Angular

A.UX can be integrated into an Angular project simply by installing it as a
dependency. A.UX Widgets are exposed as WebComponents using the v1 WebComponents API, which
is supported in modern browser. To import all A.UX Components into an Angular
AUX can be integrated into an Angular project simply by installing it as a
dependency. AUX Widgets are exposed as WebComponents using the v1 WebComponents API, which
is supported in modern browser. To import all AUX Components into an Angular
project add a global import to the top level module.

import '@deutschesoft/a.ux';

Importing the standard A.UX CSS theme can be done by adding
Importing the standard AUX CSS theme can be done by adding
`node_modules/@deuso/aux/styles/main.css` to the `styles` list in the
`angular.json` configuration file.

In order to use WebComponents inside of Angular templates, the corresponding Angular
module needs to have the `CUSTOM_ELEMENTS_SCHEMA`. Once that is set up, A.UX
module needs to have the `CUSTOM_ELEMENTS_SCHEMA`. Once that is set up, AUX
Components should work within Angular templates.

## Setting options

All options of A.UX Widgets are available via usual tag attributes and can be set
All options of AUX Widgets are available via usual tag attributes and can be set
from within the template.

<aux-fader min=-96 max=6></aux-fader>
Expand All @@ -35,22 +35,22 @@ Widget options automatically.

## Subscribing to events

All A.UX Widget events are available via standard DOM custom events. Unlike DOM
events, A.UX Widget events have a list of arguments. They are available in the
All AUX Widget events are available via standard DOM custom events. Unlike DOM
events, AUX Widget events have a list of arguments. They are available in the
CustomEvent object as `ev.detail.args`.

For instance, for option changes triggered by user interaction, A.UX widgets define
For instance, for option changes triggered by user interaction, AUX widgets define
one standard event called `useraction`. It has two events, the option name and
the new value. The following event handler would call the method
`onValueChanged` with a two element array.

<aux-fader min=-96 max=6 (useraction)="onValueChanged($event.detail.args)">
</aux-fader>

# A.UX Angular Directives
# AUX Angular Directives

The A.UX repository contains implementations of several Angular directives which
aim to make bindings between A.UX Widget options and Angular components simpler
The AUX repository contains implementations of several Angular directives which
aim to make bindings between AUX Widget options and Angular components simpler
and more performant than relying on custom DOM events. The implementation of
those Angular Directives can be found in the `angular` subdirectory. They can be
added to an Angular application by importing them
Expand All @@ -59,7 +59,7 @@ added to an Angular application by importing them

and adding them to the `imports` list of the `@NgModule` declaration.

In addition is is necessary to add all typescript files for the A.UX Angular
In addition is is necessary to add all typescript files for the AUX Angular
directives into the `"include"` entry in `tsconfig.app.json` to allow the
typescript compiler to find them:

Expand All @@ -70,7 +70,7 @@ typescript compiler to find them:

## Observing value changes

This group of directives can be used to observe changes of A.UX Widget options.
This group of directives can be used to observe changes of AUX Widget options.
These directives can be used to subscribe to changes to any number of options.
They expect an Object as argument with options names as keys. The values can
either be a function or an object implementing a `next()` method, such as
Expand Down Expand Up @@ -115,13 +115,13 @@ externally check if a parameter is valid before feeding it back into the widget.
<aux-fader min=-96 max=6 [auxIntercept]="{ value: clip_value }">
</aux-fader>

## Observing A.UX Widget events
## Observing AUX Widget events

### The `auxSubscribe` directive

The `auxSubscribe` directive can be used to subscribe to a number of A.UX Widget
The `auxSubscribe` directive can be used to subscribe to a number of AUX Widget
events. As with the value observe directives it expects an object which contain
either functions or observers. Functions are called with the A.UX event
either functions or observers. Functions are called with the AUX event
arguments. Observers receive the array of arguments as the value.

Using `auxSubscribe` can be more convenient when working with `Subject`s than
Expand All @@ -130,13 +130,13 @@ because it avoids the translation to and from DOM events.

## Binding options using `auxBind`

Binding backend values to A.UX widget options can be done simply by setting the
Binding backend values to AUX widget options can be done simply by setting the
property. However, when doing this while a user is interacting with the widget
leads to very poor user experience. For instance, a fader value would jump while
being dragged if the back end connection has network delay.

The `auxBind` can be used to prevent such issues when binding options to backend
data. It internally uses the `DebounceBinding` class which is part of A.UX. It
data. It internally uses the `DebounceBinding` class which is part of AUX. It
delays received values

* while the `interacting` option is `true` on a widget or
Expand Down
4 changes: 2 additions & 2 deletions doc/docs/Components.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Components

Most A.UX widgets have corresponding WebComponents implementations.
The component implementation maps options of A.UX widgets onto both
Most AUX widgets have corresponding WebComponents implementations.
The component implementation maps options of AUX widgets onto both
attributes and properties. This means that components have getters and
setters for each widget option. Exceptions to this are those options
which would collide with properties of the component base class.
Expand Down
12 changes: 6 additions & 6 deletions doc/docs/Rendering.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Rendering in A.UX
# Rendering in AUX

This document describes how the A.UX library renders widgets. The different
techniques used are important to understand when using A.UX widgets within
This document describes how the AUX library renders widgets. The different
techniques used are important to understand when using AUX widgets within
other applications. This is especially true when widgets are dynamically resized
or their style sheets are changed dynamically.
This document also details some optimizations to increase DOM performance, which
Expand Down Expand Up @@ -44,7 +44,7 @@ are not performed immediately.
not be easily done by completely disabling the application, since the application
logic might need to continue running.

A.UX furthermore employs a technique which we will explain below. We
AUX furthermore employs a technique which we will explain below. We
call this technique **DOM scheduling**.

The run time performance of code operating on the DOM tree can be substantially
Expand All @@ -53,7 +53,7 @@ triggers. Style recalculations might be triggered by asking for the value of
a computed style of an element. Likewise reflow operations might be necessary
when asking for pixel positions or dimensions of an element, e.g. by reading
`element.offsetWidth`. Ideally, these kinds of operations are avoided entirely,
however in some situations that might not be possible. Inside of A.UX there
however in some situations that might not be possible. Inside of AUX there
are several widgets which need to measure dimensions when rendering, for instance
the `AUX.Fader` element, which needs to measure the size of the fader handle,
in order to position the scale and background correctly.
Expand Down Expand Up @@ -149,7 +149,7 @@ the implementation we can illustrate this by our example:
S.run();
}

A similar thing happens inside of A.UX. Different `redraw()` methods
A similar thing happens inside of AUX. Different `redraw()` methods
in widgets are added for the next scheduler run if their options have
been modified. The DOMScheduler eventually runs during the next animation
frame. The individual `redraw()` methods will schedule certain parts of the
Expand Down
2 changes: 1 addition & 1 deletion doc/docs/Widgets.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Widgets inside the DOM

This document describes briefly how A.UX widgets can be used inside of a HTML layout.
This document describes briefly how AUX widgets can be used inside of a HTML layout.

Widgets are organized in a tree. This tree will usually be similar to the DOM
tree, where each widget consists of at least one DOM element. There may be
Expand Down
2 changes: 1 addition & 1 deletion doc/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "aux-documentation",
"version": "1.0.0",
"description": "documentation generator for A.UX",
"description": "documentation generator for AUX",
"main": "index.html",
"directories": {},
"scripts": {
Expand Down
12 changes: 6 additions & 6 deletions examples.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8" />
<title>A.UX Examples</title>
<title>AUX Examples</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<script type=module src="src/index.js"></script>
<script type=module>
Expand Down Expand Up @@ -217,7 +217,7 @@

</script>

<link rel="stylesheet" id=stylesheet href="styles/A.UX.css" />
<link rel="stylesheet" id=stylesheet href="styles/default.css" />
<link rel="stylesheet" id=stylesheet href="examples/styles.css" />

<style>
Expand All @@ -226,10 +226,10 @@
<body>
<aux-root>
<div id=introduction>
<h1>A.UX Examples</h1>
<h1>AUX Examples</h1>
<img src="logo.png" id=logo>
<p>
This is a collection of A.UX widgets in different configurations
This is a collection of AUX widgets in different configurations
for development, demonstration and guideline purposes. to get
an insight into structure and relation, browsers with developer
tools (try <code>F12</code>) are recommended.
Expand All @@ -240,10 +240,10 @@ <h1>A.UX Examples</h1>
</p>
<p>
The full documentation can be found online at
<a href="http://docs.deuso.de/A.UX">docs.deuso.de/A.UX</a>.
<a href="http://docs.deuso.de/AUX">docs.deuso.de/AUX</a>.
</p>
<p>
A.UX AudioWidgets is a product of
AUX AudioWidgets is a product of
<a href="https://deuso.de">DeusO GmbH</a>.
</p>
</div>
Expand Down
Binary file modified favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@deutschesoft/a.ux",
"version": "1.0.12",
"description": "A.UX Audio Widget Library",
"description": "AUX Audio Widget Library",
"main": "src/index.js",
"module": "src/index.js",
"type": "module",
Expand Down
6 changes: 3 additions & 3 deletions src/component_helpers.js
Original file line number Diff line number Diff line change
Expand Up @@ -537,7 +537,7 @@ export function define_component(name, component, options)
}

/**
* Interface implemented by all WebComponents based on A.UX Widgets.
* Interface implemented by all WebComponents based on AUX Widgets.
*
* Each Component maps both attributes and properties onto options of the same
* name. The mapping of attributes is only one-directional, i.e. attributes are
Expand All @@ -551,8 +551,8 @@ export function define_component(name, component, options)
* 'title' option in the widget.
*
* @interface Component
* @property auxWidget {Widget} - The A.UX widget object of this component.
* @property isAuxWidget {boolean} - Returns true. This can be used to detect A.UX components.
* @property auxWidget {Widget} - The AUX widget object of this component.
* @property isAuxWidget {boolean} - Returns true. This can be used to detect AUX components.
*/
/**
* Trigger a resize. This leads the widget to recalculates its size. Some
Expand Down
Loading

0 comments on commit e667831

Please sign in to comment.