Skip to content

Commit

Permalink
Rename package to A.UX
Browse files Browse the repository at this point in the history
For historical reasons windows filesystems do not like AUX as file
names.
  • Loading branch information
arneg committed Apr 24, 2020
1 parent bdaf82d commit 1e3ded8
Show file tree
Hide file tree
Showing 19 changed files with 29 additions and 29 deletions.
File renamed without changes
File renamed without changes
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ of widgets such as faders, knobs, levelmeters and equalizers.
## Repository structure

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

AUX widgets are implemented as JavaScript widgets. Some of those widgets
A.UX 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 @@ -25,7 +25,7 @@ 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

import 'aux';
import '@deutschesoft/a.ux';

and include the default theme into your web application.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Directive, ElementRef, Inject, Input } from '@angular/core';
import { Observable, SubscriptionLike, isObservable } from 'rxjs';
import { AuxSubscriptions } from './aux-subscriptions.model';
import { AuxSubscriptions } from './subscriptions.model';

@Directive({
selector: '[auxAssign]'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Directive, ElementRef, Inject, Input } from '@angular/core';
import { Observable, SubscriptionLike, isObservable } from 'rxjs';
import { AuxSubscriptions } from './aux-subscriptions.model';
import { AuxSubscriptions } from './subscriptions.model';
import { DebounceBinding } from '@deuso/aux';

@Directive({
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import { NgModule } from '@angular/core';
import { AuxAssignDirective } from './aux-assign.directive';
import { AuxBindDirective } from './aux-bind.directive';
import { AuxInterceptDirective } from './aux-intercept.directive';
import { AuxObserveAllDirective } from './aux-observe-all.directive';
import { AuxObserveDirective } from './aux-observe.directive';
import { AuxResizeDirective } from './aux-resize.directive';
import { AuxSubscribeDirective } from './aux-subscribe.directive';
import { AuxAssignDirective } from './assign.directive';
import { AuxBindDirective } from './bind.directive';
import { AuxInterceptDirective } from './intercept.directive';
import { AuxObserveAllDirective } from './observe-all.directive';
import { AuxObserveDirective } from './observe.directive';
import { AuxResizeDirective } from './resize.directive';
import { AuxSubscribeDirective } from './subscribe.directive';


@NgModule({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Directive, ElementRef, Input } from '@angular/core';
import { Observable, SubscriptionLike } from 'rxjs';
import {
AuxSubscriptions, make_subscription
} from './aux-subscriptions.model';
} from './subscriptions.model';
import { intercept_option } from '@deuso/aux';

@Directive({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Directive, ElementRef, Input } from '@angular/core';
import { Observable, SubscriptionLike } from 'rxjs';
import {
AuxSubscriptions, make_subscription
} from './aux-subscriptions.model';
} from './subscriptions.model';
import { observe_option } from '@deuso/aux';

@Directive({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Directive, ElementRef, Input } from '@angular/core';
import { Observable, SubscriptionLike } from 'rxjs';
import {
AuxSubscriptions, make_subscription
} from './aux-subscriptions.model';
} from './subscriptions.model';
import { observe_useraction } from '@deuso/aux';

@Directive({
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Directive, ElementRef, Input } from '@angular/core';
import { Observable, SubscriptionLike } from 'rxjs';
import {
AuxSubscriptions, aux_subscribe
} from './aux-subscriptions.model';
} from './subscriptions.model';

@Directive({
selector: '[auxSubscribe]'
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion backstop/htdocs/frame.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<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/aux.css" />
<link rel="stylesheet" id=stylesheet href="/styles/main.css" />

HEAD

Expand Down
4 changes: 2 additions & 2 deletions doc/docs/Angular.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ dependency. AUX Widgets are exposed as WebComponents using the v1 WebComponents
is supported in modern browser. To import all AUX Components into an Angular
project add a global import to the top level module.

import '@deuso/aux';
import '@deutschesoft/a.ux';

Importing the standard AUX CSS theme can be done by adding
`node_modules/@deuso/aux/styles/aux.css` to the `styles` list in the
`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
Expand Down
12 changes: 6 additions & 6 deletions doc/docs/Theming.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,25 @@

The AUX widget library comes with a slim default theme, based on the color scheme of the AUX brand. It is split into different layers of CSS to offer a starting point for different approaches. From editing a handful of color variables to low-level theme designs, various development paths are possible.

## aux.css
## main.css

`aux.css` is a variable-based high-level color theme representing the AUX color scheme. If you want to start development out-of-the-box to concentrate on the design later, include this style sheet into your project and start development, it already includes all its dependencies.
`main.css` is a variable-based high-level color theme representing the AUX color scheme. If you want to start development out-of-the-box to concentrate on the design later, include this style sheet into your project and start development, it already includes all its dependencies.

To play around with color schemes add a `<style></style>` section to your main HTML file or add a new CSS file to the project with a copy of the variables section of `aux.css` from the `:root` block at the top of the file. Change the colors to get an impression of different combinations.
To play around with color schemes add a `<style></style>` section to your main HTML file or add a new CSS file to the project with a copy of the variables section of `main.css` from the `:root` block at the top of the file. Change the colors to get an impression of different combinations.

If you need further, minor changes, start overwriting existing definitions in a new file or a `<style></style>` tag.

If you feel the need for heavier intervention, copy `aux.css` to a new location and start editing the new file directly. Include this one instead of `aux.css` into your project and make sure the import of the dependency `basics.css` points to the correct location relative to your new file.
If you feel the need for heavier intervention, copy `main.css` to a new location and start editing the new file directly. Include this one instead of `main.css` into your project and make sure the import of the dependency `basics.css` points to the correct location relative to your new file.

If you find yourself overwriting and correcting a vast amount of rules, creating your own theme might be the better idea.

## basics.css

`basics.css` is a second layer of CSS taking care of lengths like paddings, margins and the like. It is not as high-level as `aux.css`, not as low-level as `essentials.css`, but more like a launch pad for custom themes. Lots of variables at the top of `basics.css` give some control over the general appearance, distinct from the theme design. The main use case is to give widgets some dimensions, positioning and other defaults to make them at least appear on the screen - unstyled but in the right place.
`basics.css` is a second layer of CSS taking care of lengths like paddings, margins and the like. It is not as high-level as `main.css`, not as low-level as `essentials.css`, but more like a launch pad for custom themes. Lots of variables at the top of `basics.css` give some control over the general appearance, distinct from the theme design. The main use case is to give widgets some dimensions, positioning and other defaults to make them at least appear on the screen - unstyled but in the right place.

Use it as a dependency for your own custom theme, overwrite the default variables to make it fit your design ideas or start overwriting/adding rules for more extensive changes.

Maybe your imagination goes way beyond the direction `aux.css` and `basics.css` take and you want to create your own highly customized theme, the only CSS file really needed is `essentials.css`.
Maybe your imagination goes way beyond the direction `main.css` and `basics.css` take and you want to create your own highly customized theme, the only CSS file really needed is `essentials.css`.

## essentials.css

Expand Down
2 changes: 1 addition & 1 deletion examples.html
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@

</script>

<link rel="stylesheet" id=stylesheet href="styles/aux.css" />
<link rel="stylesheet" id=stylesheet href="styles/main.css" />
<link rel="stylesheet" id=stylesheet href="examples/styles.css" />

<style>
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@deutschesoft/aux",
"name": "@deutschesoft/a.ux",
"version": "1.0.10",
"description": "AUX Audio Widget Library",
"description": "A.UX Audio Widget Library",
"main": "src/index.js",
"module": "src/index.js",
"directories": {
Expand Down
File renamed without changes.

0 comments on commit 1e3ded8

Please sign in to comment.