@atlaskit/breadcrumbs
Version:
Breadcrumbs are a navigation system used to show a user's location in a site or app.
33 lines (32 loc) • 1.61 kB
TypeScript
import type { BreadcrumbsItemProps } from '../../types';
type StepProps = {
children?: BreadcrumbsItemProps['text'];
'aria-current'?: 'page' | boolean;
'aria-label'?: BreadcrumbsItemProps['aria-label'];
'aria-labelledby'?: BreadcrumbsItemProps['aria-labelledby'];
'aria-describedby'?: React.HTMLAttributes<HTMLElement>['aria-describedby'];
analyticsContext?: BreadcrumbsItemProps['analyticsContext'];
elemBefore?: BreadcrumbsItemProps['elemBefore'];
href?: BreadcrumbsItemProps['href'];
target?: BreadcrumbsItemProps['target'];
iconBefore?: BreadcrumbsItemProps['iconBefore'];
iconAfter?: BreadcrumbsItemProps['iconAfter'];
onClick?: BreadcrumbsItemProps['onClick'];
onBlur?: React.FocusEventHandler<HTMLElement>;
onFocus?: React.FocusEventHandler<HTMLElement>;
onMouseDown?: React.MouseEventHandler<HTMLElement>;
onMouseMove?: React.MouseEventHandler<HTMLElement>;
onMouseOut?: React.MouseEventHandler<HTMLElement>;
onMouseOver?: React.MouseEventHandler<HTMLElement>;
testId?: BreadcrumbsItemProps['testId'];
title?: BreadcrumbsItemProps['title'];
truncationWidth?: BreadcrumbsItemProps['truncationWidth'];
triggerProps?: Pick<React.HTMLAttributes<HTMLElement>, 'aria-describedby' | 'onBlur' | 'onClick' | 'onFocus' | 'onMouseDown' | 'onMouseMove' | 'onMouseOut' | 'onMouseOver'>;
};
/**
* __Step__
*
* A button that represents a single step in a breadcrumbs component.
*/
declare const Step: React.ForwardRefExoticComponent<React.PropsWithoutRef<StepProps> & React.RefAttributes<HTMLElement>>;
export default Step;