Skip to content

react-breadcrumb.api.md

Latest commit

 

History

History
206 lines (146 loc) · 7.24 KB

react-breadcrumb.api.md

File metadata and controls

206 lines (146 loc) · 7.24 KB

API Report File for "@fluentui/react-breadcrumb"

Do not edit this file. It is a report generated by API Extractor.

import { ButtonProps } from '@fluentui/react-button';
import { ButtonSlots } from '@fluentui/react-button';
import { ButtonState } from '@fluentui/react-button';
import type { ComponentProps } from '@fluentui/react-utilities';
import type { ComponentState } from '@fluentui/react-utilities';
import type { ForwardRefComponent } from '@fluentui/react-utilities';
import type { JSXElement } from '@fluentui/react-utilities';
import * as React_2 from 'react';
import type { Slot } from '@fluentui/react-utilities';
import type { SlotClassNames } from '@fluentui/react-utilities';
import { TabsterDOMAttribute } from '@fluentui/react-tabster';

// @public
export const Breadcrumb: ForwardRefComponent<BreadcrumbProps>;

// @public (undocumented)
export type BreadcrumbBaseProps = Omit<BreadcrumbProps, 'size'>;

// @public (undocumented)
export type BreadcrumbBaseState = Omit<BreadcrumbState, 'size'>;

// @public
export const BreadcrumbButton: ForwardRefComponent<BreadcrumbButtonProps>;

// @public (undocumented)
export type BreadcrumbButtonBaseProps = Omit<BreadcrumbButtonProps, 'size'>;

// @public (undocumented)
export type BreadcrumbButtonBaseState = Omit<BreadcrumbButtonState, 'appearance' | 'size' | 'shape'>;

// @public
export const breadcrumbButtonClassNames: SlotClassNames<BreadcrumbButtonSlots>;

// @public
export type BreadcrumbButtonProps = ComponentProps<BreadcrumbButtonSlots> & Pick<BreadcrumbProps, 'size'> & Pick<ButtonProps, 'disabled' | 'disabledFocusable'> & {
    current?: boolean;
};

// @public (undocumented)
export type BreadcrumbButtonSlots = ButtonSlots;

// @public
export type BreadcrumbButtonState = ComponentState<BreadcrumbButtonSlots> & Omit<ButtonState, keyof ButtonSlots | 'components'> & Required<Pick<BreadcrumbButtonProps, 'current' | 'size'>>;

// @public (undocumented)
export const breadcrumbClassNames: SlotClassNames<BreadcrumbSlots>;

// @public
export type BreadcrumbContextValues = Required<Pick<BreadcrumbProps, 'size'>>;

// @public
export const BreadcrumbDivider: ForwardRefComponent<BreadcrumbDividerProps>;

// @public
export type BreadcrumbDividerBaseProps = BreadcrumbDividerProps;

// @public
export type BreadcrumbDividerBaseState = Omit<BreadcrumbDividerState, 'size'>;

// @public (undocumented)
export const breadcrumbDividerClassNames: SlotClassNames<BreadcrumbDividerSlots>;

// @public
export type BreadcrumbDividerProps = ComponentProps<BreadcrumbDividerSlots> & {};

// @public (undocumented)
export type BreadcrumbDividerSlots = {
    root: Slot<'li'>;
};

// @public
export type BreadcrumbDividerState = ComponentState<BreadcrumbDividerSlots> & Pick<BreadcrumbProps, 'size'>;

// @public
export const BreadcrumbItem: ForwardRefComponent<BreadcrumbItemProps>;

// @public
export type BreadcrumbItemBaseProps = Omit<BreadcrumbItemProps, 'size'>;

// @public
export type BreadcrumbItemBaseState = Omit<BreadcrumbItemState, 'size'>;

// @public (undocumented)
export const breadcrumbItemClassNames: SlotClassNames<BreadcrumbItemSlots>;

// @public
export type BreadcrumbItemProps = ComponentProps<BreadcrumbItemSlots> & Pick<BreadcrumbProps, 'size'>;

// @public (undocumented)
export type BreadcrumbItemSlots = {
    root: Slot<'li'>;
};

// @public
export type BreadcrumbItemState = ComponentState<BreadcrumbItemSlots> & Required<Pick<BreadcrumbItemProps, 'size'>>;

// @public
export type BreadcrumbProps = ComponentProps<BreadcrumbSlots> & {
    focusMode?: 'arrow' | 'tab';
    size?: 'small' | 'medium' | 'large';
};

