@carbon/ibm-products
Version:
Carbon for IBM Products
85 lines • 2.61 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 from 'react';
import PropTypes from 'prop-types';
/**
* --------------------------------
* PageHeaderBreadcrumbPageActions
* --------------------------------
*/
export interface PageHeaderBreadcrumbPageActionItem {
/**
* Unique identifier for the action item
*/
id: string;
/**
* Label for the action (used for icon description and overflow menu item text)
*/
label: string;
/**
* Icon component to render for the action button
*/
renderIcon: React.ComponentType;
/**
* Click handler for the action
*/
onClick?: () => void;
}
export interface PageHeaderBreadcrumbPageActionsProps {
/**
* Array of action items to display
*/
actions: PageHeaderBreadcrumbPageActionItem[];
/**
* Specify an optional className to be added to the component
*/
className?: string;
/**
* Aria label for the overflow menu
*/
overflowMenuLabel?: string;
/**
* Size of the action buttons
*/
buttonSize?: 'sm' | 'md' | 'lg';
/**
* Kind of the action buttons
*/
buttonKind?: 'primary' | 'secondary' | 'tertiary' | 'ghost' | 'danger' | 'danger--tertiary' | 'danger--ghost';
}
export declare const PageHeaderBreadcrumbPageActions: {
({ actions, className, overflowMenuLabel, buttonSize, buttonKind, ...other }: PageHeaderBreadcrumbPageActionsProps): React.JSX.Element;
displayName: string;
propTypes: {
/**
* Array of action items to display
*/
actions: PropTypes.Validator<NonNullable<PropTypes.InferProps<{
id: PropTypes.Validator<string>;
label: PropTypes.Validator<string>;
renderIcon: PropTypes.Validator<NonNullable<PropTypes.ReactComponentLike>>;
onClick: PropTypes.Requireable<(...args: any[]) => any>;
}>>[]>;
/**
* Kind of the action buttons
*/
buttonKind: PropTypes.Requireable<string>;
/**
* Size of the action buttons
*/
buttonSize: PropTypes.Requireable<string>;
/**
* Specify an optional className to be added to the component
*/
className: PropTypes.Requireable<string>;
/**
* Aria label for the overflow menu
*/
overflowMenuLabel: PropTypes.Requireable<string>;
};
};
//# sourceMappingURL=PageHeaderBreadcrumbPageActions.d.ts.map