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

Feat: Give all widgets the name parameter #2350 #2408

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

Conversation

akwaed
Copy link

@akwaed akwaed commented Oct 1, 2024

Added name parameters to all applicable widgets
TODO: update doc description to the affected types/members

The PR fulfills these requirements: (check all the apply)

  • It's submitted to the main branch.
  • When resolving a specific issue, it's referenced in the PR's title (e.g. feat: Add a button #xxx, where "xxx" is the issue number).
  • When resolving a specific issue, the PR description includes Closes #xxx, where "xxx" is the issue number.
  • If changes were made to ui folder, unit tests (make test) still pass.
  • New/updated tests are included
  • An audit of all components to make a list of everything that does not have name as a parameter
  • Add name as a parameter to all of these

Added name parameters to all applicable widgets
TODO: update doc description  to the affected types/members
@mturoci
Copy link
Collaborator

mturoci commented Oct 2, 2024

Thanks for the PR.

  • Please make sure that every change works as expected. You might find that name does not make sense for everywhere.
  • Keep the original formatting.
  • Keep the docstrings consistent.

@akwaed
Copy link
Author

akwaed commented Oct 2, 2024

Hey @mturoci did address and fix the issues mentioned in above components. Did remove the name parameters from experimental widgets and where I felt it wasn't necessary. Here is a list of widgets left untouched.

Audit Report: Components missing "name" attribute

File: wave/ui/src/audio_annotator.tsx

  • Window

File: wave/ui/src/canvas.tsx

  • CanvasRenderingContext2D
  • State

File: wave/ui/src/chat.tsx

  • State

File: wave/ui/src/editor.tsx

  • State

File: wave/ui/src/flex.tsx

  • State

File: wave/ui/src/form.tsx

  • Component
  • Inline

File: wave/ui/src/grid.tsx

  • State

File: wave/ui/src/image_annotator.tsx

  • ImageAnnotatorShape

File: wave/ui/src/list.tsx

  • State

File: wave/ui/src/list_item1.tsx

  • State

File: wave/ui/src/nav.tsx

  • NavGroup

File: wave/ui/src/parts/infiniteScroll.tsx

  • Props

File: wave/ui/src/parts/lightbox.tsx

  • LightboxProps

File: wave/ui/src/parts/microbars.tsx

  • Props

File: wave/ui/src/parts/progress_arc.tsx

  • Props

File: wave/ui/src/plot.tsx

  • MarkExt
  • Plot

File: wave/ui/src/repeat.tsx

  • State

File: wave/ui/src/tags.tsx

  • Tags

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