This repository has been archived by the owner on Sep 6, 2021. It is now read-only.
#7276 Live Preview highlight customization #12949
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,10 +30,29 @@ | |
| * modules should define a single function that returns an object of all | ||
| * exported functions. | ||
| */ | ||
| function RemoteFunctions(config, remoteWSPort) { | ||
| "use strict"; | ||
|
|
||
| var experimental; | ||
| if (!config) { | ||
| experimental = false; | ||
| } else { | ||
| experimental = config.experimental; | ||
| } | ||
| var lastKeepAliveTime = Date.now(); | ||
| var req, timeout; | ||
| var animateHighlight = function (time) { | ||
| if(req) { | ||
| window.cancelAnimationFrame(req); | ||
| window.clearTimeout(timeout); | ||
| } | ||
| req = window.requestAnimationFrame(redrawHighlights); | ||
|
|
||
| timeout = setTimeout(function () { | ||
| window.cancelAnimationFrame(req); | ||
| req = null; | ||
| }, time * 1000); | ||
| }; | ||
|
|
||
| /** | ||
| * @type {DOMEditHandler} | ||
|
|
@@ -250,17 +269,147 @@ function RemoteFunctions(experimental, remoteWSPort) { | |
| } | ||
| return false; | ||
| }, | ||
| _makeHighlightDiv: function (element, doAnimation) { | ||
| var elementBounds = element.getBoundingClientRect(), | ||
| highlight = window.document.createElement("div"), | ||
| elementStyling = window.getComputedStyle(element), | ||
| transitionDuration = parseFloat(elementStyling.getPropertyValue('transition-duration')), | ||
| animationDuration = parseFloat(elementStyling.getPropertyValue('animation-duration')); | ||
|
|
||
| if (transitionDuration) { | ||
| animateHighlight(transitionDuration); | ||
| } | ||
|
|
||
| if (animationDuration) { | ||
| animateHighlight(animationDuration); | ||
| } | ||
|
|
||
| // Don't highlight elements with 0 width & height | ||
| if (elementBounds.width === 0 && elementBounds.height === 0) { | ||
| return; | ||
| } | ||
|
|
||
| var realElBorder = { | ||
| right: elementStyling.getPropertyValue('border-right-width'), | ||
| left: elementStyling.getPropertyValue('border-left-width'), | ||
| top: elementStyling.getPropertyValue('border-top-width'), | ||
| bottom: elementStyling.getPropertyValue('border-bottom-width') | ||
| }; | ||
|
|
||
| var innerWidth = elementBounds.width - parseInt(realElBorder.left) - parseInt(realElBorder.right); | ||
| var innerHeight = elementBounds.height - parseInt(realElBorder.top) - parseInt(realElBorder.bottom); | ||
|
|
||
| var visualisations = { | ||
| horizontal: "left, right", | ||
| vertical: "top, bottom" | ||
| }; | ||
|
|
||
| var drawPaddingRect = function(side) { | ||
| var elStyling = {}; | ||
|
|
||
| if (visualisations.horizontal.indexOf(side) >= 0) { | ||
| elStyling['width'] = elementStyling.getPropertyValue('padding-' + side); | ||
| elStyling['height'] = innerHeight + "px"; | ||
| elStyling['top'] = realElBorder.top; | ||
|
|
||
| } else { | ||
| elStyling['height'] = elementStyling.getPropertyValue('padding-' + side); | ||
| elStyling['width'] = innerWidth + "px"; | ||
| elStyling['left'] = realElBorder.left; | ||
| } | ||
|
|
||
| elStyling[side] = realElBorder[side]; | ||
| elStyling['position'] = 'absolute'; | ||
|
|
||
| return elStyling; | ||
| }; | ||
|
|
||
| var drawMarginRect = function(side) { | ||
| var elStyling = {}; | ||
|
|
||
| var margin = []; | ||
| margin['right'] = parseInt(elementStyling.getPropertyValue('margin-right')); | ||
| margin['top'] = parseInt(elementStyling.getPropertyValue('margin-top')); | ||
| margin['bottom'] = parseInt(elementStyling.getPropertyValue('margin-bottom')); | ||
| margin['left'] = parseInt(elementStyling.getPropertyValue('margin-left')); | ||
|
|
||
|
|
||
| if(visualisations['horizontal'].indexOf(side) >= 0) { | ||
| elStyling['width'] = elementStyling.getPropertyValue('margin-' + side); | ||
| elStyling['height'] = elementBounds.height + margin['top'] + margin['bottom'] + "px"; | ||
| elStyling['top'] = "-" + margin['top'] + "px"; | ||
|
|
||
| } else { | ||
| elStyling['height'] = elementStyling.getPropertyValue('margin-' + side); | ||
| elStyling['width'] = elementBounds.width + "px"; | ||
| elStyling['left'] = 0; | ||
| } | ||
|
|
||
| elStyling[side] = "-" + margin[side] + "px"; | ||
| elStyling['position'] = 'absolute'; | ||
|
|
||
| return elStyling; | ||
| }; | ||
|
|
||
| var setVisibility = function (el) { | ||
| if ( | ||
| !config.remoteHighlight.showPaddingMargin || | ||
| parseInt(el.height, 10) <= 0 || | ||
| parseInt(el.width, 10) <= 0 | ||
| ) { | ||
| el.display = 'none'; | ||
| } else { | ||
| el.display = 'block'; | ||
| } | ||
| }; | ||
|
|
||
| var mainBoxStyles = config.remoteHighlight.stylesToSet; | ||
| mainBoxStyles['border'] = 'none'; | ||
|
|
||
| var paddingVisualisations = [ | ||
| drawPaddingRect('top'), | ||
| drawPaddingRect('right'), | ||
| drawPaddingRect('bottom'), | ||
| drawPaddingRect('left') | ||
| ]; | ||
|
|
||
| var marginVisualisations = [ | ||
| drawMarginRect('top'), | ||
| drawMarginRect('right'), | ||
| drawMarginRect('bottom'), | ||
| drawMarginRect('left') | ||
| ]; | ||
|
|
||
| var setupVisualisations = function (arr, config) { | ||
| var i; | ||
| for (i = 0; i < arr.length; i++) { | ||
| setVisibility(arr[i]); | ||
|
|
||
| // Applies to every visualisationElement (padding or margin div) | ||
| arr[i]["box-sizing"] = "border-box"; | ||
| arr[i]["transform"] = "none"; | ||
| var el = window.document.createElement("div"), | ||
| styles = Object.assign( | ||
| {}, | ||
| config, | ||
| arr[i] | ||
| ); | ||
|
|
||
| _setStyleValues(styles, el.style); | ||
|
|
||
| highlight.appendChild(el); | ||
| } | ||
| }; | ||
|
|
||
| setupVisualisations( | ||
| marginVisualisations, | ||
| config.remoteHighlight.marginStyling | ||
| ); | ||
| setupVisualisations( | ||
| paddingVisualisations, | ||
| config.remoteHighlight.paddingStyling | ||
| ); | ||
|
|
||
| highlight.className = HIGHLIGHT_CLASSNAME; | ||
|
|
||
| var offset = _screenOffset(element); | ||
|
|
@@ -275,31 +424,25 @@ function RemoteFunctions(experimental, remoteWSPort) { | |
| "padding": 0, | ||
| "position": "absolute", | ||
| "pointer-events": "none", | ||
| "border-top-left-radius": elementStyling.borderTopLeftRadius, | ||
| "border-top-right-radius": elementStyling.borderTopRightRadius, | ||
| "border-bottom-left-radius": elementStyling.borderBottomLeftRadius, | ||
| "border-bottom-right-radius": elementStyling.borderBottomRightRadius, | ||
| "border-style": "solid", | ||
| "border-width": "1px", | ||
| "border-color": "#00a2ff", | ||
| "box-shadow": "0 0 1px #fff", | ||
| "box-sizing": "border-box" | ||
| }; | ||
|
|
||
| var mergedStyles = Object.assign({}, stylesToSet, config.remoteHighlight.stylesToSet); | ||
|
There was a problem hiding this comment. I think Object.assign is not available on Linux (which uses Chrome 29). You could try to use lodash assign or extend instead. There was a problem hiding this comment. Argh, you are right @ficristo. The age old Linux version is starting to become the IE8 of Brackets 😭 There was a problem hiding this comment. Those are remote functions, so I cannot use I've left it as There was a problem hiding this comment. Actually as they are remote functions that are run on the browser, we can just use There was a problem hiding this comment. You mean a real browser and not Brackets itself, right? (Not much familiar with LivePreview) There was a problem hiding this comment. I cant test it on Linux, but it works well on OSX. Edit: Yeah, those are run in real browser. |
||
|
|
||
| var animateStartValues = config.remoteHighlight.animateStartValue; | ||
|
|
||
| var animateEndValues = config.remoteHighlight.animateEndValue; | ||
|
|
||
| var transitionValues = { | ||
| "transition-property": "opacity, background-color, transform", | ||
| "transition-duration": "300ms, 2.3s" | ||
| }; | ||
|
|
||
|
|
@@ -311,7 +454,7 @@ function RemoteFunctions(experimental, remoteWSPort) { | |
| } | ||
| } | ||
|
|
||
| _setStyleValues(mergedStyles, highlight.style); | ||
| _setStyleValues( | ||
| doAnimation ? animateStartValues : animateEndValues, | ||
| highlight.style | ||
|
|
@@ -842,6 +985,11 @@ function RemoteFunctions(experimental, remoteWSPort) { | |
| function getSimpleDOM() { | ||
| return JSON.stringify(_domElementToJSON(window.document.documentElement)); | ||
| } | ||
|
|
||
| function updateConfig(newConfig) { | ||
| config = JSON.parse(newConfig); | ||
| return JSON.stringify(config); | ||
| } | ||
|
|
||
| // init | ||
| _editHandler = new DOMEditHandler(window.document); | ||
|
|
@@ -894,6 +1042,7 @@ function RemoteFunctions(experimental, remoteWSPort) { | |
| "highlightRule" : highlightRule, | ||
| "redrawHighlights" : redrawHighlights, | ||
| "applyDOMEdits" : applyDOMEdits, | ||
| "getSimpleDOM" : getSimpleDOM, | ||
| "updateConfig" : updateConfig | ||
| }; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can pass remoteWSPort as part of config only, something like
config.remoteWSPort.Then instead of checking for
remoteWSPortin https://github.com/adobe/brackets/pull/12949/files#diff-a40df952af8fd1808c321dab548ae11aR1032, we can check for!experimentalflag as we create websocket only when we are not using experimental live preview.But I think you can leave this for later as you might have to make changes which are not relevant for this feature, once this is merged I can make the above changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi, you're right. Unfortunetely I won't be accessible for a while, so I guess we could close this one and open new PRs as necessary, if that's OK.