aws-amplify / aws-amplify/amplify-ui

Breadcrumb component docs are missing component specific props

Open
#4,497 0 comments 0 reactions 0 assignees View on GitHub
bug Documentation good first issue
Dominant language
TypeScript
Stars
1.1k
Forks
347
Avg merge
18h 29m
Merged PRs (30d)
9

Description

### Before creating a new issue, please confirm:

- [X] I have [searched for duplicate or closed issues](https://github.com/aws-amplify/amplify-ui/issues?q=is%3Aissue+) and [discussions](https://github.com/aws-amplify/amplify-ui/discussions).
- [X] I have tried disabling all browser extensions or using a different browser
- [X] I have tried deleting the node_modules folder and reinstalling my dependencies
- [X] I have read the guide for [submitting bug reports](https://github.com/aws-amplify/amplify-ui/blob/main/CONTRIBUTING.md#bug-reports).

### On which framework/platform are you having an issue?

React

### Which UI component?

Other

### How is your app built?

N/A

### What browsers are you seeing the problem on?

_No response_

### Which region are you seeing the problem in?

_No response_

### Please describe your bug.

The documentation for the react Breadcrumb component is missing the component specific props in the props tab https://ui.docs.amplify.aws/react/components/breadcrumbs?tab=props.

### What's the expected behaviour?

The breadcrumb component and subcomponents should list and describe, in the props tab, the props that they accept such as `items`, `separator`, `isCurrent`, etc.

### Help us reproduce the bug!

Breadcrumb prop page can be found https://ui.docs.amplify.aws/react/components/breadcrumbs?tab=props

### Code Snippet

```typescript
// Put your code below this line.

```

### Console log output

_No response_

### Additional information and screenshots

_No response_

Contributor guide

Open the contributing guide

Research direction

Start at the Breadcrumb documentation props tab linked in the issue and inspect how the component and its subcomponents are represented there. Document the accepted props, including items, separator, and isCurrent, with descriptions; the props tab should list the component-specific props for Breadcrumb and its subcomponents.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.