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-button-close): add content prop (closes #4527) #4574

Merged
merged 9 commits into from Jan 22, 2020

Conversation

jacobmllr95
Copy link
Member

@jacobmllr95 jacobmllr95 commented Jan 8, 2020

Describe the PR

This PR adds a content prop to the <b-button-close> component.
It also adds the prop to the BButtonClose settings to make it globally configurable.

A headerCloseContent property is also added to the <b-modal> component and the BModal settings to be able to change the close button content by modal or for all modals globally.

Closes #4527.

PR checklist

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

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

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, chore(docs): 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
  • CodeCov for patch has met target
  • 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: Feature request PR: Minor labels Jan 8, 2020
@jacobmllr95 jacobmllr95 requested a review from tmorehouse Jan 8, 2020
@jacobmllr95 jacobmllr95 added this to In progress in 2.3.0 via automation Jan 8, 2020
@codecov
Copy link

@codecov codecov bot commented Jan 8, 2020

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##              dev    #4574      +/-   ##
==========================================
- Coverage   99.92%   99.92%   -0.01%     
==========================================
  Files         251      251              
  Lines        5225     5220       -5     
  Branches     1384     1384              
==========================================
- Hits         5221     5216       -5     
  Misses          3        3              
  Partials        1        1
Impacted Files Coverage Δ
src/utils/dom.js 100% <100%> (ø) ⬆️
src/utils/array.js 100% <100%> (ø) ⬆️
src/utils/object.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 6434b5f...8268b31. Read the comment docs.

@tmorehouse
Copy link
Member

@tmorehouse tmorehouse commented Jan 8, 2020

One thing to note is that we used to have SSR mismatch errors when using &times; from a prop for some reason (there was a related Vue issue for that, which might be fixed by now).

When using HTML entities that maps to UTF8 characters, the browser would convert the inner HTML/text to the UTF8 character, and the rehydration process would complain that × does not equal &times;, even though they are.

@jacobmllr95
Copy link
Member Author

@jacobmllr95 jacobmllr95 commented Jan 9, 2020

@tmorehouse I currently don't see any SSR mismatch errors.

@tmorehouse
Copy link
Member

@tmorehouse tmorehouse commented Jan 9, 2020

@jackmu95 OK cool... Vue must have fixed the issue with the rehydration process.

@tmorehouse
Copy link
Member

@tmorehouse tmorehouse commented Jan 9, 2020

I might add in an option for passing vNode Array via the message box methods for the button content (via a separate PR)

Copy link
Member

@tmorehouse tmorehouse left a comment

We target this for the v2.3.0 release (after any v2.2.1 release)

@jacobmllr95 jacobmllr95 merged commit 7379c6d into dev Jan 22, 2020
9 checks passed
2.3.0 automation moved this from In progress to Done Jan 22, 2020
@jacobmllr95 jacobmllr95 deleted the feat-button-close-content-prop branch Jan 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: Minor Type: Feature
Projects
No open projects
2.3.0
  
Done
Development

Successfully merging this pull request may close these issues.

2 participants