Skip to content

Conversation

web-padawan
Copy link
Member

Description

While JSDoc annotations were originally used only for API docs, they are also used by code completion.
This creates a problem as links to other components such as <vaadin-text-field> do not work:

Screenshot 2025-08-25 at 14 25 27 Screenshot 2025-08-25 at 14 25 31

Updated all field components to use respective part names and state attributes. Also aligned indentation.

Type of change

  • Docs

Note

I'll update #10028 based on this PR to add has-tooltip for all components where it's needed.

@web-padawan web-padawan force-pushed the docs/parts-states-improve branch from ef9119a to 9d7d1cb Compare August 25, 2025 12:02
* `focus-ring` | Set when the element is keyboard focused
* `readonly` | Set when the element is readonly
*
* Note, the `input-prevented` state attribute is only supported when `allowedCharPattern` is set.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added this missing line and also changed the block indentation to align with other components.

Copy link

* `has-helper` | Set when the element has helper text or slot
* `has-error-message` | Set when the element has an error message
* `invalid` | Set when the element is invalid
* `input-prevented` | Temporarily set when invalid input is prevented
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This component has allowedCharPattern by default so I didn't add a note about input-prevented here.

@web-padawan web-padawan removed the request for review from DiegoCardoso August 25, 2025 12:33
@web-padawan web-padawan merged commit 2198726 into main Aug 25, 2025
9 checks passed
@web-padawan web-padawan deleted the docs/parts-states-improve branch August 25, 2025 12:35
@vaadin-bot
Copy link
Collaborator

Hi @web-padawan and @web-padawan, when i performed cherry-pick to this commit to 24.9, i have encountered the following issue. Can you take a look and pick it manually?
Error Message:
Error: Command failed: git cherry-pick 2198726
error: could not apply 2198726... docs: list parts and attributes in JSDoc of all field components (#10068)
hint: After resolving the conflicts, mark them with
hint: "git add/rm ", then run
hint: "git cherry-pick --continue".
hint: You can instead skip this commit with "git cherry-pick --skip".
hint: To abort and get back to the state before "git cherry-pick",
hint: run "git cherry-pick --abort".

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

Successfully merging this pull request may close these issues.

3 participants