diff options
Diffstat (limited to 'devtools/client/inspector/flexbox/actions/flexbox-highlighter.js')
-rw-r--r-- | devtools/client/inspector/flexbox/actions/flexbox-highlighter.js | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/devtools/client/inspector/flexbox/actions/flexbox-highlighter.js b/devtools/client/inspector/flexbox/actions/flexbox-highlighter.js new file mode 100644 index 0000000000..487a4c3b12 --- /dev/null +++ b/devtools/client/inspector/flexbox/actions/flexbox-highlighter.js @@ -0,0 +1,39 @@ +/* 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 panel + * + * They provide a shortcut for React components to invoke the flexbox highlighter + * without having to know where the highlighter exists. + */ + +module.exports = { + /** + * Toggle the flexbox highlighter for the given node front. + * + * @param {NodeFront} nodeFront + * Node for which the highlighter should be toggled. + * @param {String} reason + * Reason why the highlighter was toggled; used in telemetry. + */ + toggleFlexboxHighlighter(nodeFront, reason) { + return async thunkOptions => { + const { inspector } = thunkOptions; + if (!inspector || inspector._destroyed) { + return; + } + + await inspector.highlighters.toggleFlexboxHighlighter(nodeFront, reason); + }; + }, +}; |