Back to Fluentui

React Link.Api

packages/react-components/react-link/library/etc/react-link.api.md

4.40.2-hotfix22.1 KB
Original Source

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

ts

import { BackgroundAppearanceContextValue } from '@fluentui/react-shared-contexts';
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';

// @public
export const Link: ForwardRefComponent<LinkProps>;

// @public (undocumented)
export const linkClassNames: SlotClassNames<LinkSlots>;

// @public (undocumented)
export const linkContextDefaultValue: LinkContextValue;

// @public (undocumented)
export const LinkContextProvider: React_2.Provider<LinkContextValue | undefined>;

// @public (undocumented)
export type LinkContextValue = {
    inline?: boolean;
};

// @public (undocumented)
export type LinkProps = ComponentProps<LinkSlots> & {
    appearance?: 'default' | 'subtle';
    disabled?: boolean;
    disabledFocusable?: boolean;
    inline?: boolean;
};

// @public (undocumented)
export type LinkSlots = {
    root: Slot<'a', 'button' | 'span'>;
};

// @public (undocumented)
export type LinkState = ComponentState<LinkSlots> & Required<Pick<LinkProps, 'appearance' | 'disabled' | 'disabledFocusable' | 'inline'>> & {
    backgroundAppearance?: BackgroundAppearanceContextValue;
};

// @public
export const renderLink_unstable: (state: LinkState) => JSXElement;

// @public
export const useLink_unstable: (props: LinkProps, ref: React_2.Ref<HTMLAnchorElement | HTMLButtonElement | HTMLSpanElement>) => LinkState;

// @public (undocumented)
export const useLinkContext: () => LinkContextValue;

// @public
export const useLinkState_unstable: (state: LinkState) => LinkState;

// @public (undocumented)
export const useLinkStyles_unstable: (state: LinkState) => LinkState;

// (No @packageDocumentation comment for this package)