Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

I/6109: Add FormHeaderView component #546

Merged
merged 12 commits into from
Mar 26, 2020
10 changes: 9 additions & 1 deletion src/formheader/formheaderview.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,18 @@ import View from '../view';
import '../../theme/components/formheader/formheader.css';

/**
* The class representing a form header view, used i.a.
* The class component representing a form header view. It should be used in more advanced forms to
* describe the main purpose of the form.
*
* By default the component contains bolded label view which have to be set. The label is usually a short (at most 3-word) string.
* The component can also be extended by any other elements, like: icons, dropdowns etc.
*
* It is used i.a.
jodator marked this conversation as resolved.
Show resolved Hide resolved
* by {@link module:table/tablecellproperties/ui/tablecellpropertiesview~TableCellPropertiesView}
* and {@link module:special-characters/ui/specialcharactersnavigationview~SpecialCharactersNavigationView}.
*
* The latter is an example, where the component has been extended by {@link module:ui/dropdown/dropdownview~DropdownView} view.
*
* @extends module:ui/view~View
*/
export default class FormHeaderView extends View {
Expand Down