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

Web components Identifier: Pre-alpha #115

Open
1 of 12 tasks
amyleadem opened this issue Nov 22, 2024 · 1 comment
Open
1 of 12 tasks

Web components Identifier: Pre-alpha #115

amyleadem opened this issue Nov 22, 2024 · 1 comment
Assignees

Comments

@amyleadem
Copy link
Contributor

amyleadem commented Nov 22, 2024

Summary

  • Design a markup structure for the light and shadow DOM
  • Design component variants, props, parts, slots, and vars

Research and planning 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
@amyleadem amyleadem self-assigned this Nov 22, 2024
@amyleadem amyleadem converted this from a draft issue Nov 22, 2024
@amyleadem amyleadem moved this from In progress to On deck in USWDS Core Project Data Nov 22, 2024
@amyleadem amyleadem moved this from On deck to In progress in USWDS Core Project Data Nov 22, 2024
@amyleadem
Copy link
Contributor Author

Identifier component design plan

Landscape analysis

Identifier code samples from the landscape analysis (Google docs 🔒)

Proposed component structure

Critical content

Element Required attributes Content

Sample default implementation:

Shadow DOM

Variants

Current variants

USWDS 3 variant Web components variant Description Defined via

Proposed additional variants

USWDS 3 variant Web components variant Description Defined via

Props

Current variants

Property Description Expected values

Proposed additional variants

Property Description Expected values

Slots

Unnamed slot

CSS Parts

Part name Element

CSS Variables

Current settings

USWDS 3 setting CSS custom property Description

Proposed additional setting

USWDS 3 setting CSS custom property Description

Translatable content

@amyleadem amyleadem moved this from In progress to On deck in USWDS Core Project Data Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: On deck
Development

No branches or pull requests

1 participant