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

Input Description / Error Text #1641

Open
scurker opened this issue Aug 20, 2024 · 6 comments
Open

Input Description / Error Text #1641

scurker opened this issue Aug 20, 2024 · 6 comments
Labels
rfc An issue proposing a new significant change
Milestone

Comments

@scurker
Copy link
Member

scurker commented Aug 20, 2024

TextField should accept a new optional description property that is displayed immediately below the label text. When description is present, the associated input field should have aria-describedby with an idref pointing to the associated description.

Note

When both description and error are set, the aria-describedby property should reference the description idref first, followed by the error idref.

Related Components

Designs

textfield design
textfield multiline design

When the "label text" overflows with the "required" label, the label should wrap onto a new line without interfering with the placement or sizing of required.

Interface

interface TextFieldProps {
  // ...other props
  description?: React.ReactNode
}

Additional Changes

With this change, the placement of the error message should also be visually located immediately above the input field with the addition of a caution icon preceding the error text.

The Required text should not have any font styles applied and have italics removed.

@shawnsharpDQ
Copy link

shawnsharpDQ commented Aug 27, 2024

Description and Error updates for the input / Select / Combobox
Description and Error Updates

Description added to a group of radio components
Multiple Radio Description

@scurker scurker changed the title Input / Select / Combobox Description Text Input Description / Error Text Sep 3, 2024
@scurker scurker added the rfc An issue proposing a new significant change label Sep 3, 2024
@scurker scurker added this to the Future milestone Sep 10, 2024
@scurker scurker modified the milestones: Future, Q4 2024 Oct 1, 2024
@amberfrontend
Copy link

amberfrontend commented Oct 31, 2024

I have a fix for this, but I'm not sure I have permission to push up a PR.

@scurker
Copy link
Member Author

scurker commented Nov 1, 2024

Hey @amberfrontend 👋

I believe you should have permissions to create a PR, but it might need to be from a fork. If that doesn't work let me know and I can double check the contributor settings.

@amberfrontend
Copy link

amberfrontend commented Nov 26, 2024

Hi @scurker I'm sorry for the delay. I was busy and then sick for a bit. I'm unable to submit a PR with a fork, either. Do you have a bit more detail about your contributing process (permissions, SSR or HTTPS, etc)? I'd love to contribute to Cauldron.

@scurker
Copy link
Member Author

scurker commented Dec 10, 2024

@amberfrontend I'd like to help but I'm not sure I know how to help. We've had outside contributors contribute from a fork before (such as this one: #1464). I checked our contributor settings and it should still allow for outside contributors. Are there any errors or issues that you are seeing that you can share?

@scurker scurker modified the milestones: Q4 2024, Q1 2025 Jan 2, 2025
@scurker
Copy link
Member Author

scurker commented Mar 5, 2025

@ezirlingerDQ What's the expected scenario when the label text needs to wrap?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rfc An issue proposing a new significant change
Projects
None yet
Development

No branches or pull requests

3 participants