Back to Fluentui

React Cards.Api

packages/react-cards/etc/react-cards.api.md

4.40.2-hotfix26.1 KB
Original Source

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

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

ts

import { IBaseProps } from '@fluentui/react/lib/Utilities';
import { IComponent } from '@fluentui/foundation-legacy';
import { IComponentStyles } from '@fluentui/foundation-legacy';
import { ISlotProp } from '@fluentui/foundation-legacy';
import { IStackItemProps } from '@fluentui/react/lib/Stack';
import { IStackItemSlots } from '@fluentui/react/lib/Stack';
import { IStackItemTokens } from '@fluentui/react/lib/Stack';
import { IStackProps } from '@fluentui/react/lib/Stack';
import { IStackSlot } from '@fluentui/react/lib/Stack';
import { IStackSlots } from '@fluentui/react/lib/Stack';
import { IStackTokens } from '@fluentui/react/lib/Stack';
import { IStyleableComponentProps } from '@fluentui/foundation-legacy';
import * as React_2 from 'react';

// @public @deprecated (undocumented)
export const Card: React_2.FunctionComponent<ICardProps> & {
    Item: React_2.FunctionComponent<ICardItemProps>;
    Section: React_2.FunctionComponent<ICardSectionProps>;
};

// @public @deprecated (undocumented)
export const CardItem: React_2.FunctionComponent<ICardItemProps>;

// @public @deprecated (undocumented)
export const CardSection: React_2.FunctionComponent<ICardSectionProps>;

// @public @deprecated (undocumented)
export interface ICard {
}

// @public @deprecated (undocumented)
export type ICardComponent = IComponent<ICardProps, ICardTokens, ICardStyles>;

// @public @deprecated (undocumented)
export interface ICardItem {
}

// @public @deprecated (undocumented)
export type ICardItemComponent = IComponent<ICardItemProps, ICardItemTokens, ICardItemStyles, ICardItemViewProps>;

// @public @deprecated (undocumented)
export interface ICardItemProps extends ICardItemSlots, Pick<IStackItemProps, 'grow' | 'shrink' | 'disableShrink' | 'align' | 'verticalFill' | 'order'>, IStyleableComponentProps<ICardItemProps, ICardItemTokens, ICardItemStyles>, IBaseProps<ICardItem> {
    // (undocumented)
    children?: React_2.ReactNode;
    // @deprecated
    fill?: boolean;
}

// @public @deprecated (undocumented)
export type ICardItemSlot = ISlotProp<ICardItemProps>;

// @public @deprecated (undocumented)
export interface ICardItemSlots extends IStackItemSlots {
}

// @public @deprecated (undocumented)
export type ICardItemStyles = IComponentStyles<ICardItemSlots>;

// @public @deprecated (undocumented)
export type ICardItemStylesReturnType = ReturnType<Extract<ICardItemComponent['styles'], Function>>;

// @public @deprecated (undocumented)
export type ICardItemTokenReturnType = ReturnType<Extract<ICardItemComponent['tokens'], Function>>;

// @public @deprecated (undocumented)
export interface ICardItemTokens extends IStackItemTokens {
}

// @public @deprecated (undocumented)
export interface ICardItemViewProps extends ICardItemProps {
}

// @public @deprecated (undocumented)
export interface ICardProps extends ICardSlots, IStyleableComponentProps<ICardProps, ICardTokens, ICardStyles>, IBaseProps<ICard>, React_2.AllHTMLAttributes<HTMLElement> {
    // @deprecated
    horizontal?: boolean;
    // @deprecated
    onClick?: (ev?: React_2.MouseEvent<HTMLElement>) => void;
    // @deprecated
    onKeyDown?: (ev?: React_2.KeyboardEvent<HTMLElement>) => void;
}

// @public @deprecated (undocumented)
export interface ICardSection {
}

// @public @deprecated (undocumented)
export type ICardSectionComponent = IComponent<ICardSectionProps, ICardSectionTokens, ICardSectionStyles, ICardSectionViewProps>;

// @public @deprecated (undocumented)
export interface ICardSectionProps extends ICardSectionSlots, Pick<IStackProps, 'as' | 'horizontal' | 'reversed' | 'horizontalAlign' | 'verticalAlign' | 'verticalFill' | 'disableShrink' | 'grow' | 'wrap'>, IStyleableComponentProps<ICardSectionProps, ICardSectionTokens, ICardSectionStyles>, IBaseProps<ICardSection> {
    // (undocumented)
    children?: React_2.ReactNode;
    // @deprecated
    fill?: boolean;
}

// @public @deprecated (undocumented)
export type ICardSectionSlot = ISlotProp<ICardSectionProps>;

// @public @deprecated (undocumented)
export interface ICardSectionSlots extends Pick<IStackSlots, 'root'> {
}

// @public @deprecated (undocumented)
export type ICardSectionStyles = IComponentStyles<ICardSectionSlots>;

// @public @deprecated (undocumented)
export type ICardSectionStylesReturnType = ReturnType<Extract<ICardSectionComponent['styles'], Function>>;

// @public @deprecated (undocumented)
export type ICardSectionTokenReturnType = ReturnType<Extract<ICardSectionComponent['tokens'], Function>>;

// @public @deprecated (undocumented)
export interface ICardSectionTokens extends IStackTokens {
    // @deprecated
    margin?: number | string;
}

// @public @deprecated (undocumented)
export interface ICardSectionViewProps extends ICardSectionProps {
}

// @public @deprecated (undocumented)
export interface ICardSlots {
    // @deprecated
    root?: IStackSlot;
}

// @public @deprecated (undocumented)
export type ICardStyles = IComponentStyles<ICardSlots>;

// @public @deprecated (undocumented)
export type ICardStylesReturnType = ReturnType<Extract<ICardComponent['styles'], Function>>;

// @public @deprecated (undocumented)
export type ICardTokenReturnType = ReturnType<Extract<ICardComponent['tokens'], Function>>;

// @public @deprecated (undocumented)
export interface ICardTokens extends IStackTokens {
    // @deprecated
    borderFocused?: string;
    // @deprecated
    boxShadow?: string;
    // @deprecated
    boxShadowFocused?: string;
    // @deprecated
    boxShadowHovered?: string;
    // @deprecated
    childrenMargin?: number;
    // @deprecated
    cursor?: string;
    // @deprecated
    height?: number | string;
    // @deprecated
    highContrastBoxShadow?: string;
    // @deprecated
    highContrastBoxShadowFocused?: string;
    // @deprecated
    highContrastBoxShadowHovered?: string;
    // @deprecated
    maxWidth?: number | string;
    // @deprecated
    minHeight?: number | string;
    // @deprecated
    minWidth?: number | string;
    // @deprecated
    width?: number | string;
}

// (No @packageDocumentation comment for this package)