[ADD] CSS cursor classes docs

This commit is contained in:
Peter Pfeufer 2023-11-12 11:16:44 +01:00
parent d2edd288f9
commit cbb5c80b94
No known key found for this signature in database
GPG Key ID: 6051D2C6AD4EBC27
14 changed files with 72 additions and 43 deletions

View File

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.5 KiB

View File

@ -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
```

View File

@ -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
<div class="aa-callout aa-callout-success">
<p>
This is a success callout-box.
</p>
</div>
<div class="aa-callout aa-callout-info">
<p>
This is an info callout-box.
</p>
</div>
<div class="aa-callout aa-callout-warning">
<p>
This is a warning callout-box.
</p>
</div>
<div class="aa-callout aa-callout-danger">
<p>
This is a danger callout-box.
</p>
</div>
```

View File

@ -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
<div class="aa-callout aa-callout-success">
<p>
This is a success callout-box.
</p>
</div>
<div class="aa-callout aa-callout-info">
<p>
This is an info callout-box.
</p>
</div>
<div class="aa-callout aa-callout-warning">
<p>
This is a warning callout-box.
</p>
</div>
<div class="aa-callout aa-callout-danger">
<p>
This is a danger callout-box.
</p>
</div>
```

View File

@ -9,5 +9,5 @@ integrating-services
menu-hooks menu-hooks
url-hooks url-hooks
logging logging
css-framework aa-framework
::: :::