grapesjs_codeapps/docs/api/panels.md

Free and Open Source Web Builder Framework/SC Modification

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

## Panels

You can customize the initial state of the module from the editor initialization, by passing the following [Configuration Object][1]

```js
const editor = grapesjs.init({
 panels: {
   // options
 }
})
```

Once the editor is instantiated you can use its API. Before using these methods you should get the module from the instance

```js
const panelManager = editor.Panels;
```

-   [addPanel][2]
-   [addButton][3]
-   [removeButton][4]
-   [getButton][5]
-   [getPanel][6]
-   [getPanels][7]
-   [getPanelsEl][8]
-   [removePanel][9]
-   [removeButton][10]

## getPanels

Returns the collection of panels

Returns **Collection** Collection of panel

## getPanelsEl

Returns panels element

Returns **[HTMLElement][11]** 

## addPanel

Add new panel to the collection

### Parameters

-   `panel` **([Object][12] | Panel)** Object with right properties or an instance of Panel

### Examples

```javascript
var newPanel = panelManager.addPanel({
  id: 'myNewPanel',
 visible  : true,
 buttons  : [...],
});
```

Returns **Panel** Added panel. Useful in case passed argument was an Object

## removePanel

Remove a panel from the collection

### Parameters

-   `panel` **([Object][12] | Panel | [String][13])** Object with right properties or an instance of Panel or Painel id

### Examples

```javascript
const newPanel = panelManager.removePanel({
  id: 'myNewPanel',
 visible  : true,
 buttons  : [...],
});

const newPanel = panelManager.removePanel('myNewPanel');
```

Returns **Panel** Removed panel. Useful in case passed argument was an Object

## getPanel

Get panel by ID

### Parameters

-   `id` **[string][13]** Id string

### Examples

```javascript
var myPanel = panelManager.getPanel('myNewPanel');
```

Returns **(Panel | null)** 

## addButton

Add button to the panel

### Parameters

-   `panelId` **[string][13]** Panel's ID
-   `button` **([Object][12] | Button)** Button object or instance of Button

### Examples

```javascript
var newButton = panelManager.addButton('myNewPanel',{
  id: 'myNewButton',
  className: 'someClass',
  command: 'someCommand',
  attributes: { title: 'Some title'},
  active: false,
});
// It's also possible to pass the command as an object
// with .run and .stop methods
...
command: {
  run: function(editor) {
    ...
  },
  stop: function(editor) {
    ...
  }
},
// Or simply like a function which will be evaluated as a single .run command
...
command: function(editor) {
  ...
}
```

Returns **(Button | null)** Added button. Useful in case passed button was an Object

## removeButton

Remove button from the panel

### Parameters

-   `panelId` **[string][13]** Panel's ID
-   `button` **([Object][12] | Button | [String][13])** Button object or instance of Button or button id

### Examples

```javascript
const removedButton = panelManager.removeButton('myNewPanel',{
  id: 'myNewButton',
  className: 'someClass',
  command: 'someCommand',
  attributes: { title: 'Some title'},
  active: false,
});

// It's also possible to use the button id
const removedButton = panelManager.removeButton('myNewPanel','myNewButton');
```

Returns **(Button | null)** Removed button.

## getButton

Get button from the panel

### Parameters

-   `panelId` **[string][13]** Panel's ID
-   `id` **[string][13]** Button's ID

### Examples

```javascript
var button = panelManager.getButton('myPanel','myButton');
```

Returns **(Button | null)** 

[1]: https://github.com/artf/grapesjs/blob/master/src/panels/config/config.js

[2]: #addpanel

[3]: #addbutton

[4]: #removebutton

[5]: #getbutton

[6]: #getpanel

[7]: #getpanels

[8]: #getpanelsel

[9]: #removepanel

[10]: #removeButton

[11]: https://developer.mozilla.org/docs/Web/HTML/Element

[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

[13]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String