diff --git a/docs/_static/images/development/css-framework/callout-boxes.png b/docs/_static/images/development/aa-framework/css/callout-boxes.png similarity index 100% rename from docs/_static/images/development/css-framework/callout-boxes.png rename to docs/_static/images/development/aa-framework/css/callout-boxes.png diff --git a/docs/_static/images/development/aa-framework/css/cursor-default.png b/docs/_static/images/development/aa-framework/css/cursor-default.png new file mode 100644 index 00000000..37927e8b Binary files /dev/null and b/docs/_static/images/development/aa-framework/css/cursor-default.png differ diff --git a/docs/_static/images/development/aa-framework/css/cursor-help.png b/docs/_static/images/development/aa-framework/css/cursor-help.png new file mode 100644 index 00000000..9925ec56 Binary files /dev/null and b/docs/_static/images/development/aa-framework/css/cursor-help.png differ diff --git a/docs/_static/images/development/aa-framework/css/cursor-move.png b/docs/_static/images/development/aa-framework/css/cursor-move.png new file mode 100644 index 00000000..1fde4390 Binary files /dev/null and b/docs/_static/images/development/aa-framework/css/cursor-move.png differ diff --git a/docs/_static/images/development/aa-framework/css/cursor-not-allowed.png b/docs/_static/images/development/aa-framework/css/cursor-not-allowed.png new file mode 100644 index 00000000..63e5ec47 Binary files /dev/null and b/docs/_static/images/development/aa-framework/css/cursor-not-allowed.png differ diff --git a/docs/_static/images/development/aa-framework/css/cursor-pointer.png b/docs/_static/images/development/aa-framework/css/cursor-pointer.png new file mode 100644 index 00000000..68b0c179 Binary files /dev/null and b/docs/_static/images/development/aa-framework/css/cursor-pointer.png differ diff --git a/docs/_static/images/development/aa-framework/css/cursor-text.png b/docs/_static/images/development/aa-framework/css/cursor-text.png new file mode 100644 index 00000000..10de6e23 Binary files /dev/null and b/docs/_static/images/development/aa-framework/css/cursor-text.png differ diff --git a/docs/_static/images/development/aa-framework/css/cursor-wait.png b/docs/_static/images/development/aa-framework/css/cursor-wait.png new file mode 100644 index 00000000..5f926d66 Binary files /dev/null and b/docs/_static/images/development/aa-framework/css/cursor-wait.png differ diff --git a/docs/_static/images/development/aa-framework/css/cursor-zoom-in.png b/docs/_static/images/development/aa-framework/css/cursor-zoom-in.png new file mode 100644 index 00000000..d12cc98d Binary files /dev/null and b/docs/_static/images/development/aa-framework/css/cursor-zoom-in.png differ diff --git a/docs/_static/images/development/aa-framework/css/cursor-zoom-out.png b/docs/_static/images/development/aa-framework/css/cursor-zoom-out.png new file mode 100644 index 00000000..3d89db5b Binary files /dev/null and b/docs/_static/images/development/aa-framework/css/cursor-zoom-out.png differ diff --git a/docs/development/custom/aa-framework.md b/docs/development/custom/aa-framework.md new file mode 100644 index 00000000..924026fe --- /dev/null +++ b/docs/development/custom/aa-framework.md @@ -0,0 +1,11 @@ +# AA Framework + +To establish a unified style language throughout Alliance Auth and Community Apps, +Alliance Auth is providing its own CSS framework with a couple of CSS classes. + +```eval_rst +.. toctree:: + :maxdepth: 1 + + framework/css +``` diff --git a/docs/development/custom/css-framework.md b/docs/development/custom/css-framework.md deleted file mode 100644 index 74327d36..00000000 --- a/docs/development/custom/css-framework.md +++ /dev/null @@ -1,42 +0,0 @@ -# CSS Framework - -To establish a unified style language throughout Alliance Auth and Community Apps, -Alliance Auth is providing its own CSS framework with a couple of CSS classes. - -## Callout-Boxes - -These are similar to the Bootstrap alert/notification boxes, but not as "loud". - -Callout-boxes need a base-class (`.aa-callout`) and a modifier-class (e.g.: -`.aa-callout-info` for an info-box). Modifier classes are available for the usual -Bootstrap alert levels "Success", "Info", "Warning" and "Danger". - -![Alliance Auth Framework: Callout Boxes](/_static/images/development/css-framework/callout-boxes.png "Alliance Auth Framework: Callout Boxes") - -### HTML - -```html -
-

