Skip to content

Commit

Permalink
chore: re-generare api.md files
Browse files Browse the repository at this point in the history
  • Loading branch information
@Hotell
Hotell committed Jun 4, 2024
1 parent b1b9217 commit 62c0358
Show file tree
Hide file tree
Showing 7 changed files with 174 additions and 238 deletions.
55 changes: 22 additions & 33 deletions packages/react-components/react-breadcrumb/library/etc/react-breadcrumb.api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts

/// <reference types="react" />

import { ButtonProps } from '@fluentui/react-button';
Expand All @@ -25,19 +26,15 @@ export const BreadcrumbButton: ForwardRefComponent<BreadcrumbButtonProps>;
export const breadcrumbButtonClassNames: SlotClassNames<BreadcrumbButtonSlots>;

// @public
export type BreadcrumbButtonProps = ComponentProps<BreadcrumbButtonSlots> &
Pick<BreadcrumbProps, 'size'> &
Pick<ButtonProps, 'disabled' | 'disabledFocusable'> & {
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'>>;
export type BreadcrumbButtonState = ComponentState<BreadcrumbButtonSlots> & Omit<ButtonState, keyof ButtonSlots | 'components'> & Required<Pick<BreadcrumbButtonProps, 'current' | 'size'>>;

// @public (undocumented)
export const breadcrumbClassNames: SlotClassNames<BreadcrumbSlots>;
Expand All @@ -56,7 +53,7 @@ export type BreadcrumbDividerProps = ComponentProps<BreadcrumbDividerSlots> & {}

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

// @public
Expand All @@ -73,25 +70,25 @@ export type BreadcrumbItemProps = ComponentProps<BreadcrumbItemSlots> & Pick<Bre

// @public (undocumented)
export type BreadcrumbItemSlots = {
root: Slot<'li'>;
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';
focusMode?: 'arrow' | 'tab';
size?: 'small' | 'medium' | 'large';
};

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

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

// @public
Expand All @@ -102,19 +99,19 @@ export const isTruncatableBreadcrumbContent: (content: string, maxLength: number

// @public (undocumented)
export type PartitionBreadcrumbItems<T> = {
startDisplayedItems: readonly T[];
overflowItems?: readonly T[];
endDisplayedItems?: readonly 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;
items: readonly T[];
maxDisplayedItems?: number;
overflowIndex?: number;
};

// @public
Expand All @@ -139,31 +136,22 @@ export const truncateBreadcrumLongTooltip: (content: string, maxLength?: number)
export const useBreadcrumb_unstable: (props: BreadcrumbProps, ref: React_2.Ref<HTMLElement>) => BreadcrumbState;

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

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

// @internal (undocumented)
export const useBreadcrumbContext_unstable: () => Required<Pick<BreadcrumbProps, 'size'>>;
export const useBreadcrumbContext_unstable: () => Required<Pick<BreadcrumbProps, "size">>;

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

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

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

// @public
export const useBreadcrumbItemStyles_unstable: (state: BreadcrumbItemState) => BreadcrumbItemState;
Expand All @@ -172,4 +160,5 @@ export const useBreadcrumbItemStyles_unstable: (state: BreadcrumbItemState) => B
export const useBreadcrumbStyles_unstable: (state: BreadcrumbState) => BreadcrumbState;

// (No @packageDocumentation comment for this package)

```
76 changes: 37 additions & 39 deletions packages/react-components/react-card/library/etc/react-card.api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts

import type { ComponentProps } from '@fluentui/react-utilities';
import type { ComponentState } from '@fluentui/react-utilities';
import type { ForwardRefComponent } from '@fluentui/react-utilities';
Expand All @@ -18,19 +19,19 @@ export const cardClassNames: SlotClassNames<CardSlots>;

// @public
export interface CardContextValue {
// (undocumented)
selectableA11yProps: {
referenceId?: string;
setReferenceId: (referenceId: string) => void;
referenceLabel?: string;
setReferenceLabel: (referenceLabel: string) => void;
};
// (undocumented)
selectableA11yProps: {
referenceId?: string;
setReferenceId: (referenceId: string) => void;
referenceLabel?: string;
setReferenceLabel: (referenceLabel: string) => void;
};
}

// @public
export const cardCSSVars: {
cardSizeVar: string;
cardBorderRadiusVar: string;
cardSizeVar: string;
cardBorderRadiusVar: string;
};

// @public
Expand All @@ -44,8 +45,8 @@ export type CardFooterProps = ComponentProps<CardFooterSlots>;

// @public
export type CardFooterSlots = {
root: Slot<'div'>;
action?: Slot<'div'>;
root: Slot<'div'>;
action?: Slot<'div'>;
};

// @public
Expand All @@ -59,19 +60,19 @@ export const cardHeaderClassNames: SlotClassNames<CardHeaderSlots>;

// @public
export const cardHeaderCSSVars: {
cardHeaderGapVar: string;
cardHeaderGapVar: string;
};

// @public
export type CardHeaderProps = ComponentProps<Partial<CardHeaderSlots>>;

// @public
export type CardHeaderSlots = {
root: Slot<'div'>;
image: Slot<'div', 'img'>;
header: Slot<'div'>;
description: Slot<'div'>;
action?: Slot<'div'>;
root: Slot<'div'>;
image: Slot<'div', 'img'>;
header: Slot<'div'>;
description: Slot<'div'>;
action?: Slot<'div'>;
};

// @public
Expand All @@ -91,45 +92,41 @@ export type CardPreviewProps = ComponentProps<CardPreviewSlots>;

// @public
export type CardPreviewSlots = {
root: Slot<'div'>;
logo?: Slot<'div', 'img'>;
root: Slot<'div'>;
logo?: Slot<'div', 'img'>;
};

// @public
export type CardPreviewState = ComponentState<CardPreviewSlots>;

// @public
export type CardProps = ComponentProps<CardSlots> & {
appearance?: 'filled' | 'filled-alternative' | 'outline' | 'subtle';
focusMode?: 'off' | 'no-tab' | 'tab-exit' | 'tab-only';
orientation?: 'horizontal' | 'vertical';
size?: 'small' | 'medium' | 'large';
selected?: boolean;
defaultSelected?: boolean;
onSelectionChange?: (event: CardOnSelectionChangeEvent, data: CardOnSelectData) => void;
appearance?: 'filled' | 'filled-alternative' | 'outline' | 'subtle';
focusMode?: 'off' | 'no-tab' | 'tab-exit' | 'tab-only';
orientation?: 'horizontal' | 'vertical';
size?: 'small' | 'medium' | 'large';
selected?: boolean;
defaultSelected?: boolean;
onSelectionChange?: (event: CardOnSelectionChangeEvent, data: CardOnSelectData) => void;
};

// @internal (undocumented)
export const CardProvider: React_2.Provider<CardContextValue | undefined>;

// @public
export type CardSlots = {
root: Slot<'div'>;
floatingAction?: Slot<'div'>;
checkbox?: Slot<'input'>;
root: Slot<'div'>;
floatingAction?: Slot<'div'>;
checkbox?: Slot<'input'>;
};

// @public
export type CardState = ComponentState<CardSlots> &
CardContextValue &
Required<
Pick<CardProps, 'appearance' | 'orientation' | 'size'> & {
interactive: boolean;
selectable: boolean;
selected: boolean;
selectFocused: boolean;
}
>;
export type CardState = ComponentState<CardSlots> & CardContextValue & Required<Pick<CardProps, 'appearance' | 'orientation' | 'size'> & {
interactive: boolean;
selectable: boolean;
selected: boolean;
selectFocused: boolean;
}>;

// @public
export const renderCard_unstable: (state: CardState, cardContextValue: CardContextValue) => JSX.Element;
Expand Down Expand Up @@ -171,4 +168,5 @@ export const useCardPreviewStyles_unstable: (state: CardPreviewState) => CardPre
export const useCardStyles_unstable: (state: CardState) => CardState;

// (No @packageDocumentation comment for this package)

```
Loading

0 comments on commit 62c0358

Please sign in to comment.