Bug 1461522 - Update comments in ToolboxToolbar.js; r?jdescottes
MozReview-Commit-ID: 18EJzeao8Xq
--- a/devtools/client/framework/components/ToolboxToolbar.js
+++ b/devtools/client/framework/components/ToolboxToolbar.js
@@ -37,30 +37,31 @@ class ToolboxToolbar extends Component {
// List of possible docking options.
hostTypes: PropTypes.arrayOf(PropTypes.shape({
position: PropTypes.string.isRequired,
switchHost: PropTypes.func.isRequired,
})),
// Current docking type. Typically one of the position values in
// |hostTypes| but this is not always the case (e.g. when it is "custom").
currentHostType: PropTypes.string,
+ // Are docking options enabled? They are not enabled in certain situations
+ // like when they are in the WebIDE.
+ areDockOptionsEnabled: PropTypes.bool,
// Do we need to add UI for closing the toolbox? We don't when the
// toolbox is undocked, for example.
canCloseToolbox: PropTypes.bool,
// Is the split console currently visible?
isSplitConsoleActive: PropTypes.bool,
// Are we disabling the behavior where pop-ups are automatically closed
// when clicking outside them?
//
// This is a tri-state value that may be true/false or undefined where
// undefined means that the option is not relevant in this context
// (i.e. we're not in a browser toolbox).
disableAutohide: PropTypes.bool,
- // Function to select a tool based on its id.
- selectTool: PropTypes.func,
// Function to turn the options panel on / off.
toggleOptions: PropTypes.func.isRequired,
// Function to turn the split console on / off.
toggleSplitConsole: PropTypes.func,
// Function to turn the disable pop-up autohide behavior on / off.
toggleNoAutohide: PropTypes.func,
// Function to completely close the toolbox.
closeToolbox: PropTypes.func,
@@ -70,20 +71,20 @@ class ToolboxToolbar extends Component {
// it to render nicely.
canRender: PropTypes.bool,
// Localization interface.
L10N: PropTypes.object,
// The devtools toolbox
toolbox: PropTypes.object,
// Call back function to detect tabs order updated.
onTabsOrderUpdated: PropTypes.func.isRequired,
- // Count of visible toolbox buttons which is used by ToolboxTabs component to
- // recognize that the visibility of toolbox buttons were changed. Because in the
- // component we cannot compare the visibility since the button definition instance
- // in toolboxButtons will be unchanged.
+ // Count of visible toolbox buttons which is used by ToolboxTabs component
+ // to recognize that the visibility of toolbox buttons were changed.
+ // Because in the component we cannot compare the visibility since the
+ // button definition instance in toolboxButtons will be unchanged.
visibleToolboxButtonCount: PropTypes.number,
};
}
/**
* The render function is kept fairly short for maintainability. See the individual
* render functions for how each of the sections is rendered.
*/