86 lines
2.5 KiB
JavaScript
86 lines
2.5 KiB
JavaScript
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
"use strict";
|
|
|
|
/**
|
|
* This module exports thunks.
|
|
* Thunks are functions that can be dispatched to the Inspector Redux store.
|
|
*
|
|
* These functions receive one object with options that contains:
|
|
* - dispatch() => function to dispatch Redux actions to the store
|
|
* - getState() => function to get the current state of the entire Inspector Redux store
|
|
* - inspector => object instance of Inspector client
|
|
*
|
|
* They provide a shortcut for React components to invoke the box model highlighter
|
|
* without having to know where the highlighter exists.
|
|
*/
|
|
|
|
module.exports = {
|
|
/**
|
|
* Show the box model highlighter for the currently selected node front.
|
|
* The selected node is obtained from the Selection instance on the Inspector.
|
|
*
|
|
* @param {Object} options
|
|
* Optional configuration options passed to the box model highlighter
|
|
*/
|
|
highlightSelectedNode(options = {}) {
|
|
return async thunkOptions => {
|
|
const { inspector } = thunkOptions;
|
|
if (!inspector || inspector._destroyed) {
|
|
return;
|
|
}
|
|
|
|
const { nodeFront } = inspector.selection;
|
|
if (!nodeFront) {
|
|
return;
|
|
}
|
|
|
|
await inspector.highlighters.showHighlighterTypeForNode(
|
|
inspector.highlighters.TYPES.BOXMODEL,
|
|
nodeFront,
|
|
options
|
|
);
|
|
};
|
|
},
|
|
|
|
/**
|
|
* Show the box model highlighter for the given node front.
|
|
*
|
|
* @param {NodeFront} nodeFront
|
|
* Node that should be highlighted.
|
|
* @param {Object} options
|
|
* Optional configuration options passed to the box model highlighter
|
|
*/
|
|
highlightNode(nodeFront, options = {}) {
|
|
return async thunkOptions => {
|
|
const { inspector } = thunkOptions;
|
|
if (!inspector || inspector._destroyed) {
|
|
return;
|
|
}
|
|
|
|
await inspector.highlighters.showHighlighterTypeForNode(
|
|
inspector.highlighters.TYPES.BOXMODEL,
|
|
nodeFront,
|
|
options
|
|
);
|
|
};
|
|
},
|
|
|
|
/**
|
|
* Hide the box model highlighter for any highlighted node.
|
|
*/
|
|
unhighlightNode() {
|
|
return async thunkOptions => {
|
|
const { inspector } = thunkOptions;
|
|
if (!inspector || inspector._destroyed) {
|
|
return;
|
|
}
|
|
|
|
await inspector.highlighters.hideHighlighterType(
|
|
inspector.highlighters.TYPES.BOXMODEL
|
|
);
|
|
};
|
|
},
|
|
};
|