-
-
Notifications
You must be signed in to change notification settings - Fork 977
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Version 5.0.0 #1212
Merged
Merged
Version 5.0.0 #1212
Conversation
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
New documentation site
Upgrade
For the most part version 5 will be a drop in replacement. The following guide explains how the API has been simplified in the new version.
New features
getParentProperties()
function that returns the following information from the parent page:offsetHeight
&offsetWidth
options to adjust values returned from iframedirection
optionpostMessageTarget
option to better support GAS iframespostMessage()
Changes
auto
ResizeObserver
API, by adding it to all non-static page elements. This provides improved detection of CSS:hover
, CSS Animation,<textarea/>
user resizing events and remove the need for user interaction event listeners.heightCalculationMethod
/widthCalculationMethod
in favour of auto calculation mode detectiondata-iframe-height
/date-iframe-width
fordata-iframe-size
sizeHeight
andsizeWidth
in favour of newdirection
optiongetPageInfo()
in favour ofgetParentProperties()
which returns more reliable and useful dataonInit()
->onReady()
, and added deprecation warningsize()
->resize()
in iframe, and added deprecation warning@iframe-resizer/jquery
MutationObserver
to now just look for added nodes in the document tree and ensure that new non-static elements are covered byResizeObserver
minHeight
,maxHeight
,minWidth
andmaxHeight
options, as modern CSS can now deal with this for us.mouse
,touch
andresize
event listeners, as not required alongsideResizeObserver
Fixes
lowestElement
to exclude non-visible elements (head
,meta
,base
,title
,script
,link
,style
,map
,area
,option
,optgroup
,template
,track
,wbr
,nobr
) and then check remaining elements usingelement.checkVisibility()
Math.ceil()
to round up sub-pixel heights (Use offset: 1 option)getPageInfo()
to update when the size of the iframe changesgetPageInfo()
updates after leaving page in iframe that requested themauto !important
, incorrectly setting these values is the number one cause of problems effecting the page resizingChore
Future roadmap
data-iframe-size
attrs via CSS selectorcheckOrigin
has more than one target, iterate over them withpostMessage()
, rather than use*
warning
totiny-warning
in React versionscrollBy()
method{ top: left: behaviour: }
to scrollTo / scrollToOffesetgetTopInfo()
methodEventListener()
methodsFramework components / plugins roadmap