Document `NoticeFormNode`
authorMarcel Werk <burntime@woltlab.com>
Thu, 25 Apr 2024 12:46:55 +0000 (14:46 +0200)
committerMarcel Werk <burntime@woltlab.com>
Thu, 25 Apr 2024 12:46:55 +0000 (14:46 +0200)
Closes #408

docs/php/api/form_builder/form_fields.md

index 039048bbc0f09fb479437f45f149170074157e27..3f392cd9577943daceb9c0febc7ef206c5a29586 100644 (file)
@@ -169,6 +169,19 @@ These methods do **not**, however, restrict the number of text rows that can be
 The class implements `IAttributeFormField`, `ICssClassFormField`, `IFilterableSelectionFormField`, and `IImmutableFormField`.
 
 
+### `NoticeFormNode`
+
+`NoticeFormNode` is a form node that shows a notice without any surrounding HTML code.
+
+Example:
+
+```php
+NoticeFormNode::create('name')
+  ->type(NoticeFormNodeType::Success)
+  ->languageItem('name_of_language_item');
+```
+
+
 ### `RadioButtonFormField`
 
 `RadioButtonFormField` is a form fields that allows the selection of a single option out of a predefined list of available options using radiobuttons.