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: Clarification that Dialog componentProps may include built-in Dialog props #16192

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

danbars
Copy link

@danbars danbars commented Aug 14, 2023

What kind of change does this PR introduce?

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

Does this PR introduce a breaking change?

  • Yes
  • No

The PR fulfills these requirements:

  • 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 danbars changed the title Danbars-patch-1 Clarification that Dialog componentProps may include built-in Dialog props Sep 4, 2023
@danbars danbars changed the title Clarification that Dialog componentProps may include built-in Dialog props Docs: Clarification that Dialog componentProps may include built-in Dialog props Sep 4, 2023
@Davilink
Copy link

Davilink commented Mar 8, 2024

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

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