quasar icon indicating copy to clipboard operation
quasar copied to clipboard

Docs: Clarification that Dialog componentProps may include built-in Dialog props

Open danbars opened this issue 2 years ago • 1 comments
trafficstars

What kind of change does this PR introduce?

  • [ ] Bugfix
  • [ ] Feature
  • [x] Documentation
  • [ ] Code style update
  • [ ] Refactor
  • [ ] Build-related changes
  • [ ] Other, please describe:

Does this PR introduce a breaking change?

  • [ ] Yes
  • [x] No

The PR fulfills these requirements:

  • [x] It's submitted to the dev branch (or v[X] branch)
  • [ ] When resolving a specific issue, it's referenced in the PR's title (e.g. fix: #xxx[,#xxx], where "xxx" is the issue number)
  • [ ] It's been tested on a Cordova (iOS, Android) app
  • [ ] It's been tested on an Electron app
  • [ ] Any necessary documentation has been added or updated in the docs or explained in the PR's description.

If adding a new feature, the PR's description includes:

  • [ ] A convincing reason for adding this feature (to avoid wasting your time, it's best to start a new feature discussion first and wait for approval before working on it)

Other information: Adding clarification that Dialog componentProps may include built-in dialog options such as seamless. Both in docs and an example. Related to issue #13671

danbars avatar Aug 14 '23 21:08 danbars

It may be good to be a little bit more clear that:

If you want a persistent dialog using a custom component, this will not work

$.dialog({
  components: MyComponent,
  persistent: true
})

you have to do this

$.dialog({
  components: MyComponent,
  componentProps: {
      persistent: true
  }
})

because the message doesn't seem enough

[...] May also include any built-in dialog option such as 'persistent' or 'seamless'"

and people might want to try the persistent prop and thinking that will work. Some people will try and see that it doesn't work and try the example that you shown and this will be enough but some other people will wonder why it doesn't work

Davilink avatar Mar 08 '24 19:03 Davilink

Thanks for contributing! Unfortunately, there was a hard merge error, so had to do it again myself. Also greatly enhanced the "invoking custom component" section with this opportunity.

rstoenescu avatar Sep 03 '24 11:09 rstoenescu