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-dropdown): add toggle-attrs prop (closes #3694) #6339

Conversation

phegman
Copy link
Contributor

@phegman phegman commented Jan 20, 2021

Describe the PR

Add toggle-attrs prop to allow adding HTML attributes to the dropdown toggle. This feature has been talked about here: #3694

At GitLab we have a component library built on top of Bootstrap Vue and would like this feature so that we can add the data-qa-selector attribute to the dropdown toggle. We use this attribute exclusively for QA E2E specs. I could also see it being helpful for adding the data-testid attribute which is supported by Vue Testing Library. This prop could also be used for other user-facing attributes such as aria-* attributes.

Closes #3694.

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)
    • I think it's convincing 🙂. This wasn't a hugely time consuming change so not a big deal if this feature doesn't get approved

Add `toggle-attrs` prop to allow adding HTML attributes to the
dropdown toggle
@vercel
Copy link

vercel bot commented Jan 20, 2021

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/8fw84zizf
✅ Preview: https://bootstrap-vue-git-fork-phegman-phegman-add-toggle-attrs-9482a9.bootstrap-vue.now.sh

@codesandbox-ci
Copy link

codesandbox-ci bot commented Jan 20, 2021

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 a31f67f:

Sandbox Source
BootstrapVue Starter Project Configuration
BootstrapVue Nuxt.js Starter Project Configuration

@codecov
Copy link

codecov bot commented Jan 20, 2021

Codecov Report

Merging #6339 (a31f67f) into dev (2a449ab) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##               dev     #6339   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          299       299           
  Lines        10105     10105           
  Branches      2512      2512           
=========================================
  Hits         10105     10105           
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/components/dropdown/dropdown.js 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 2a449ab...a31f67f. Read the comment docs.

@jacobmllr95 jacobmllr95 self-requested a review January 21, 2021 08:23
@jacobmllr95 jacobmllr95 added PR: Minor Requires minor version bump Type: Enhancement labels Jan 21, 2021
@jacobmllr95 jacobmllr95 changed the title feat(b-dropdown): add toggle-attrs prop. fixes 3694 feat(b-dropdown): add toggle-attrs prop (closes #3694) Jan 21, 2021
@jacobmllr95 jacobmllr95 merged commit 6cfcbb3 into bootstrap-vue:dev Jan 21, 2021
@jacobmllr95
Copy link
Member

Thanks @phegman!

@phegman
Copy link
Contributor Author

phegman commented Jan 21, 2021

@jackmu95 Thanks for reviewing and making those stylistic changes! Bootstrap Vue is an impressively consistent codebase, makes it very enjoyable to work on!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: Minor Requires minor version bump Type: Enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

b-dropdown: The ability to set attributes and properties for b-button object
2 participants