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

Display Required Fields, Supporting Text and Icons for MultiLineTextInput #105

Open
Sn3llius opened this issue Jul 12, 2024 · 0 comments
Open
Labels
enhancement Improves on existing functionality - NOT a new feature ideas wanted Feedback is needed new feature Adds something new, that isn't a component

Comments

@Sn3llius
Copy link
Contributor

Sn3llius commented Jul 12, 2024

Description

Currently, our MultiLineTextInput component lacks the ability to indicate which fields are required, provide supporting text, and display leading and trailing icons. These features are crucial for enhancing user experience by guiding them through forms more effectively, ensuring they understand what information is needed, and improving the overall aesthetics and functionality of the input fields.

Design Guidline

https://m3.material.io/components/text-fields/guidelines

Proposed Solution

Required Fields Indicator:

  • Add is_required attribute to the MultiLineTextInput component.
  • When is_required is set to True, display an asterisk (*) next to the label.
  • Optionally, add a is_required_indicator attribute to allow customization of the indicator (e.g., text, color). needs discussion

Supporting Text:

  • Add supporting_text attribute to the MultiLineTextInput component.
  • The supporting text should be displayed below the input field.
  • Style the supporting text to be visually distinct but not distracting (see Design Guidline).

Leading Icon:

  • Add a leading_icon attribute to the MultiLineTextInput component. naming needs discussion
  • The leading_icon should be displayed inside the MultiLineTextInput, aligned to the left.
  • Allow customization of the icon, which accepts an icon component or a string for the icon name.

Trailing Icon:

  • Add a trailing_icon attribute to the MultiLineTextInput component. naming needs discussion
  • The trailing_icon should be displayed inside the MultiLineTextInput, aligned to the right.
  • Allow customization of the icon, which accepts an icon component or a string for the icon name.

Alternatives

No response

Additional Context

  • Update documentation and examples for these new features.

Related Issues/Pull Requests

#104, #106

@Sn3llius Sn3llius added ideas wanted Feedback is needed new feature Adds something new, that isn't a component enhancement Improves on existing functionality - NOT a new feature labels Jul 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improves on existing functionality - NOT a new feature ideas wanted Feedback is needed new feature Adds something new, that isn't a component
Projects
None yet
Development

No branches or pull requests

1 participant