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: properly handle HTML props render order (closes #5363) #5365

Merged
merged 42 commits into from May 15, 2020

Conversation

jacobmllr95
Copy link
Member

@jacobmllr95 jacobmllr95 commented May 13, 2020

Describe the PR

This PR fixes that the head-html and lead-html props for <b-breadcrumb> work properly.

It also ensures the following rendering order for all components:

  1. slots
  2. html prop
  3. text prop

Closes #5363.

PR checklist

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

  • Bugfix (fixes a boo-boo in the code) - fix(...), requires a patch version update
  • Feature (adds a new feature to BootstrapVue) - feat(...), requires a minor version update
  • Enhancement (augments an existing feature) - feat(...), requires a minor version update
  • ARIA accessibility (fixes or improves ARIA accessibility) - fix(...), requires a patch or minor version update
  • Documentation update (improves documentation or typo fixes) - chore(docs), requires a patch version update
  • Other (please describe)

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

  • No
  • Yes (please describe since breaking changes require a minor version update)

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, chore(docs): fix typo in README, etc). This is very important, as the CHANGELOG is generated from these messages, and determines the next version type (patch or minor).

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

  • Includes documentation updates
  • Includes component package.json meta section updates (prop, slot and event changes/updates)
  • Includes any needed TypeScript declaration file updates
  • New/updated tests are included and passing (required for new features and enhancements)
  • Existing test suites are passing
  • CodeCov for patch has met target (all changes/updates have been tested)
  • 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)

@jacobmllr95 jacobmllr95 added Type: Fix PR: Patch labels May 13, 2020
@jacobmllr95 jacobmllr95 requested a review from tmorehouse May 13, 2020
@vercel
Copy link

vercel bot commented May 13, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/bootstrap-vue/bootstrap-vue/b3wtb3c15
Preview: https://bootstrap-vue-git-fix-jumbatron-html-props.bootstrap-vue.now.sh

@codesandbox-ci
Copy link

codesandbox-ci bot commented May 13, 2020

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 09d5f75:

Sandbox Source
clever-tesla-v94vv Configuration

@codecov
Copy link

codecov bot commented May 13, 2020

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff            @@
##               dev     #5365   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          277       277           
  Lines         8867      8867           
  Branches      2490      2490           
=========================================
  Hits          8867      8867           
Flag Coverage Δ
#unittests 100.00% <0.00%> (ø)

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 09d5f75...09d5f75. Read the comment docs.

@jacobmllr95
Copy link
Member Author

jacobmllr95 commented May 13, 2020

@tmorehouse I think we have to look at some other components with HTML props an apply the same logic. With that logic in place, we don't need the stripTags() util which is a nice side-effect.

@jacobmllr95 jacobmllr95 changed the title fix(b-jumbatron): fix html props and ensure correct render order (closes #5363) fix: properly handle HTML props render order (closes #5363) May 13, 2020
@tmorehouse
Copy link
Member

tmorehouse commented May 14, 2020

Not sure if we should change the order of what takes precedence... I think slots should take precedence over html/text props (if the slot is present), Otherwise it could be construed as a breaking change. So component docs mention if the slot takes precedence over the props (or vice versa).

Also, when using DOM props (i.e. textContent, innerHTML), we would avoid placing them on components that are not functional (or functional components that render a full component as their child).

@jacobmllr95
Copy link
Member Author

jacobmllr95 commented May 14, 2020

Not sure if we should change the order of what takes precedence... I think slots should take precedence over html/text props (if the slot is present), Otherwise it could be construed as a breaking change. So component docs mention if the slot takes precedence over the props (or vice versa).

Also, when using DOM props, we would avoid placing them on components that are not functional (or functional components that render a full component as their child).

I got that wrong in the description. This PR ensures that order and avoids some hacks we did before (render additional <span> etc.).

@vercel vercel bot temporarily deployed to Preview May 14, 2020 Inactive
@vercel vercel bot temporarily deployed to Preview May 14, 2020 Inactive
@jacobmllr95
Copy link
Member Author

jacobmllr95 commented May 14, 2020

I will make sure that we don't use domProps on regular components.

@vercel vercel bot temporarily deployed to Preview May 15, 2020 Inactive
@jacobmllr95 jacobmllr95 merged commit 844ecda into dev May 15, 2020
12 of 14 checks passed
@jacobmllr95 jacobmllr95 added this to Done in v2.15.0 via automation May 15, 2020
@jacobmllr95 jacobmllr95 deleted the fix-jumbatron-html-props branch May 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: Patch Type: Fix
Projects
No open projects
v2.15.0
  
Done
Development

Successfully merging this pull request may close these issues.

2 participants