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

chore(docs): fix navbar typo #4206

merged 2 commits into from Oct 6, 2019


Copy link

commented Oct 6, 2019

Describe the PR

  1. Ste -> Set
  2. 'sn', 'ms' -> 'sm', 'md'

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, fix typos, chore: 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
  • 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)
`ste` -> `set`

This comment has been minimized.

Copy link

commented Oct 6, 2019

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##              dev    #4206   +/-   ##
  Coverage   99.86%   99.86%           
  Files         237      237           
  Lines        4527     4527           
  Branches     1274     1274           
  Hits         4521     4521           
  Misses          5        5           
  Partials        1        1

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 56b774d...3f76940. Read the comment docs.

`sn', 'ms'` -> `sm', 'md'`

This comment has been minimized.

Copy link
Contributor Author

commented Oct 6, 2019

Regarding Set to 'true' for an always collapsed navbar, or to a specific breakpoint at which point the navbar will be expanded: 'sm', 'md', 'lg' or 'xl'

How about xs?


This comment has been minimized.

Copy link

commented Oct 6, 2019

@TitanFighter When the value is a string, it is translated into a class. there is no class with the xs prefix. For an always toggleable navbar (i.e. xs and up) one either does:

<b-navbar toggleable ...>


<b-navbar toggleable="" ...>


<b-navbar :toggleable="true" ...>

Also, the breakpoint names are not set in stone, and can be configured by by the user via SASS variables (maps) and the BootstrapVue config. So it wouldnt be a good idea trying to add extra prop massaging code to map 'xs' to "true"

@tmorehouse tmorehouse merged commit 15668c2 into bootstrap-vue:dev Oct 6, 2019
8 checks passed
8 checks passed
ci/circleci: build Your tests passed on CircleCI!
ci/circleci: lint Your tests passed on CircleCI!
ci/circleci: setup Your tests passed on CircleCI!
ci/circleci: test Your tests passed on CircleCI!
codecov/patch Coverage not affected when comparing 56b774d...3f76940
codecov/project 99.86% remains the same compared to 56b774d
deploy/netlify Deploy preview ready!
security/snyk - package.json (pi0) No manifest changes detected

This comment has been minimized.

Copy link
Contributor Author

commented Oct 6, 2019

I see now the logic how it works. It goes from xl to sm. I have a plugin where I explicitly provide breakpoints, ie ['xs', 'sm', 'md', ...] and this is the reason why I started thinking that "xs" is lost :)

@TitanFighter TitanFighter deleted the TitanFighter:patch-5 branch Oct 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
3 participants
You can’t perform that action at this time.