From: Marcel Werk <burntime@woltlab.com>
Date: Sat, 4 May 2024 10:13:14 +0000 (+0200)
Subject: Document `<woltlab-core-notice>`
X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=93b563098f4711d7111b713aa2b98d82a5ecb091;p=GitHub%2FWoltLab%2Fwoltlab.github.io.git

Document `<woltlab-core-notice>`

Closes #405
---

diff --git a/docs/javascript/components_notice.md b/docs/javascript/components_notice.md
new file mode 100644
index 00000000..0a153a52
--- /dev/null
+++ b/docs/javascript/components_notice.md
@@ -0,0 +1,17 @@
+# Notices - JavaScript API
+
+The notice component can be used to show text notices for the user.
+The type of the notice can be controlled depending on the `type` parameter.
+
+## Example
+
+```html
+<woltlab-core-notice type="info">Hello World!</woltlab-core-notice>
+```
+
+## Parameters
+
+### `type`
+
+Controls the type of a notice (color and displayed icon).
+The following values are available: `info`, `success`, `warning`, `error`
diff --git a/mkdocs.yml b/mkdocs.yml
index 02e74b73..eecf3247 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -62,6 +62,7 @@ nav:
           - 'Confirmation': 'javascript/components_confirmation.md'
           - 'Dialog': 'javascript/components_dialog.md'
           - 'Google Maps': 'javascript/components_google_maps.md'
+          - 'Notices': 'javascript/components_notice.md'
           - 'Pagination': 'javascript/components_pagination.md'
       - 'New API':
           - 'Writing a module': 'javascript/new-api_writing-a-module.md'