docs-bug(chips): the "form example" is not fully related to forms
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25k
- Forks
- 6.8k
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 91
Description
Documentation Feedback
We have chips-form-control-example, chips-reactive-form-example components that intend to illustrate how chips interact with the form control.
I see 2 problems here.
-
The interaction with
mat-chip-gridis happening not fully through the formControl. For now the source of chips's list iskeywordssignal, not the formControl:@for (keyword of keywords(); track keyword) {
It seems we should take the formControl as the source of chips's list (not the signal):@for (keyword of formControl.value || []; track keyword) {
Moreover we could get rid of the signal, because the goal of the example is to show the interaction between the formControl and the chips in the template. -
These two examples of
chips-form-control-exampleandchips-reactive-form-examplecomponents duplicate each other. They have the same logic inside of components classes. So it seems we could leave only one of these two examples.
Affected documentation page
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the chips-form-control-example and chips-reactive-form-example components referenced in the issue, and inspect the examples shown on the chips documentation page. Compare their classes and templates; done means the chips list is demonstrated through the formControl rather than the keywords signal and the duplicated example is removed or consolidated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- angular, typescript
- Domain
- documentation, frontend
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100