docs: update API docs#5842
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
There was a problem hiding this comment.
Pull Request Overview
This PR updates API documentation across multiple components to add new properties and methods. The changes focus on adding support for the download attribute for link-based components and the showPicker method for form components.
- Adds
downloadproperty documentation for button, chip, and icon button components when used as links - Adds
showPickermethod documentation for text field and select components - Adds
clickmethod documentation for list components
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/components/button.md | Adds download property to all button variants for link functionality |
| docs/components/chip.md | Adds download property to chip components when used as links |
| docs/components/icon-button.md | Adds download property to all icon button variants for link functionality |
| docs/components/text-field.md | Adds showPicker method for browser date/time picker support |
| docs/components/select.md | Adds showPicker method for opening the select picker |
| docs/components/list.md | Adds click method to list component API |
| docs/components/progress.md | Minor formatting change - adds empty line before API section |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
|
||
| | Method | Parameters | Returns | Description | | ||
| | --- | --- | --- | --- | | ||
| | `click` | _None_ | `void` | | |
There was a problem hiding this comment.
The description column for the click method is empty. This method should have a meaningful description explaining what it does and when to use it.
| | `click` | _None_ | `void` | | | |
| | `click` | _None_ | `void` | Programmatically triggers a click action on the list item. Use this method to simulate a user click or to invoke any click event handlers associated with the item. | |
|
We have a bot that does this automatically (#5841) |
No description provided.