- This is a success callout-box. -

-
- -
-

- This is an info callout-box. -

-
- -
-

- This is a warning callout-box. -

-
- -
-

- This is a danger callout-box. -

-
-``` diff --git a/docs/development/custom/framework/css.md b/docs/development/custom/framework/css.md new file mode 100644 index 00000000..54250f8a --- /dev/null +++ b/docs/development/custom/framework/css.md @@ -0,0 +1,60 @@ +# CSS Framework + +To establish a unified style language throughout Alliance Auth and Community Apps, +Alliance Auth is providing its own CSS framework with a couple of CSS classes. + +## Cursor + +Our CSS framework provides different classes to manipulate the cursor, which are +missing in Bootstrap. + +| CSS Class | Effect | Example | +|----------------------|--------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| `cursor-default` | System default curser | ![Cursor: Default](/_static/images/development/aa-framework/css/cursor-default.png "Cursor: Default") | +| `cursor-pointer` | Pointer, like it looks like for links and form buttons | ![Cursor: Pointer](/_static/images/development/aa-framework/css/cursor-pointer.png "Cursor: Pointer") | +| `cursor-wait` | Wait animation | ![Cursor: Wait](/_static/images/development/aa-framework/css/cursor-wait.png "Cursor: Wait") | +| `cursor-text` | Text selection cursor | ![Cursor: Text](/_static/images/development/aa-framework/css/cursor-text.png "Cursor: Text") | +| `cursor-move` | 4-arraow-shaped cursor | ![Cursor: Move](/_static/images/development/aa-framework/css/cursor-move.png "Cursor: Move") | +| `cursor-help` | Cursor with a little questionmark | ![Cursor: Help](/_static/images/development/aa-framework/css/cursor-help.png "Cursor: Help") | +| `cursor-not-allowed` | Not Allowed sign | ![Cursor: Not Allowed](/_static/images/development/aa-framework/css/cursor-not-allowed.png "Cursor: Not Allowed") | +| `cursor-inherit` | Inherited from its parent element | | +| `cursor-zoom-in` | Zoom in symbol | ![Cursor: Zoom In](/_static/images/development/aa-framework/css/cursor-zoom-in.png "Cursor: Zoom In") | +| `cursor-zoom-out` | Zoom out symbol | ![Alliance Auth Framework: Callout Boxes](/_static/images/development/aa-framework/css/cursor-zoom-out "Alliance Auth Framework: Callout Boxes") | + +## Callout-Boxes + +These are similar to the Bootstrap alert/notification boxes, but not as "loud". + +Callout-boxes need a base-class (`.aa-callout`) and a modifier-class (e.g.: +`.aa-callout-info` for an info-box). Modifier classes are available for the usual +Bootstrap alert levels "Success", "Info", "Warning" and "Danger". + +![Alliance Auth Framework: Callout Boxes](/_static/images/development/aa-framework/css/callout-boxes.png "Alliance Auth Framework: Callout Boxes") + +### HTML + +```html +
+

+ This is a success callout-box. +

+
+ +
+

+ This is an info callout-box. +

+
+ +
+

+ This is a warning callout-box. +

+
+ +
+

+ This is a danger callout-box. +

+
+``` diff --git a/docs/development/custom/index.md b/docs/development/custom/index.md index 05b9bc00..8de54f49 100644 --- a/docs/development/custom/index.md +++ b/docs/development/custom/index.md @@ -9,5 +9,5 @@ integrating-services menu-hooks url-hooks logging -css-framework +aa-framework :::