Explorar el Código

Extend the component description

panr hace 5 años
padre
commit
95285ab140
Se han modificado 1 ficheros con 9 adiciones y 1 borrados
  1. 9 1
      packages/ckeditor5-ui/src/formheader/formheaderview.js

+ 9 - 1
packages/ckeditor5-ui/src/formheader/formheaderview.js

@@ -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.
  * 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 {