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: add ux description for textarea #1520

Draft
wants to merge 3 commits into
base: feat/select-validation
Choose a base branch
from

Conversation

flxlst09
Copy link
Collaborator

🆕 What is the new behavior?

New UX description for textarea

🏁 Checklist

A pull request can only be merged if all of these conditions are met (where applicable):

  • 🦮 Accessibility (a11y) features were implemented
  • 🗺️ Internationalization (i18n) - no hard coded strings
  • 📲 Responsiveness - components handle viewport changes and content overflow gracefully
  • 📄 Documentation was reviewed/updated (pnpm run docs)
  • 🧪 Unit tests were added/updated and pass (pnpm test)
  • 📸 Visual regression tests were added/updated and pass (Guide)
  • 🧐 Static code analysis passes (pnpm lint)
  • 🏗️ Successful compilation (pnpm build, changes pushed)

👨‍💻 Help & support

Copy link

changeset-bot bot commented Oct 15, 2024

⚠️ No Changeset found

Latest commit: f274116

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@flxlst09 flxlst09 marked this pull request as ready for review October 15, 2024 19:31
@flxlst09 flxlst09 closed this Oct 15, 2024
@flxlst09 flxlst09 reopened this Oct 16, 2024
@danielleroux danielleroux marked this pull request as draft October 16, 2024 05:42
- **Show text as tooltip**: [See form field](./forms/forms-field.md)
- **Placeholder text**: [See form field](./forms/forms-field.md)
- **Counter**: [See form field](./forms/forms-field.md)
- **Resize behavior**: Determines how textareas can be resized (both directions, horizontally, vertically, no resizing)
Copy link
Collaborator

Choose a reason for hiding this comment

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

We need to include: what is the standard size, what is our default version, and when do we use each option?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Additionally, is this an option or should it be handled in the behavior in context

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Changed it to have a short notice on resizing options (both, horiz, vert, none) here and guidance how to use it in the behavior section.

- Do use the textarea for inputs that require multiple lines of text, such as comments, feedback, or detailed descriptions
- Do ensure the textarea is appropriately sized for the expected input
- Do use the placeholder attribute to give users an example of the expected input
- Do use minimum and maximum character limits to handle edge cases
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do set minimum and maximum character limits to ensure proper input length

![Textarea overview](https://www.figma.com/design/wEptRgAezDU1z80Cn3eZ0o/iX-Pattern-Illustrations?node-id=3814-1128&t=DtCmoFcLwhf7ke3S-4)
1. Label
2. Required field indicator (optional)
3. Placeholder text
Copy link
Collaborator

Choose a reason for hiding this comment

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

Only "Placeholder"

Copy link

sonarcloud bot commented Oct 21, 2024

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.

2 participants