浏览代码

Docs: Update dropdown buttons documentation.

Maciej Gołaszewski 7 年之前
父节点
当前提交
ca0f4cf918

+ 2 - 2
packages/ckeditor5-ui/src/dropdown/dropdownbuttoninterface.jsdoc

@@ -4,13 +4,13 @@
  */
 
 /**
- * @module ui/dropdown/dropdownbuttoninterface
+ * @module ui/dropdown/button/dropdownbuttoninterface
  */
 
 /**
  * The dropdown button interface.
  *
- * @interface module:ui/dropdown/dropdownbuttoninterface~DropdownButtonInterface
+ * @interface module:ui/dropdown/button/dropdownbuttoninterface~DropdownButtonInterface
  * @extends module:ui/button/buttoninterface~ButtonInterface
  */
 

+ 3 - 1
packages/ckeditor5-ui/src/dropdown/button/dropdownbuttonview.js

@@ -27,8 +27,10 @@ import IconView from '../../icon/iconview';
  *
  *		document.body.append( view.element );
  *
+ * Also see {@link module:ui/dropdown/utils~createDropdown}.
+ *
  * @extends module:ui/view~View
- * @implements module:ui/dropdown/dropdownbuttoninterface~DropdownButtonInterface
+ * @implements module:ui/dropdown/button/dropdownbuttoninterface~DropdownButtonInterface
  */
 export default class DropdownButtonView extends ButtonView {
 	/**

+ 4 - 2
packages/ckeditor5-ui/src/dropdown/button/splitbuttonview.js

@@ -15,7 +15,7 @@ import FocusTracker from '@ckeditor/ckeditor5-utils/src/focustracker';
 
 import dropdownArrowIcon from '../../../theme/icons/dropdown-arrow.svg';
 
-import '../../../theme/components/button/splitbutton.css';
+import '../../../theme/components/dropdown/splitbutton.css';
 
 /**
  * The split button view class.
@@ -32,8 +32,10 @@ import '../../../theme/components/button/splitbutton.css';
  *
  *		document.body.append( view.element );
  *
+ * Also see {@link module:ui/dropdown/utils~createDropdown}.
+ *
  * @extends module:ui/view~View
- * @implements module:ui/dropdown/dropdownbuttoninterface~DropdownButtonInterface
+ * @implements module:ui/dropdown/button/dropdownbuttoninterface~DropdownButtonInterface
  */
 export default class SplitButtonView extends View {
 	/**

+ 5 - 19
packages/ckeditor5-ui/src/dropdown/utils.js

@@ -20,7 +20,7 @@ import '../../theme/components/dropdown/toolbardropdown.css';
 
 /**
  * A helper which creates an instance of {@link module:ui/dropdown/dropdownview~DropdownView} class with an instance of
- * a button class passed as `ButtonClass` parameter`
+ * a button class passed as `ButtonClass` parameter.
  *
  * The default value of `ButtonClass` is {@link module:ui/dropdown/button/dropdownbuttonview~DropdownButtonView} class.
  *
@@ -39,28 +39,14 @@ import '../../theme/components/dropdown/toolbardropdown.css';
  *		// Will render a dropdown labeled "A dropdown" with an empty panel.
  *		document.body.appendChild( dropdown.element );
  *
- * The second supported button class is {@link module:ui/dropdown/button/splitbuttonview~SplitButtonView}
- *
- *		import SplitButtonView from '@ckeditor/ckeditor5-ui/src/dropdown/button/splitbuttonview';
- *
- *		const dropdown = createDropdown( model, SplitButtonView );
- *
- *		// Configure dropdown properties:
- *		dropdown.set( {
- *			label: 'A dropdown',
- *			isEnabled: true,
- *			isOn: false
- *		} );
- *
- *		dropdown.render();
- *
- *		// Will render a dropdown labeled "A dropdown" with an empty panel.
- *		document.body.appendChild( dropdown.element );
+ * The supported button classes for dropdown are:
+ * * {@link module:ui/dropdown/button/dropdownbuttonview~DropdownButtonView}
+ * * {@link module:ui/dropdown/button/splitbuttonview~SplitButtonView}
  *
  * Also see {@link module:ui/dropdown/utils~addListToDropdown} and {@link module:ui/dropdown/utils~addToolbarToDropdown}.
  *
  * @param {module:utils/locale~Locale} locale The locale instance.
- * @param {Function} ButtonClass The dropdown button view class.
+ * @param {module:ui/dropdown/button/dropdownbuttoninterface~DropdownButtonInterface} ButtonClass The dropdown button view class.
  * @returns {module:ui/dropdown/dropdownview~DropdownView} The dropdown view instance.
  */
 export function createDropdown( locale, ButtonClass = DropdownButtonView ) {

packages/ckeditor5-ui/theme/components/button/splitbutton.css → packages/ckeditor5-ui/theme/components/dropdown/splitbutton.css