Skip to content

docs(alert): alert input label is only for radio/checkbox #26923

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

Merged
merged 4 commits into from
Mar 13, 2023
Merged

Conversation

sean-perkins
Copy link
Contributor

@sean-perkins sean-perkins commented Mar 7, 2023

Pull request checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
    • Some docs updates need to be made in the ionic-docs repo, in a separate PR. See the contributing guide for details.
  • Build (npm run build) was run locally and any changes were pushed
  • Lint (npm run lint) has passed locally and any fixes were made for failures

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the current behavior?

Label property on AlertInput interface is unclear to developers when it is used/displayed.

Issue URL: #26915

What is the new behavior?

  • Updates documentation for label property to note it is only used for input type checkbox or radio

Does this introduce a breaking change?

  • Yes
  • No

Other information

Related docs PR: ionic-team/ionic-docs#2810

@bolt-new-by-stackblitz
Copy link

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

@github-actions github-actions bot added the package: core @ionic/core package label Mar 7, 2023
@sean-perkins sean-perkins marked this pull request as ready for review March 7, 2023 20:57
@sean-perkins sean-perkins requested a review from a team as a code owner March 7, 2023 20:57
Copy link
Contributor

@liamdebeasi liamdebeasi left a comment

Choose a reason for hiding this comment

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

Are input labels something we should support? When I looked at the linked issue the other day I wasn't sure why support was only added to radios and checkboxes.

@sean-perkins
Copy link
Contributor Author

I think that requires more investigation internally. The implementation doesn't render labels today, likely to align to iOS/MD design guidelines.

We could render the label and add the label placement/etc. options to allow developers to build more "custom" alert form dialogs (and more accessible) post v7, but that needs to be vetted and designed out.

Since the current behavior doesn't account for labels on text fields (input and textarea), I figured we should align the documentation around this for now.

Copy link
Contributor

@averyjohnston averyjohnston left a comment

Choose a reason for hiding this comment

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

I agree with just documenting this for now.

@sean-perkins sean-perkins merged commit d6c06ec into main Mar 13, 2023
@sean-perkins sean-perkins deleted the gh-26915 branch March 13, 2023 17:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package: core @ionic/core package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants