-
Notifications
You must be signed in to change notification settings - Fork 87
docs: list parts and attributes in JSDoc of all field components #10068
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
Conversation
ef9119a
to
9d7d1cb
Compare
* `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. |
There was a problem hiding this comment.
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.
|
* `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 |
There was a problem hiding this comment.
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.
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? |
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:Updated all field components to use respective part names and state attributes. Also aligned indentation.
Type of change
Note
I'll update #10028 based on this PR to add
has-tooltip
for all components where it's needed.