// @internal (undocumented)
export const BreadcrumbProvider: React_2.Provider<Required<Pick<BreadcrumbProps, "size">> | undefined>;

// @public (undocumented)
export type BreadcrumbSlots = {
    root: Slot<'nav'>;
    list?: Slot<'ol'>;
};

// @public
export type BreadcrumbState = ComponentState<BreadcrumbSlots> & Required<Pick<BreadcrumbProps, 'size'>>;

// @public (undocumented)
export const isTruncatableBreadcrumbContent: (content: string, maxLength: number) => boolean;

// @public (undocumented)
export type PartitionBreadcrumbItems<T> = {
    startDisplayedItems: readonly T[];
    overflowItems?: readonly T[];
    endDisplayedItems?: readonly T[];
};

// @public
export const partitionBreadcrumbItems: <T>(options: PartitionBreadcrumbItemsOptions<T>) => PartitionBreadcrumbItems<T>;

// @public (undocumented)
export type PartitionBreadcrumbItemsOptions<T> = {
    items: readonly T[];
    maxDisplayedItems?: number;
    overflowIndex?: number;
};

// @public
export const renderBreadcrumb_unstable: (state: BreadcrumbBaseState, contextValues: BreadcrumbContextValues) => JSXElement;

// @public
export const renderBreadcrumbButton_unstable: (state: BreadcrumbButtonBaseState) => JSXElement;

// @public
export const renderBreadcrumbDivider_unstable: (state: BreadcrumbDividerBaseState) => JSXElement;

// @public
export const renderBreadcrumbItem_unstable: (state: BreadcrumbItemBaseState) => JSXElement;

// @public (undocumented)
export const truncateBreadcrumbLongName: (content: string, maxLength?: number) => string;

// @public (undocumented)
export const truncateBreadcrumLongTooltip: (content: string, maxLength?: number) => string;

// @public
export const useBreadcrumb_unstable: (props: BreadcrumbProps, ref: React_2.Ref<HTMLElement>) => BreadcrumbState;

// @public
export const useBreadcrumbA11yBehavior_unstable: ({ focusMode, }: Pick<BreadcrumbBaseProps, "focusMode">) => Partial<TabsterDOMAttribute>;

// @public
export const useBreadcrumbBase_unstable: (props: BreadcrumbBaseProps, ref: React_2.Ref<HTMLElement>) => BreadcrumbBaseState;

// @public
export const useBreadcrumbButton_unstable: (props: BreadcrumbButtonProps, ref: React_2.Ref<HTMLButtonElement | HTMLAnchorElement>) => BreadcrumbButtonState;

// @public
export const useBreadcrumbButtonBase_unstable: (props: BreadcrumbButtonBaseProps, ref: React_2.Ref<HTMLButtonElement | HTMLAnchorElement>) => BreadcrumbButtonBaseState;

// @public
export const useBreadcrumbButtonStyles_unstable: (state: BreadcrumbButtonState) => BreadcrumbButtonState;

// @internal (undocumented)
export const useBreadcrumbContext_unstable: () => BreadcrumbContextValues;

// @public (undocumented)
export function useBreadcrumbContextValues_unstable(state: BreadcrumbState): BreadcrumbContextValues;

// @public
export const useBreadcrumbDivider_unstable: (props: BreadcrumbDividerProps, ref: React_2.Ref<HTMLLIElement>) => BreadcrumbDividerState;

// @public
export const useBreadcrumbDividerBase_unstable: (props: BreadcrumbDividerBaseProps, ref: React_2.Ref<HTMLLIElement>) => BreadcrumbDividerBaseState;

// @public
export const useBreadcrumbDividerStyles_unstable: (state: BreadcrumbDividerState) => BreadcrumbDividerState;

// @public
export const useBreadcrumbItem_unstable: (props: BreadcrumbItemProps, ref: React_2.Ref<HTMLLIElement>) => BreadcrumbItemState;

// @public
export const useBreadcrumbItemBase_unstable: (props: BreadcrumbItemBaseProps, ref: React_2.Ref<HTMLLIElement>) => BreadcrumbItemBaseState;

// @public
export const useBreadcrumbItemStyles_unstable: (state: BreadcrumbItemState) => BreadcrumbItemState;

// @public
export const useBreadcrumbStyles_unstable: (state: BreadcrumbState) => BreadcrumbState;

// (No @packageDocumentation comment for this package)