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-nav-item-dropdown): improve default handling of dropdown toggle link (closes #3942) #5344

Merged
merged 23 commits into from May 11, 2020

Conversation

jacobmllr95
Copy link
Member

@jacobmllr95 jacobmllr95 commented May 11, 2020

Describe the PR

This PR improves the link handling of <b-nav-item-dropdown> by assining the user provided ID as the toggle link href has link.

When id prop isn't set (defaults to null) the href for the <b-link> i set to #. If an id is provided, then the href for <b-link> will be set to #{id}. This way, before the page is hydrated, the link will just scroll to the A tag (which should already be in view and hence not scroll) rather than scrolling to the top of the page.

Closes #3942.

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 Requires patch version bump labels May 11, 2020
@jacobmllr95 jacobmllr95 added this to In progress in v2.14.0 via automation May 11, 2020
@vercel
Copy link

vercel bot commented May 11, 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/5mugwmuje
Preview: https://bootstrap-vue-git-fix-nav-item-dropdown-href.bootstrap-vue.now.sh

@codesandbox-ci
Copy link

codesandbox-ci bot commented May 11, 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 7670e11:

Sandbox Source
stoic-wave-9dz3j Configuration

@codecov
Copy link

codecov bot commented May 11, 2020

Codecov Report

Merging #5344 into dev will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff            @@
##               dev     #5344   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          281       281           
  Lines         8825      8828    +3     
  Branches      2505      2505           
=========================================
+ Hits          8825      8828    +3     
Flag Coverage Δ
#unittests 100.00% <100.00%> (ø)
Impacted Files Coverage Δ
src/mixins/id.js 100.00% <ø> (ø)
src/components/nav/nav-item-dropdown.js 100.00% <100.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 70c00e8...7670e11. Read the comment docs.

@jacobmllr95
Copy link
Member Author

@scyclops Can you create a CodeSandbox based on this template with a minimal reproduction of your Nuxt.js setup to confirm that the problem is resolved?

@tmorehouse
Copy link
Member

tmorehouse commented May 11, 2020

I just checked in the PR preview, and checked the SSR rendered source for the version dropdown in the docs nav, and it renders the following (before hydration):

a aria-haspopup="true" aria-expanded="false" href="#" target="_self" class="nav-link dropdown-toggle mr-md-2"><span>Pull Request</span></a>

So the href="#" is still there before Vue kicks in.

Perhaps we could try and use a <button> element for the dropdown toggle in b-nav-item-dropdown and see how the Bootstrap v4 styling work on it.

Edit:

Just tested rendering a native <button> instead of the <a> and just had to add classes border-0 bg-transparent to it to make it look correct.

@jacobmllr95
Copy link
Member Author

@tmorehouse Or we just expose href as prop as suggested in the issue.
It works fine for most of the users and for those who need to adjust it would have the possibility.

@tmorehouse
Copy link
Member

We would still need to make sure event.preventDefault() is called... <b-link> doesn't do this automatically when HREF is anything other than #.

Another option would be to set an ID on the <a> and set href to point to this ID (unfortunately we cant use safeId() auto-ID as it only runs client side)

@jacobmllr95
Copy link
Member Author

jacobmllr95 commented May 11, 2020

The toggle() method in dropdownMixin calls event.preventDefault() which the click event on the <b-link> is assigned to. So we should be fine.

@tmorehouse
Copy link
Member

tmorehouse commented May 11, 2020

Hmm, we should be adding role="button" to the rendered <a> tag that way an HREF won't confuse screen reader users.

How about we add an ID prop. This ID will be added to the link and then used as the href,
that way only hash HREFs are generated:

<a :id="id" :href="'#' + id'" role="button">

This way, before the page is hydrated, the link will just scroll to the A tag (which should already be in view and hence not scroll). If hte ID is null/blank/undefined, it would just render a plain href="#", which is the default behaviour.

This way the purpose of href as a prop wouldn't be confusing (and needing long explanation as to its use).

EDIT:

Actually we do have safeId in there, and we do generate an ID for the toggle button <a> tag... we could set this as the href (by pre-pending with #)

As long as the user supplies a unique ID, the href will be valid during SSR and before hydration

@jacobmllr95 jacobmllr95 added PR: Minor Requires minor version bump Type: Enhancement and removed PR: Patch Requires patch version bump Status: WIP Type: Fix labels May 11, 2020
@jacobmllr95 jacobmllr95 changed the title fix(b-nav-item-dropdown): let <b-link> handle href default value (closes #3942) feat(b-nav-item-dropdown): add href prop and improve default handling (closes #3942) May 11, 2020
@vercel vercel bot temporarily deployed to Preview May 11, 2020 23:02 Inactive
@tmorehouse tmorehouse changed the title feat(b-nav-item-dropdown): add href prop and improve default handling (closes #3942) feat(b-nav-item-dropdown): improve default handling of dropdown toggle link (closes #3942) May 11, 2020
@jacobmllr95 jacobmllr95 merged commit 62c6105 into dev May 11, 2020
5 of 6 checks passed
v2.14.0 automation moved this from In progress to Done May 11, 2020
@jacobmllr95 jacobmllr95 deleted the fix-nav-item-dropdown-href branch May 11, 2020 23:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
v2.14.0
  
Done
Development

Successfully merging this pull request may close these issues.

Add an href property to b-nav-item-dropdown
2 participants