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

USWDS-proposals: Text input web component pre-alpha #17

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

amyleadem
Copy link
Contributor

@amyleadem amyleadem commented Nov 26, 2024

Summary

Design the code structure for the text input web component.

Related issue

Closes uswds/uswds-elements#111

Preview link

Pre-alpha for text input

Tasks

  • Gather code samples from the landscape
  • Identify and document the component’s critical content
    • Document the component content that is critical for end-user understanding. Note: This critical content should always appear on the page, even in non-JS environments.
  • Design and document the structure for the light DOM
  • Design and document the structure for the shadow DOM
  • Design and document the expected component customization methods
    • List and define the proposed component variants
    • List and define props
    • List and define slots
    • List and define CSS Parts
    • List and define CSS Variables
    • List any component content that will need to be translated into other languages

Testing and review

  • Confirm the critical content has been appropriately identified and is included in the light DOM
  • Confirm that the light DOM design matches convention
  • Confirm that the shadow DOM design matches convention
  • Confirm that the existing variants have been accounted for
  • Confirm that the existing settings have been accounted for
  • Confirm the proposed additional variants meet the needs of users and make sense
  • Confirm the proposed additional settings/CSS custom properties meet the needs of users and make sense
  • Confirm the proposed parts are comprehensive and allow users to customize the component

@amyleadem amyleadem linked an issue Nov 26, 2024 that may be closed by this pull request
12 tasks
@amyleadem
Copy link
Contributor Author

Next steps

  • Make hint a prop or slot or
    • Consider if hints will have rich text or escaped characters
  • Convert usa-hint to a <p>
  • Add numbers to pre-release template for easier reference
  • Consider converting to a markdown PR
  • Consider adding open questions/proposals section

@amyleadem amyleadem marked this pull request as ready for review December 13, 2024 16:19
@amyleadem amyleadem requested a review from a team as a code owner December 13, 2024 16:19
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.

Web components - Text input: Pre-alpha
1 participant