blob: 9033dc46aece3a6bcb4b04242280686225f119c0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/* 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
);
};
},
};
|
