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

docs(BCheckBox*): Small changes to get documentation to parity #1873

Merged
merged 4 commits into from
May 8, 2024

Conversation

dwgray
Copy link
Contributor

@dwgray dwgray commented Apr 30, 2024

Describe the PR

This PR should get the documents up to date and confirm that they are at parity with BSV and BS5

  • Document 'Without Labels'
  • Document all types
  • Export AriaInvalid, which was used but not exported
  • Start general migration docs to cover cases that are used in these components

Small replication

A small replication or video walkthrough can help demonstrate the changes made. This is optional, but can help observe the intended changes. A mentioned issue that contains a replication also works.

PR checklist

What kind of change does this PR introduce? (check at least one)

  • Bugfix 🐛 - fix(...)
  • Feature - feat(...)
  • ARIA accessibility - fix(...)
  • Documentation update - docs(...)
  • Other (please describe)

The PR fulfills these requirements:

  • Pull request title and all commits follow the Conventional Commits convention or has an override in this pull request body This is very important, as the CHANGELOG is generated from these messages, and determines the next version type. Pull requests that do not follow conventional commits or do not have an override will be denied

Copy link

stackblitz bot commented Apr 30, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.


See the [Vue 3 migration guide](https://v3-migration.vuejs.org/breaking-changes/v-model.html)
for more info.

<MigrationWrapper v-for="(item, i) in changes" :key="i" v-bind="item" />
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@VividLemon I didn't follow your pattern with the migration wrapper here. The problem is that vue components are rendered after the markdown is all transformed, so using this technique I don't see any way to get markdown sections (and other markdown, like the examples) into this document.

Let me know if you can think of a way to get the best of both worlds. The only way I could see to do that is to write a markdown-it plugin, which seems like a pretty heavy lift for this, but maybe I'm missing something simple.

apps/docs/src/docs/components/form-checkbox.md Outdated Show resolved Hide resolved
<template #html>

```vue-html
<b-form-checkbox v-model="checked" :indeterminate.sync="indeterminate">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pascal case for consistency

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it. I went back and forth on this, landing on kebab-case, since that's what the BSV sample that I pulled had. But now that I see this, I agree that it makes the relevant change stand out more.

@VividLemon VividLemon merged commit 7c2f499 into bootstrap-vue-next:main May 8, 2024
3 checks passed
xvaara added a commit to xvaara/bootstrap-vue-next that referenced this pull request May 22, 2024
* upstream/main: (23 commits)
  feat(BInput): Alias BFormInput to BInput
  fix(nuxt): dont teleport everything to #teleports -- selectively teleport based on body fixes bootstrap-vue-next#1898
  chore: release main
  feat(nuxt): allow passthrough options to createBootstrap plugin
  chore: release main (bootstrap-vue-next#1894)
  feat: implmenet a use defaults system WIP fixes bootstrap-vue-next#1607  (bootstrap-vue-next#1889)
  docs(BCheckBox*): Small changes to get documentation to parity (bootstrap-vue-next#1873)
  docs: Add component reference link in the page table of contents sidebar
  fixed BTableLite item _showDetails
  BTable delete selection when primary-key
  chore: release main
  feat(BTable): add change event -- replaces bv `modelValue` see bootstrap-vue-next#1775 (comment)
  chore: release main
  fix(BTable): selectedItems not clearing values properly fixes bootstrap-vue-next#1878 (bootstrap-vue-next#1879)
  chore: release main (bootstrap-vue-next#1874)
  fix(BTable): Pass through original records to slots in most circumstances (bootstrap-vue-next#1869)
  chore: release main (bootstrap-vue-next#1867)
  feat(BTable): Allow dot in sortby key
  fix: update dependencies to fix a bug in vue compiler (bootstrap-vue-next#1866)
  chore: release main (bootstrap-vue-next#1859)
  ...
Pequem pushed a commit to Pequem/bootstrap-vue-next that referenced this pull request May 28, 2024
@dwgray dwgray deleted the checkbox-tweeks branch June 11, 2024 21:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants