Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Mugunth007 wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −8
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/scripts/types/catalog.d.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions docs/scripts/util/componentsWithChildren.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export const componentsWithChildren: {
} = {
Accordion: ['Accordion.Item'],
Breadcrumbs: [
'Breadcrumbs.Container',
'Breadcrumbs.Item',
'Breadcrumbs.Link',
'Breadcrumbs.Separator',
Expand Down
4 changes: 2 additions & 2 deletions packages/react/src/primitives/Breadcrumbs/Breadcrumbs.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import * as React from 'react';

import type {
BaseBreadcrumbProps,
BaseBreadcrumbsProps,
BreadcrumbsProps,
Primitive,
ForwardRefPrimitive,
Expand Down Expand Up @@ -42,7 +42,7 @@ const BreadcrumbsPrimitive: Primitive<BreadcrumbsProps, 'nav'> = (
);
};

type BreadcrumbsType = ForwardRefPrimitive<BaseBreadcrumbProps, 'nav'> & {
type BreadcrumbsType = ForwardRefPrimitive<BaseBreadcrumbsProps, 'nav'> & {
Link: typeof BreadcrumbLink;
Item: typeof BreadcrumbItem;
Separator: typeof BreadcrumbSeparator;
Expand Down
15 changes: 9 additions & 6 deletions packages/react/src/primitives/types/breadcrumbs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,32 @@ import type * as React from 'react';
import type { ElementType, PrimitiveProps, BaseViewProps } from './view';
import type { BaseLinkProps } from './link';

/** @deprecated For internal use only */
export interface BaseBreadcrumbProps extends BaseViewProps {
export interface BaseBreadcrumbsProps extends BaseViewProps {
/**
* @description
* Separator between breadcrumb items
*/
separator?: React.ReactNode;
/**
* @description
* Array of breadcrumb items to render
*/
items?: Array<{
href?: string;
label?: React.ReactNode;
isCurrent?: boolean;
}>;
}

export interface BaseBreadcrumbItemProps extends BaseViewProps {}
export interface BaseBreadcrumbItemProps extends BaseViewProps { }

export interface BaseBreadcrumbLinkProps extends BaseLinkProps {
isCurrent?: boolean;
}

export interface BaseBreadcrumbSeparatorProps extends BaseViewProps {}
export interface BaseBreadcrumbSeparatorProps extends BaseViewProps { }

export interface BaseBreadcrumbContainerProps extends BaseViewProps {}
export interface BaseBreadcrumbContainerProps extends BaseViewProps { }

/**
* Should work with NextJS routing and react-router
Expand All @@ -34,7 +37,7 @@ export interface BaseBreadcrumbContainerProps extends BaseViewProps {}
*/

export type BreadcrumbsProps<Element extends ElementType = 'nav'> =
PrimitiveProps<BaseBreadcrumbProps, Element>;
PrimitiveProps<BaseBreadcrumbsProps, Element>;

export type BreadcrumbsItemProps<Element extends ElementType = 'li'> =
PrimitiveProps<BaseBreadcrumbItemProps, Element>;
Expand Down
Loading