Back to Fluentui

React Provider.Api

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

4.40.2-hotfix23.7 KB
Original Source

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

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

ts

import type { ComponentProps } from '@fluentui/react-utilities';
import type { ComponentState } from '@fluentui/react-utilities';
import type { CustomStyleHooksContextValue_unstable } from '@fluentui/react-shared-contexts';
import type { ForwardRefComponent } from '@fluentui/react-utilities';
import type { IconDirectionContextValue } from '@fluentui/react-icons/lib/providers';
import type { JSXElement } from '@fluentui/react-utilities';
import type { OverridesContextValue_unstable } from '@fluentui/react-shared-contexts';
import type { PartialTheme } from '@fluentui/react-theme';
import type { ProviderContextValue_unstable } from '@fluentui/react-shared-contexts';
import * as React_2 from 'react';
import type { Slot } from '@fluentui/react-utilities';
import { SlotClassNames } from '@fluentui/react-utilities';
import type { ThemeClassNameContextValue_unstable } from '@fluentui/react-shared-contexts';
import type { ThemeContextValue_unstable } from '@fluentui/react-shared-contexts';
import type { TooltipVisibilityContextValue_unstable } from '@fluentui/react-shared-contexts';

// @public
export function createCSSRuleFromTheme(selector: string, theme: PartialTheme | undefined): string;

// @public (undocumented)
export const FluentProvider: ForwardRefComponent<FluentProviderProps>;

// @public (undocumented)
export const fluentProviderClassNames: SlotClassNames<FluentProviderSlots>;

// @public (undocumented)
export type FluentProviderContextValues = Pick<FluentProviderState, 'customStyleHooks_unstable' | 'theme' | 'overrides_unstable'> & {
    provider: ProviderContextValue_unstable;
    themeClassName: ThemeClassNameContextValue_unstable;
    textDirection: 'ltr' | 'rtl';
    iconDirection: IconDirectionContextValue;
    tooltip: TooltipVisibilityContextValue_unstable;
};

// @public (undocumented)
export type FluentProviderCustomStyleHooks = CustomStyleHooksContextValue_unstable;

// @public (undocumented)
export type FluentProviderProps = Omit<ComponentProps<FluentProviderSlots>, 'dir'> & {
    applyStylesToPortals?: boolean;
    customStyleHooks_unstable?: FluentProviderCustomStyleHooks;
    dir?: 'ltr' | 'rtl';
    targetDocument?: Document;
    theme?: PartialTheme;
    overrides_unstable?: OverridesContextValue_unstable;
};

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

// @public (undocumented)
export type FluentProviderState = ComponentState<FluentProviderSlots> & Pick<FluentProviderProps, 'targetDocument'> & Required<Pick<FluentProviderProps, 'applyStylesToPortals' | 'customStyleHooks_unstable' | 'dir' | 'overrides_unstable'>> & {
    theme: ThemeContextValue_unstable;
    themeClassName: string;
    serverStyleProps: {
        cssRule: string;
        attributes: Record<string, string>;
    };
};

// @public
export const renderFluentProvider_unstable: (state: FluentProviderState, contextValues: FluentProviderContextValues) => JSXElement;

// @public
export const useFluentProvider_unstable: (props: FluentProviderProps, ref: React_2.Ref<HTMLElement>) => FluentProviderState;

// @public (undocumented)
export function useFluentProviderContextValues_unstable(state: FluentProviderState): FluentProviderContextValues;

// @public
export const useFluentProviderStyles_unstable: (state: FluentProviderState) => FluentProviderState;

// @internal
export const useFluentProviderThemeStyleTag: (options: Pick<FluentProviderState, "theme" | "targetDocument"> & {
    rendererAttributes: Record<string, string>;
}) => {
    styleTagId: string;
    rule: string;
};

// (No @packageDocumentation comment for this package)