Skip to content
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

feat(b-img-lazy): switch IntersectionObserver to use private `v-b-visible` directive #3977

Merged
merged 43 commits into from Aug 30, 2019

Conversation

@tmorehouse
Copy link
Member

commented Aug 29, 2019

Describe the PR

Rather than using IntersectionObserver directly, switch to the private v-b-visible directive

If we assume the user has added a polyfill for IntersectionObserver we can further reduce the size of the code by removing all the fallback window scroll/transition listeners.

If IntersectionObserver is not found, we just always force show the image (always non-lazy)

To Do:

  • Update docs
  • Update tests (Intersection Observer is not supported in JSDOM, so need a mock implementation)

PR checklist

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Enhancement
  • ARIA accessibility
  • Documentation update
  • Other (please describe) code refactor

Does this PR introduce a breaking change? (check one)

  • No
  • Yes (please describe)

If IntersectionObserver support is not found (either natively or via polyfill), then the image will always be shown (non-lazy, and regardless of the show prop state)

The PR fulfills these requirements:

  • It's submitted to the dev branch, not the master branch
  • When resolving a specific issue, it's referenced in the PR's title (i.e. [...] (fixes #xxx[,#xxx]), where "xxx" is the issue number)
  • It should address only one issue or feature. If adding multiple features or fixing a bug and adding a new feature, break them into separate PRs if at all possible.
  • The title should follow the Conventional Commits naming convention (i.e. fix(alert): not alerting during SSR render, docs(badge): update pill examples, fix typos, chore: fix typo in README, etc). This is very important, as the CHANGELOG is generated from these messages.

If new features/enhancement/fixes are added or changed:

  • Includes documentation updates (including updating the component's package.json for slot and event changes)
  • Includes any needed TypeScript declaration file updates
  • New/updated tests are included and passing (if required)
  • Existing test suites are passing
  • The changes have not impacted the functionality of other components or directives
  • ARIA Accessibility has been taken into consideration (Does it affect screen reader users or keyboard only users? Clickable items should be in the tab index, etc.)

If adding a new feature, or changing the functionality of an existing feature, the PR's
description above includes:

  • A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)

@tmorehouse tmorehouse added this to In Progress in 2.0.0 Stable via automation Aug 29, 2019

@tmorehouse tmorehouse requested a review from jackmu95 Aug 29, 2019

@codecov

This comment has been minimized.

Copy link

commented Aug 29, 2019

Codecov Report

Merging #3977 into dev will decrease coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##              dev    #3977      +/-   ##
==========================================
- Coverage   99.86%   99.86%   -0.01%     
==========================================
  Files         238      238              
  Lines        4466     4442      -24     
  Branches     1254     1248       -6     
==========================================
- Hits         4460     4436      -24     
  Misses          5        5              
  Partials        1        1
Impacted Files Coverage Δ
src/components/image/img-lazy.js 100% <100%> (ø) ⬆️
src/directives/visible.js 100% <100%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 62fb0b6...c0f3242. Read the comment docs.

@jackmu95

This comment has been minimized.

Copy link
Member

commented Aug 29, 2019

@tmorehouse Yeah, I'am for the removing of the fallback code.

@tmorehouse

This comment has been minimized.

Copy link
Member Author

commented Aug 29, 2019

@jackmu95 should we make it so that if IntersectionObserver is not found, then always show the image?

@jackmu95

This comment has been minimized.

Copy link
Member

commented Aug 29, 2019

@tmorehouse Yeah. And adding a warning maybe to include a polyfill.

@tmorehouse tmorehouse changed the title chore(b-img-lazy): switch IntersectionObserver to use private `v-b-visible` directive feat(b-img-lazy): switch IntersectionObserver to use private `v-b-visible` directive Aug 29, 2019

tmorehouse added 16 commits Aug 29, 2019
tmorehouse added 14 commits Aug 30, 2019
@tmorehouse

This comment has been minimized.

Copy link
Member Author

commented Aug 30, 2019

It appears that Vue-test-utils doesn't unbind a directive if the directive is conditionally removed from the element. It only calls unbind if the node is destroyed. Although Vue itself does properly unbind a directive if it is removed from the render.

tmorehouse and others added 8 commits Aug 30, 2019

@tmorehouse tmorehouse merged commit 249ccfa into dev Aug 30, 2019

9 checks passed

License Compliance All checks passed.
Details
ci/circleci: build Your tests passed on CircleCI!
Details
ci/circleci: lint Your tests passed on CircleCI!
Details
ci/circleci: setup Your tests passed on CircleCI!
Details
ci/circleci: test Your tests passed on CircleCI!
Details
codecov/patch 100% of diff hit (target 99.86%)
Details
codecov/project Absolute coverage decreased by -<.01% but relative coverage increased by +0.13% compared to 62fb0b6
Details
deploy/netlify Deploy preview ready!
Details
security/snyk - package.json (pi0) No manifest changes detected

2.0.0 Stable automation moved this from In Progress to Completed Aug 30, 2019

@tmorehouse tmorehouse deleted the tmorehouse/img-lazy branch Aug 30, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
2 participants
You can’t perform that action at this time.