From 93b563098f4711d7111b713aa2b98d82a5ecb091 Mon Sep 17 00:00:00 2001 From: Marcel Werk Date: Sat, 4 May 2024 12:13:14 +0200 Subject: [PATCH] Document `` Closes #405 --- docs/javascript/components_notice.md | 17 +++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 18 insertions(+) create mode 100644 docs/javascript/components_notice.md 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 +Hello World! +``` + +## 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' -- 2.20.1