feat: add disable overlay functionality; default to false

ankitu commented 5 years ago

This commit adds disable freeze overlay functionality, usage disableOverlay option can be passed to the preboot initial config as follows:

PrebootModule.withConfig({ appRoot: 'app-root', disableOverlay: true })

Please check if the PR fulfills these requirements
[x] The commit message follows our guidelines: https://github.com/angular/preboot/blob/master/CONTRIBUTING.md#commit-message-format
[ ] Tests for the changes have been added (for bug fixes / features)
[x] Docs have been added / updated (for bug fixes / features)
What modules are related to this pull-request
[ ] server side
[ ] client side
[ ] inline
[ ] build process
[ ] docs
[ ] tests
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...) remove unused proxy imports from some test files
What is the current behavior? (You can also link to an open issue here)
What is the new behavior (if this is a feature change)?
Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
Other information:

googlebot commented 5 years ago

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

:memo: Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here (e.g. I signed it!) and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

ankitu commented 5 years ago

I signed it!

On Fri, Jan 18, 2019 at 12:32 PM googlebot notifications@github.com wrote:

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here (e.g. I signed it!) and we'll verify it.

What to do if you already signed the CLA Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data https://cla.developers.google.com/clas and verify that your email is set on your git commits https://help.github.com/articles/setting-your-email-in-git/.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version https://opensource.google.com/docs/cla/#troubleshoot).

The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data https://cla.developers.google.com/clas and verify that your email is set on your git commits https://help.github.com/articles/setting-your-email-in-git/.

The email used to register you as an authorized contributor must also be attached to your GitHub account https://github.com/settings/emails.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/angular/preboot/pull/101#issuecomment-455447358, or mute the thread https://github.com/notifications/unsubscribe-auth/AgSqOtpKFCCnGdeyG2-n_gzI86O0G9jaks5vEXGIgaJpZM4aHVtB .

googlebot commented 5 years ago

CLAs look good, thanks!

ankitu commented 5 years ago

@mgol Feedback addressed, and thanks for the prompt reply

ankitu commented 5 years ago

@mgol We are already skipping the overlay creation in getAppRoot

// create an overlay if not disabled ,that can be used later if a freeze event occurs
  if (!opts.disableOverlay) {
    root.overlay = createOverlay(_document);
  }

And in cleanup, I guess condition is not required as we are are already checking for prebootOverlay id.

const prebootOverlay = doc.getElementById('prebootOverlay');
    if (prebootOverlay) {
      prebootOverlay.remove ?
        prebootOverlay.remove() : prebootOverlay.parentNode !== null ?
        prebootOverlay.parentNode.removeChild(prebootOverlay) :
        prebootOverlay.style.display = 'none';
    }

angular / preboot