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-link): add support 3rd party router links such as Gridsome's <g-link> (closes #2627) #5358

Merged
merged 45 commits into from May 14, 2020

Conversation

tmorehouse
Copy link
Member

@tmorehouse tmorehouse commented May 12, 2020

Describe the PR

Adds a new prop router-component-name, which defaults to undefined.

Default is to auto detect <router-link> or<nuxt-link>.

Gridsome does not provide a means for detecting that the app is running under Gridsome, so users who wish to use <g-link> can set this prop to 'g-link'

Notes:

  • if vue-router is not detected, then the user supplied router-link component will not be used.
  • If vue-router is detected, and g-link is not a registered component, then the render or the link will fail
  • Gridsome's <g-link> component does not support FQDN URLs nor hash only URLs (https://gridsome.org/docs/linking/)

To Do:

  • Unit tests
  • Router-Links reference section docs updates
  • b-link docs updates
  • common props meta json (and include version property)

Possible ToDo:

  • Check to see if the user supplied component name is registered with Vue, and if not, fallback to <router-link>

Closes #2627

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)

@vercel
Copy link

@vercel vercel bot commented May 12, 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/2tdap1zom
Preview: https://bootstrap-vue-git-blink-gridsome.bootstrap-vue.now.sh

@tmorehouse tmorehouse changed the title feat(b-link): add support 3rd party router links such as Gridsome's <g-link> feat(b-link): add support 3rd party router links such as Gridsome's <g-link> (closes #2627) May 12, 2020
@codesandbox-ci
Copy link

@codesandbox-ci codesandbox-ci bot commented May 12, 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 c3f9077:

Sandbox Source
cool-tree-kqb30 Configuration

@tmorehouse tmorehouse added the PR: Minor label May 12, 2020
@codecov
Copy link

@codecov codecov bot commented May 12, 2020

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff            @@
##               dev     #5358   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          281       281           
  Lines         8835      8835           
  Branches      2501      2501           
=========================================
  Hits          8835      8835           
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 8952df3...8952df3. Read the comment docs.

@vercel vercel bot temporarily deployed to Preview May 13, 2020 Inactive
@vercel vercel bot temporarily deployed to Preview May 13, 2020 Inactive
@jacobmllr95 jacobmllr95 merged commit 6d29e1c into dev May 14, 2020
11 checks passed
v2.15.0 automation moved this from In progress to Done May 14, 2020
@jacobmllr95 jacobmllr95 deleted the blink-gridsome branch May 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
v2.15.0
  
Done
Development

Successfully merging this pull request may close these issues.

2 participants