fix(docs): add missing Breadcrumbs component props to Props tab

[Mugunth007]

Description

Fixes #4497

The Breadcrumbs component's Props tab on the documentation site was empty because the interface name BaseBreadcrumbProps (singular) did not match the component name Breadcrumbs (plural).

Root Cause

The isPropMainCategory function in docs/scripts/generate-props-tables-data.ts uses:
s const isCurrentComponentProp = category.toLowerCase().includes(componentName.toLowerCase());

Since 'basebreadcrumbprops' does not include 'breadcrumbs', the Breadcrumbs-specific props (items, separator) were filtered out of the Main props table.

Changes

1. Renamed BaseBreadcrumbProps BaseBreadcrumbsProps to match the component name Breadcrumbs
2. Removed misleading @deprecated For internal use only JSDoc annotation
3. Added JSDoc @description for the items prop
4. Added Breadcrumbs.Container to componentsWithChildren
5. Registered Breadcrumbs.Container in ComponentName type and BaseBreadcrumbsProps in Category type in catalog.d.ts

Files Changed

• packages/react/src/primitives/types/breadcrumbs.ts — Core type rename + JSDoc
• packages/react/src/primitives/Breadcrumbs/Breadcrumbs.tsx — Updated import/type reference
• docs/scripts/util/componentsWithChildren.ts — Added Container sub-component
• docs/scripts/types/catalog.d.ts — Registered new type entries

Testing

After running yarn build:props-tables in the docs/ directory, the Props tab should now display:

• Breadcrumbs: items, separator props
• Breadcrumbs.Link: isCurrent prop
• Breadcrumbs.Item, Breadcrumbs.Separator, Breadcrumbs.Container: base props

[changeset-bot]

⚠️ No Changeset found

Latest commit: 024b7ce

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[bobbor]

nice catch. thanks for the fix. LGTM

[bobbor]

hey @Mugunth007

I have ran the tests and the docs e2e is failing.
because Breadcrumbs.Container is exported now, it adds its props to the snapshot of the "Props Table" test here: https://github.com/aws-amplify/amplify-ui/blob/main/docs/__tests__/props-table.test.ts

So you would need to update the snapshot.