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-tags): add limit prop #5543

Merged
merged 15 commits into from Sep 8, 2020

Conversation

Hiws
Copy link
Member

@Hiws Hiws commented Jul 2, 2020

Describe the PR

Adds a prop limit to set a maximum amount of tags allowed.

  • Add prop and functionality
  • Add tests
  • Test accessability

Codesandbox:
https://codesandbox.io/s/bootstrapvue-starter-project-forked-t9gqu

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.)

@vercel
Copy link

vercel bot commented Jul 2, 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/etmpixcc7
Preview: https://bootstrap-vue-git-fork-hiws-b-form-tags-limit-prop.bootstrap-vue.vercel.app

@codesandbox-ci
Copy link

codesandbox-ci bot commented Jul 2, 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 ca572b3:

Sandbox Source
BootstrapVue Starter Project Configuration
BootstrapVue Starter Project (forked) PR

@codecov
Copy link

codecov bot commented Jul 2, 2020

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff            @@
##               dev     #5543   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          284       284           
  Lines         9555      9564    +9     
  Branches      2521      2525    +4     
=========================================
+ Hits          9555      9564    +9     
Flag Coverage Δ
#unittests 100.00% <100.00%> (ø)

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

Impacted Files Coverage Δ
src/components/form-tags/form-tags.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 f847dae...ca572b3. Read the comment docs.

@jacobmllr95 jacobmllr95 added this to In progress in v2.17.0 via automation Jul 21, 2020
@Hiws Hiws removed the Status: WIP label Sep 4, 2020
@Hiws Hiws requested a review from jacobmllr95 Sep 4, 2020
@Hiws Hiws marked this pull request as ready for review Sep 4, 2020
@jacobmllr95
Copy link
Member

jacobmllr95 commented Sep 4, 2020

@Hiws What do you think about disabling the input when the limit is reached?

@Hiws
Copy link
Member Author

Hiws commented Sep 4, 2020

@Hiws What do you think about disabling the input when the limit is reached?

@jackmu95
I don't think we should do this because of functionality like remove-on-delete, which wouldn't work (i think) after the input has been disabled.

Or at least add another prop to enable/disable that functionality.

@jacobmllr95
Copy link
Member

jacobmllr95 commented Sep 4, 2020

@Hiws Yeah, I mean "disabling" just in the possibility to add new tags.
Removing them should still be possible.

@Hiws
Copy link
Member Author

Hiws commented Sep 4, 2020

That's how it currently works.
When the limit is reached, the text is displayed and tags can no longer be added via the component.
However, the <input> stays enabled to allow for deletion of tags by using backspace or del if remove-on-delete is enabled.
If we disabled the <input>, this functionality wouldn't work. The user would have to use the mouse to "manually" delete tags.

https://bootstrap-vue.org/docs/components/form-tags#last-tag-removal-via-backspace-keypress

@vercel vercel bot temporarily deployed to Preview Sep 4, 2020 Inactive
@jacobmllr95 jacobmllr95 merged commit caa0f1a into bootstrap-vue:dev Sep 8, 2020
2 of 3 checks passed
v2.17.0 automation moved this from In progress to Done Sep 8, 2020
@Hiws Hiws deleted the b-form-tags-`limit`-prop branch Mar 25, 2021
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: Feature
Projects
No open projects
v2.17.0
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants