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.

Sign up for GitHub

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

Jump to bottom

Add IDs (and documentation) to HTML components #303

Open

NXXR opened this issue Sep 13, 2023 · 0 comments

Labels

class:refactoring type:web-frontend

Collaborator

NXXR commented Sep 13, 2023

Every HTML component should get an ID tag to help debugging and readability.

  <Box
+ id='scenario-view-root'
  sx={{
    display: 'flex',
    cursor: 'default',
    background: theme.palette.background.default,
    maxWidth: '100%',
  }}
  >
  ...
  </Box>

Additionally HTML components should receive a comment documenting the element if the ID is not descriptive enough.

+ <Box // Root container of the scenario card section
+ id='scenario-view-root'
  sx={{
    display: 'flex',
    cursor: 'default',
    background: theme.palette.background.default,
    maxWidth: '100%',
  }}
  >
  ...
  </Box>

NXXR added type:web-frontend class:refactoring labels

NXXR added this to ESID

github-project-automation bot moved this to 🆕 New in ESID

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment