Browse Source

Update panels API docs

pull/1594/head
Artur Arseniev 8 years ago
parent
commit
51de53076f
  1. 12
      src/panels/index.js

12
src/panels/index.js

@ -16,13 +16,12 @@
* *
* * [addPanel](#addpanel) * * [addPanel](#addpanel)
* * [addButton](#addbutton) * * [addButton](#addbutton)
* * [removeButton](#removebutton)
* * [getButton](#getbutton) * * [getButton](#getbutton)
* * [getPanel](#getpanel) * * [getPanel](#getpanel)
* * [getPanels](#getpanels) * * [getPanels](#getpanels)
* * [getPanelsEl](#getpanelsel) * * [getPanelsEl](#getpanelsel)
* * [removePanel](#removepanel) * * [removePanel](#removepanel)
* * [removeButton](#removeButton) * * [removeButton](#removebutton)
* *
* @module Panels * @module Panels
*/ */
@ -164,11 +163,11 @@ module.exports = () => {
/** /**
* Remove button from the panel * Remove button from the panel
* @param {string} panelId Panel's ID * @param {String} panelId Panel's ID
* @param {Object|Button|String} button Button object or instance of Button or button id * @param {String} buttonId Button's ID
* @return {Button|null} Removed button. * @return {Button|null} Removed button.
* @example * @example
* const removedButton = panelManager.removeButton('myNewPanel',{ * const removedButton = panelManager.addButton('myNewPanel',{
* id: 'myNewButton', * id: 'myNewButton',
* className: 'someClass', * className: 'someClass',
* command: 'someCommand', * command: 'someCommand',
@ -176,8 +175,7 @@ module.exports = () => {
* active: false, * active: false,
* }); * });
* *
* // It's also possible to use the button id * const removedButton = panelManager.removeButton('myNewPanel', 'myNewButton');
* const removedButton = panelManager.removeButton('myNewPanel','myNewButton');
* *
*/ */
removeButton(panelId, button) { removeButton(panelId, button) {

Loading…
Cancel
Save