@carbon/ibm-products
Version:
Carbon for IBM Products
94 lines • 2.72 kB
TypeScript
/**
* Copyright IBM Corp. 2026
*
* This source code is licensed under the Apache-2.0 license found in the
* LICENSE file in the root directory of this source tree.
*/
import React, { ReactNode } from 'react';
import { type SearchProps, type TagProps, type BreadcrumbProps, type BreadcrumbItemProps, type LinkProps } from '@carbon/react';
/**
* ----------------
* AddSelectBody
* ----------------
*/
export interface AddSelectBodyProps {
children?: ReactNode;
/**
* Optional class name
*/
className?: string;
/**
* Label for items section
*/
itemsLabel?: string;
/**
* Global search label
*/
globalSearchLabel?: string;
/**
* Global search placeholder
*/
globalSearchPlaceholder?: string;
/**
* Search results title
*/
searchResultsTitle?: string;
/**
* Item count for display
*/
itemCount?: number;
/**
* Navigation path for breadcrumbs
*/
path?: Array<{
id: string;
title: string;
}>;
/**
* Callback when search term changes
*/
onSearch?: (searchTerm: string) => void;
/**
* Callback when breadcrumb is clicked
*/
onBreadcrumbClick?: (index: number) => void;
/**
* Custom header content (slot) - replaces entire header
*/
headerContent?: ReactNode;
/**
* Actions slot - adds custom actions (filter/sort) next to default search
*/
actionsSlot?: ReactNode;
/**
* Sub-header actions - custom content/actions rendered after breadcrumbs and item count
*/
subHeaderActions?: ReactNode;
/**
* Whether to hide the search input
*/
hideSearch?: boolean;
/**
* Additional props to pass to the Search component
*/
searchProps?: Omit<SearchProps, 'labelText' | 'placeholder' | 'size' | 'onChange' | 'value'>;
/**
* Additional props to pass to the Tag component (for item count)
*/
tagProps?: Omit<TagProps<'div'>, 'type' | 'size' | 'children'>;
/**
* Additional props to pass to the Breadcrumb component
*/
breadcrumbProps?: Omit<BreadcrumbProps, 'noTrailingSlash' | 'className' | 'children'>;
/**
* Additional props to pass to BreadcrumbItem components
*/
breadcrumbItemProps?: Omit<BreadcrumbItemProps, 'key' | 'isCurrentPage' | 'children'>;
/**
* Additional props to pass to Link components in breadcrumbs
*/
linkProps?: Omit<LinkProps<'a'>, 'href' | 'onClick' | 'children'>;
}
declare const AddSelectBody: React.ForwardRefExoticComponent<AddSelectBodyProps & React.RefAttributes<HTMLDivElement>>;
export default AddSelectBody;
//# sourceMappingURL=AddSelectBody.d.ts.map