angular / angular/components

docs-bug(mat-tab-nav-panel): Documentation implies that [tabPanel] is optional, but must be specified.

Open
#26,270 6 comments 10 reactions 0 assignees View on GitHub
area: material.angular.io area: material/tabs docs P4
Dominant language
TypeScript
Stars
25k
Forks
6.8k
Avg merge
1d 8h
Merged PRs (30d)
91

Description

### Documentation Feedback

The documentation implies that [tabPanel] can be left unprovided by saying "If not provided, then the nav bar follows the ARIA link / navigation landmark pattern".

However, if left unprovided, it will throw an error stating: "A mat-tab-nav-panel must be specified via [tabPanel]".

### Affected documentation page

https://material.angular.io/components/tabs/api#MatTabNav

Contributor guide

Open the contributing guide

Research direction

Start with the MatTabNav section on the affected API documentation page and compare its wording about [tabPanel] with the reported error. Update the documentation so it accurately describes whether [tabPanel] is required, then verify the page no longer implies that it can be omitted.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, typescript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.