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

BToast invalid docs #1769

Closed
6 tasks done
mediaessenz opened this issue Feb 13, 2024 · 6 comments · Fixed by #1809
Closed
6 tasks done

BToast invalid docs #1769

mediaessenz opened this issue Feb 13, 2024 · 6 comments · Fixed by #1809
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@mediaessenz
Copy link

Describe the bug

The bug is also visible on the official documentation of this project.
Go to https://bootstrap-vue-next.github.io/bootstrap-vue-next/docs/components/toast.htm, scroll down to "Automatic Countdown" and press the "Show" button.

The toast will be visible with only 2 pixels height.

Reproduction

https://bootstrap-vue-next.github.io/bootstrap-vue-next/docs/components/toast.html

Used Package Manager

pnpm

Validations

  • Have tested with the latest version. This is still alpha version and sometime things change rapidly.
  • Follow our Code of Conduct
  • Read the Contributing Guide.
  • Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
  • Check that this is a concrete bug. For Q&A, please open a GitHub Discussion instead.
  • The provided reproduction is a minimal reproducible of the bug.
@mediaessenz mediaessenz added the bug Something isn't working label Feb 13, 2024
@mediaessenz mediaessenz changed the title Toast initalized by show has no height and doesn't respect properies Toast initalized by show has no height and ignores all properties Feb 13, 2024
@mediaessenz
Copy link
Author

mediaessenz commented Feb 13, 2024

Maybe it's a bug or the documentation is outdated.

If I put the properies inside an object with a props key it works:

toast.show({props: {
   title: 'Toast title',
   body: 'Toast body',
   variant: 'success'
}}); 

@VividLemon
Copy link
Member

Outdated docs

@VividLemon
Copy link
Member

VividLemon commented Feb 14, 2024

Feel free to submit a PR updating those examples. It should be pretty striaghtforward

@VividLemon VividLemon added documentation Improvements or additions to documentation and removed bug Something isn't working labels Feb 16, 2024
@VividLemon VividLemon changed the title Toast initalized by show has no height and ignores all properties BToast invalid docs Feb 16, 2024
@VividLemon VividLemon added the good first issue Good for newcomers label Feb 16, 2024
@VividLemon
Copy link
Member

Here https://bootstrap-vue-next.github.io/bootstrap-vue-next/docs/components/toast.html
Schemas should be converted from
show?.('Watch me!', {
title: 'Counting down!',
variant: 'info',
pos: 'middle-center',
value: 10000,
interval: 100,
progressProps: {
variant: 'danger',
},
})

To match that shown in
https://bootstrap-vue-next.github.io/bootstrap-vue-next/docs/composables/useToast.html

@Renuka9527
Copy link

useToast is not working. May be this could be Bug.
Feel free to submit a PR updating those updated documentation or examples. It should be pretty straightforward.
Here is below example I tried

<BButton
@click="
show?.('Watch me!', {
title: 'Toast title',
body: 'Toast body',
value: true,
variant: 'success',
pos: 'bottom-center'
})
"

Show
<script setup lang="ts"> import { useToast } from "bootstrap-vue-next"; const {show} = useToast() </script>

@VividLemon
Copy link
Member

Docs are wrong. Best examples are in playground TToast.vue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants