ContextQMD
Back to Fluentui

React Context Selector.Api

packages/react-components/react-context-selector/etc/react-context-selector.api.md

4.40.2-hotfix21.3 KB
Original Source

API Report File for "@fluentui/react-context-selector"

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

ts

import * as React_2 from 'react';

// @internal (undocumented)
export type Context<Value> = React_2.Context<Value> & {
    Provider: React_2.FC<React_2.ProviderProps<Value>>;
    Consumer: never;
};

// @public (undocumented)
export type ContextSelector<Value, SelectedValue> = (value: Value) => SelectedValue;

// @internal (undocumented)
export type ContextValue<Value> = {
    listeners: ((payload: readonly [ContextVersion, Value]) => void)[];
    value: React_2.MutableRefObject<Value>;
    version: React_2.MutableRefObject<ContextVersion>;
};

// @internal (undocumented)
export type ContextValues<Value> = ContextValue<Value> & {
    listeners: ((payload: readonly [ContextVersion, Record<string, Value>]) => void)[];
};

// @internal (undocumented)
export type ContextVersion = number;

// @internal (undocumented)
export const createContext: <Value>(defaultValue: Value) => Context<Value>;

// @internal
export const useContextSelector: <Value, SelectedValue>(context: Context<Value>, selector: ContextSelector<Value, SelectedValue>) => SelectedValue;

// @internal
export function useHasParentContext<Value>(context: Context<Value>): boolean;

// (No @packageDocumentation comment for this package)