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

fix(b-table, b-table-lite): generate `:key` for `row-details` row based on the `primary-key` field value if available #4025

Merged
merged 2 commits into from Sep 5, 2019

Conversation

@tmorehouse
Copy link
Member

commented Sep 5, 2019

Describe the PR

Row details was always using the physical row index to generate the Vue render :key, causing any row details child components to re-render if new rows were prepended (unshifted) to the items array.

This PR makes the details row use a :key based on the item's row key (based on primary key field if available). This will prevent unnecessary re-renders of components inside details slot (as long as a primary-key field is provided).

Improves render performance when using child components in a row-details slot.

Fixes an issue on stackoverflow:

https://stackoverflow.com/questions/57708063/b-table-reloads-nested-components-when-unshifting-a-new-row-but-not-when-pus

PR checklist

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

  • Bugfix
  • Feature
  • Enhancement
  • ARIA accessibility
  • Documentation update
  • Other (please describe) Performance improvement

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

  • No
  • Yes (please describe)

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)
@codecov

This comment has been minimized.

Copy link

commented Sep 5, 2019

Codecov Report

Merging #4025 into dev will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##              dev    #4025   +/-   ##
=======================================
  Coverage   99.86%   99.86%           
=======================================
  Files         238      238           
  Lines        4464     4464           
  Branches     1254     1254           
=======================================
  Hits         4458     4458           
  Misses          5        5           
  Partials        1        1
Impacted Files Coverage Δ
src/components/table/helpers/mixin-tbody-row.js 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 2012d07...732efbd. Read the comment docs.

@tmorehouse tmorehouse added this to In Progress in 2.0.0 Stable via automation Sep 5, 2019

@tmorehouse tmorehouse marked this pull request as ready for review Sep 5, 2019

@tmorehouse tmorehouse requested a review from jackmu95 Sep 5, 2019

@tmorehouse tmorehouse changed the title fix(b-table, b-table-lite): use `:key` for row details based on the primary key value if available fix(b-table, b-table-lite): generate `:key` for `row-details` row based on the primary key value if available Sep 5, 2019

@tmorehouse tmorehouse changed the title fix(b-table, b-table-lite): generate `:key` for `row-details` row based on the primary key value if available fix(b-table, b-table-lite): generate `:key` for `row-details` row based on the `primary-key` field value if available Sep 5, 2019

@tmorehouse tmorehouse changed the title fix(b-table, b-table-lite): generate `:key` for `row-details` row based on the `primary-key` field value if available perf(b-table, b-table-lite): generate `:key` for `row-details` row based on the `primary-key` field value if available Sep 5, 2019

@tmorehouse tmorehouse changed the title perf(b-table, b-table-lite): generate `:key` for `row-details` row based on the `primary-key` field value if available fix(b-table, b-table-lite): generate `:key` for `row-details` row based on the `primary-key` field value if available Sep 5, 2019

@tmorehouse tmorehouse merged commit c7cb16f into dev Sep 5, 2019

8 of 9 checks passed

License Compliance FOSSA is analyzing this commit
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 Coverage not affected when comparing 2012d07...732efbd
Details
codecov/project 99.86% remains the same compared to 2012d07
Details
deploy/netlify Production deploy ready!
Details
security/snyk - package.json (pi0) No manifest changes detected

2.0.0 Stable automation moved this from In Progress to Completed Sep 5, 2019

@tmorehouse tmorehouse deleted the tmorehouse/table-details-key branch Sep 5, 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.