angular/components

[Docs] More details on custom form field controls guide

Open

#13624 opened on Oct 16, 2018

View on GitHub
 (6 comments) (2 reactions) (0 assignees)TypeScript (24,044 stars) (6,650 forks)batch import
P3area: docsarea: material/form-fieldhelp wanted

Description

Bug, feature request, or proposal:

I'd like to request a review of the 'Creating a custom form field control' guide as it does not cover enough in regards to each of it properties and opts to just mentioning them.

What is the expected behaviour?

Common examples that are detailed on other approaches and usages.

What is the current behaviour?

Common examples that are not all detailed on other approaches or usages.

What is the use-case or motivation for changing an existing behaviour?

My biggest gripe that pushed me to make this ticket is that of the error state.

Since we're not using an NgControl in this example, we don't need to do anything other than just set it to false.

Where as it should be like 'ngControl' which has sufficient methods of implementation

It is likely you will want to implement ControlValueAccessor ...

Is there anything else we should know?

Others have had the same issue

https://stackoverflow.com/questions/52017000/angular-material-custom-reactive-form-control-with-error-state/52017769

Contributor guide

Tech stack
typescript
Domain
frontenddocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Angular basicsAngular MaterialReactive forms
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Review the existing custom form field control guide in Angular Material docs. Look at the linked StackOverflow question for common confusion. Provide detailed explanations and examples for each property, especially error state handling. Ensure consistency with similar Angular guides like ControlValueAccessor.