angular/components

Missing docs for properties/methods

Open

#8832 opened on Dec 6, 2017

View on GitHub
 (12 comments) (1 reaction) (1 assignee)TypeScript (24,044 stars) (6,650 forks)batch import
P3area: manydocshelp wanted

Description

Bug, feature request, or proposal:

Bug/Proposal.

What is the expected behavior?

The listed propeties/methods have no docs.

What is the current behavior?

Here's the list that I found of all missing docs.

Class Properties Methods
MatAutocompleteTrigger autocomplete, panelOpen
MatChip ariaSelected
MatChipInput focused focus
MatChipList controlType , ngControl, role onContainerClick, setDescribedByIds
MatDialogClose dialogRef
MatDialogRef id
MatDialogTitle id
MatDatepickerInput registerOnValidatorChange, validate
MatExpansionPanelHeader panel
MatError id
MatInput empty, ngControl, shouldLabelFloat focus, onContainerClick, setDescribedByIds
MatListOption selectionList
MatSelect ngControl, shouldLabelFloat
MatSlideToggleChange All MatSlideToggleChange properties
SimpleSnackBar snackBarRef

Is there anything else we should know?

Related to #8789.

Contributor guide

Tech stack
typescriptangular
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Angular MaterialAPI documentationTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue lists specific missing docs for properties/methods of several Angular Material components. Check the existing API documentation files for each component (e.g., autocomplete, chips, etc.) and add the missing entries following the format of existing docs. The file structure likely mirrors the component library (e.g., src/lib/autocomplete/). Also review the related issue #8789 for context.