Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AnimationEventHandler

AnimationEventHandler<T>: EventHandler<AnimationEvent<T>>

Type parameters

  • T

CElement

CElement<P, T>: ComponentElement<P, T>

Type parameters

CFactory

CFactory<P, T>: ComponentFactory<P, T>

Type parameters

ChangeEventHandler

ChangeEventHandler<T>: EventHandler<ChangeEvent<T>>

Type parameters

  • T

ClassType

ClassType<P, T, C>: C & object

We use an intersection type to infer multiple type parameters from a single argument, which is useful for many top-level API defs. See https://github.com/Microsoft/TypeScript/issues/7234 for more info.

Type parameters

ClassicElement

ClassicElement<P>: CElement<P, ClassicComponent<P, ComponentState>>

Type parameters

  • P

ClassicFactory

ClassicFactory<P>: CFactory<P, ClassicComponent<P, ComponentState>>

Type parameters

  • P

ClipboardEventHandler

ClipboardEventHandler<T>: EventHandler<ClipboardEvent<T>>

Type parameters

  • T

ComponentFactory

ComponentFactory<P, T>: function

Type parameters

Type declaration

ComponentProps

ComponentProps<T>: ComponentProps<T>

NOTE: prefer ComponentPropsWithRef, if the ref is forwarded, or ComponentPropsWithoutRef when refs are not supported.

Type parameters

ComponentPropsWithRef

ComponentPropsWithRef<T>: ComponentPropsWithRef<T>

Type parameters

ComponentPropsWithoutRef

ComponentPropsWithoutRef<T>: PropsWithoutRef<ComponentProps<T>>

Type parameters

ComponentState

ComponentState: any

ComponentType

ComponentType<P>: ComponentClass<P> | FunctionComponent<P>

Type parameters

  • P

CompositionEventHandler

CompositionEventHandler<T>: EventHandler<CompositionEvent<T>>

Type parameters

  • T

Consumer

Type parameters

  • T

ContextType

ContextType<C>: ContextType<C>

Type parameters

DOMFactory

DOMFactory<P, T>: function

Type parameters

Type declaration

DependencyList

DependencyList: ReadonlyArray<any>

DetailedHTMLProps

DetailedHTMLProps<E, T>: ClassAttributes<T> & E

Type parameters

Dispatch

Dispatch<A>: function

Type parameters

  • A

Type declaration

    • (value: A): void
    • Parameters

      • value: A

      Returns void

DragEventHandler

DragEventHandler<T>: EventHandler<DragEvent<T>>

Type parameters

  • T

EffectCallback

EffectCallback: function

Type declaration

    • (): void | function
    • Returns void | function

ElementType

ElementType<P>: P extends DetailedHTMLProps<AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement> ? "a" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "abbr" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "address" : never | P extends DetailedHTMLProps<AreaHTMLAttributes<HTMLAreaElement>, HTMLAreaElement> ? "area" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "article" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "aside" : never | P extends DetailedHTMLProps<AudioHTMLAttributes<HTMLAudioElement>, HTMLAudioElement> ? "audio" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "b" : never | P extends DetailedHTMLProps<BaseHTMLAttributes<HTMLBaseElement>, HTMLBaseElement> ? "base" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "bdi" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "bdo" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "big" : never | P extends DetailedHTMLProps<BlockquoteHTMLAttributes<HTMLElement>, HTMLElement> ? "blockquote" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLBodyElement>, HTMLBodyElement> ? "body" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLBRElement>, HTMLBRElement> ? "br" : never | P extends DetailedHTMLProps<ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement> ? "button" : never | P extends DetailedHTMLProps<CanvasHTMLAttributes<HTMLCanvasElement>, HTMLCanvasElement> ? "canvas" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "caption" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "cite" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "code" : never | P extends DetailedHTMLProps<ColHTMLAttributes<HTMLTableColElement>, HTMLTableColElement> ? "col" : never | P extends DetailedHTMLProps<ColgroupHTMLAttributes<HTMLTableColElement>, HTMLTableColElement> ? "colgroup" : never | P extends DetailedHTMLProps<DataHTMLAttributes<HTMLDataElement>, HTMLDataElement> ? "data" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLDataListElement>, HTMLDataListElement> ? "datalist" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "dd" : never | P extends DetailedHTMLProps<DelHTMLAttributes<HTMLElement>, HTMLElement> ? "del" : never | P extends DetailedHTMLProps<DetailsHTMLAttributes<HTMLElement>, HTMLElement> ? "details" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "dfn" : never | P extends DetailedHTMLProps<DialogHTMLAttributes<HTMLDialogElement>, HTMLDialogElement> ? "dialog" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement> ? "div" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLDListElement>, HTMLDListElement> ? "dl" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "dt" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "em" : never | P extends DetailedHTMLProps<EmbedHTMLAttributes<HTMLEmbedElement>, HTMLEmbedElement> ? "embed" : never | P extends DetailedHTMLProps<FieldsetHTMLAttributes<HTMLFieldSetElement>, HTMLFieldSetElement> ? "fieldset" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "figcaption" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "figure" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "footer" : never | P extends DetailedHTMLProps<FormHTMLAttributes<HTMLFormElement>, HTMLFormElement> ? "form" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement> ? "h1" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement> ? "h2" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement> ? "h3" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement> ? "h4" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement> ? "h5" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement> ? "h6" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLHeadElement>, HTMLHeadElement> ? "head" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "header" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "hgroup" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLHRElement>, HTMLHRElement> ? "hr" : never | P extends DetailedHTMLProps<HtmlHTMLAttributes<HTMLHtmlElement>, HTMLHtmlElement> ? "html" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "i" : never | P extends DetailedHTMLProps<IframeHTMLAttributes<HTMLIFrameElement>, HTMLIFrameElement> ? "iframe" : never | P extends DetailedHTMLProps<ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement> ? "img" : never | P extends DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement> ? "input" : never | P extends DetailedHTMLProps<InsHTMLAttributes<HTMLModElement>, HTMLModElement> ? "ins" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "kbd" : never | P extends DetailedHTMLProps<KeygenHTMLAttributes<HTMLElement>, HTMLElement> ? "keygen" : never | P extends DetailedHTMLProps<LabelHTMLAttributes<HTMLLabelElement>, HTMLLabelElement> ? "label" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLLegendElement>, HTMLLegendElement> ? "legend" : never | P extends DetailedHTMLProps<LiHTMLAttributes<HTMLLIElement>, HTMLLIElement> ? "li" : never | P extends DetailedHTMLProps<LinkHTMLAttributes<HTMLLinkElement>, HTMLLinkElement> ? "link" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "main" : never | P extends DetailedHTMLProps<MapHTMLAttributes<HTMLMapElement>, HTMLMapElement> ? "map" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "mark" : never | P extends DetailedHTMLProps<MenuHTMLAttributes<HTMLElement>, HTMLElement> ? "menu" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "menuitem" : never | P extends DetailedHTMLProps<MetaHTMLAttributes<HTMLMetaElement>, HTMLMetaElement> ? "meta" : never | P extends DetailedHTMLProps<MeterHTMLAttributes<HTMLElement>, HTMLElement> ? "meter" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "nav" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "noindex" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "noscript" : never | P extends DetailedHTMLProps<ObjectHTMLAttributes<HTMLObjectElement>, HTMLObjectElement> ? "object" : never | P extends DetailedHTMLProps<OlHTMLAttributes<HTMLOListElement>, HTMLOListElement> ? "ol" : never | P extends DetailedHTMLProps<OptgroupHTMLAttributes<HTMLOptGroupElement>, HTMLOptGroupElement> ? "optgroup" : never | P extends DetailedHTMLProps<OptionHTMLAttributes<HTMLOptionElement>, HTMLOptionElement> ? "option" : never | P extends DetailedHTMLProps<OutputHTMLAttributes<HTMLElement>, HTMLElement> ? "output" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement> ? "p" : never | P extends DetailedHTMLProps<ParamHTMLAttributes<HTMLParamElement>, HTMLParamElement> ? "param" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "picture" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLPreElement>, HTMLPreElement> ? "pre" : never | P extends DetailedHTMLProps<ProgressHTMLAttributes<HTMLProgressElement>, HTMLProgressElement> ? "progress" : never | P extends DetailedHTMLProps<QuoteHTMLAttributes<HTMLQuoteElement>, HTMLQuoteElement> ? "q" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "rp" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "rt" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "ruby" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "s" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "samp" : never | P extends DetailedHTMLProps<ScriptHTMLAttributes<HTMLScriptElement>, HTMLScriptElement> ? "script" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "section" : never | P extends DetailedHTMLProps<SelectHTMLAttributes<HTMLSelectElement>, HTMLSelectElement> ? "select" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "small" : never | P extends DetailedHTMLProps<SourceHTMLAttributes<HTMLSourceElement>, HTMLSourceElement> ? "source" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLSpanElement>, HTMLSpanElement> ? "span" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "strong" : never | P extends DetailedHTMLProps<StyleHTMLAttributes<HTMLStyleElement>, HTMLStyleElement> ? "style" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "sub" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "summary" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "sup" : never | P extends DetailedHTMLProps<TableHTMLAttributes<HTMLTableElement>, HTMLTableElement> ? "table" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLTemplateElement>, HTMLTemplateElement> ? "template" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLTableSectionElement>, HTMLTableSectionElement> ? "tbody" : never | P extends DetailedHTMLProps<TdHTMLAttributes<HTMLTableDataCellElement>, HTMLTableDataCellElement> ? "td" : never | P extends DetailedHTMLProps<TextareaHTMLAttributes<HTMLTextAreaElement>, HTMLTextAreaElement> ? "textarea" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLTableSectionElement>, HTMLTableSectionElement> ? "tfoot" : never | P extends DetailedHTMLProps<ThHTMLAttributes<HTMLTableHeaderCellElement>, HTMLTableHeaderCellElement> ? "th" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLTableSectionElement>, HTMLTableSectionElement> ? "thead" : never | P extends DetailedHTMLProps<TimeHTMLAttributes<HTMLElement>, HTMLElement> ? "time" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLTitleElement>, HTMLTitleElement> ? "title" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLTableRowElement>, HTMLTableRowElement> ? "tr" : never | P extends DetailedHTMLProps<TrackHTMLAttributes<HTMLTrackElement>, HTMLTrackElement> ? "track" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "u" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLUListElement>, HTMLUListElement> ? "ul" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "var" : never | P extends DetailedHTMLProps<VideoHTMLAttributes<HTMLVideoElement>, HTMLVideoElement> ? "video" : never | P extends DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> ? "wbr" : never | P extends DetailedHTMLProps<WebViewHTMLAttributes<HTMLWebViewElement>, HTMLWebViewElement> ? "webview" : never | P extends SVGProps<SVGSVGElement> ? "svg" : never | P extends SVGProps<SVGElement> ? "animate" : never | P extends SVGProps<SVGElement> ? "animateMotion" : never | P extends SVGProps<SVGElement> ? "animateTransform" : never | P extends SVGProps<SVGCircleElement> ? "circle" : never | P extends SVGProps<SVGClipPathElement> ? "clipPath" : never | P extends SVGProps<SVGDefsElement> ? "defs" : never | P extends SVGProps<SVGDescElement> ? "desc" : never | P extends SVGProps<SVGEllipseElement> ? "ellipse" : never | P extends SVGProps<SVGFEBlendElement> ? "feBlend" : never | P extends SVGProps<SVGFEColorMatrixElement> ? "feColorMatrix" : never | P extends SVGProps<SVGFEComponentTransferElement> ? "feComponentTransfer" : never | P extends SVGProps<SVGFECompositeElement> ? "feComposite" : never | P extends SVGProps<SVGFEConvolveMatrixElement> ? "feConvolveMatrix" : never | P extends SVGProps<SVGFEDiffuseLightingElement> ? "feDiffuseLighting" : never | P extends SVGProps<SVGFEDisplacementMapElement> ? "feDisplacementMap" : never | P extends SVGProps<SVGFEDistantLightElement> ? "feDistantLight" : never | P extends SVGProps<SVGFEDropShadowElement> ? "feDropShadow" : never | P extends SVGProps<SVGFEFloodElement> ? "feFlood" : never | P extends SVGProps<SVGFEFuncAElement> ? "feFuncA" : never | P extends SVGProps<SVGFEFuncBElement> ? "feFuncB" : never | P extends SVGProps<SVGFEFuncGElement> ? "feFuncG" : never | P extends SVGProps<SVGFEFuncRElement> ? "feFuncR" : never | P extends SVGProps<SVGFEGaussianBlurElement> ? "feGaussianBlur" : never | P extends SVGProps<SVGFEImageElement> ? "feImage" : never | P extends SVGProps<SVGFEMergeElement> ? "feMerge" : never | P extends SVGProps<SVGFEMergeNodeElement> ? "feMergeNode" : never | P extends SVGProps<SVGFEMorphologyElement> ? "feMorphology" : never | P extends SVGProps<SVGFEOffsetElement> ? "feOffset" : never | P extends SVGProps<SVGFEPointLightElement> ? "fePointLight" : never | P extends SVGProps<SVGFESpecularLightingElement> ? "feSpecularLighting" : never | P extends SVGProps<SVGFESpotLightElement> ? "feSpotLight" : never | P extends SVGProps<SVGFETileElement> ? "feTile" : never | P extends SVGProps<SVGFETurbulenceElement> ? "feTurbulence" : never | P extends SVGProps<SVGFilterElement> ? "filter" : never | P extends SVGProps<SVGForeignObjectElement> ? "foreignObject" : never | P extends SVGProps<SVGGElement> ? "g" : never | P extends SVGProps<SVGImageElement> ? "image" : never | P extends SVGProps<SVGLineElement> ? "line" : never | P extends SVGProps<SVGLinearGradientElement> ? "linearGradient" : never | P extends SVGProps<SVGMarkerElement> ? "marker" : never | P extends SVGProps<SVGMaskElement> ? "mask" : never | P extends SVGProps<SVGMetadataElement> ? "metadata" : never | P extends SVGProps<SVGElement> ? "mpath" : never | P extends SVGProps<SVGPathElement> ? "path" : never | P extends SVGProps<SVGPatternElement> ? "pattern" : never | P extends SVGProps<SVGPolygonElement> ? "polygon" : never | P extends SVGProps<SVGPolylineElement> ? "polyline" : never | P extends SVGProps<SVGRadialGradientElement> ? "radialGradient" : never | P extends SVGProps<SVGRectElement> ? "rect" : never | P extends SVGProps<SVGStopElement> ? "stop" : never | P extends SVGProps<SVGSwitchElement> ? "switch" : never | P extends SVGProps<SVGSymbolElement> ? "symbol" : never | P extends SVGProps<SVGTextElement> ? "text" : never | P extends SVGProps<SVGTextPathElement> ? "textPath" : never | P extends SVGProps<SVGTSpanElement> ? "tspan" : never | P extends SVGProps<SVGUseElement> ? "use" : never | P extends SVGProps<SVGViewElement> ? "view" : never | ComponentType<P>

Type parameters

  • P

EventHandler

EventHandler<E>: bivarianceHack

Type parameters

FC

Type parameters

  • P

Factory

Factory<P>: function

Type parameters

  • P

Type declaration

FocusEventHandler

FocusEventHandler<T>: EventHandler<FocusEvent<T>>

Type parameters

  • T

FormEventHandler

FormEventHandler<T>: EventHandler<FormEvent<T>>

Type parameters

  • T

FunctionComponentFactory

FunctionComponentFactory<P>: function

Type parameters

  • P

Type declaration

GetDerivedStateFromError

GetDerivedStateFromError<P, S>: function

Type parameters

  • P

  • S

Type declaration

    • This lifecycle is invoked after an error has been thrown by a descendant component. It receives the error that was thrown as a parameter and should return a value to update state.

      Note: its presence prevents any of the deprecated lifecycle methods from being invoked

      Parameters

      • error: any

      Returns Partial<S> | null

GetDerivedStateFromProps

GetDerivedStateFromProps<P, S>: function

Type parameters

  • P

  • S

Type declaration

    • Returns an update to a component's state based on its new props and old state.

      Note: its presence prevents any of the deprecated lifecycle methods from being invoked

      Parameters

      Returns Partial<S> | null

JSXElementConstructor

JSXElementConstructor<P>: function | object

Type parameters

  • P

Key

Key: string | number

KeyboardEventHandler

KeyboardEventHandler<T>: EventHandler<KeyboardEvent<T>>

Type parameters

  • T

LazyExoticComponent

LazyExoticComponent<T>: ExoticComponent<ComponentPropsWithRef<T>> & object

Type parameters

LegacyRef

LegacyRef<T>: string | Ref<T>

Type parameters

  • T

MemoExoticComponent

MemoExoticComponent<T>: NamedExoticComponent<ComponentPropsWithRef<T>> & object

Type parameters

MouseEventHandler

MouseEventHandler<T>: EventHandler<MouseEvent<T>>

Type parameters

  • T

PointerEventHandler

PointerEventHandler<T>: EventHandler<PointerEvent<T>>

Type parameters

  • T

ProfilerOnRenderCallback

ProfilerOnRenderCallback: function

Type declaration

    • (id: string, phase: "mount" | "update", actualDuration: number, baseDuration: number, startTime: number, commitTime: number, interactions: Set<SchedulerInteraction>): void
    • Parameters

      • id: string
      • phase: "mount" | "update"
      • actualDuration: number
      • baseDuration: number
      • startTime: number
      • commitTime: number
      • interactions: Set<SchedulerInteraction>

      Returns void

PropsWithChildren

PropsWithChildren<P>: P & object

Type parameters

  • P

PropsWithRef

PropsWithRef<P>: PropsWithRef<P>

Ensures that the props do not include string ref, which cannot be forwarded

Type parameters

  • P

PropsWithoutRef

PropsWithoutRef<P>: PropsWithoutRef<P>

Ensures that the props do not include ref at all

Type parameters

  • P

Provider

Type parameters

  • T

ReactChild

ReactChild: ReactElement | ReactText

ReactEventHandler

ReactEventHandler<T>: EventHandler<SyntheticEvent<T>>

Type parameters

  • T

ReactFragment

ReactFragment: __type | ReactNodeArray

ReactInstance

ReactInstance: Component<any> | Element

ReactNode

ReactNode: ReactChild | ReactFragment | ReactPortal | boolean | null | undefined

ReactText

ReactText: string | number

ReactType

ReactType<P>: ElementType<P>
deprecated

Please use ElementType

Type parameters

  • P

Reducer

Reducer<S, A>: function

Type parameters

  • S

  • A

Type declaration

    • (prevState: S, action: A): S
    • Parameters

      • prevState: S
      • action: A

      Returns S

ReducerAction

ReducerAction<R>: ReducerAction<R>

Type parameters

ReducerState

ReducerState<R>: ReducerState<R>

Type parameters

Ref

Ref<T>: bivarianceHack | RefObject<T> | null

Type parameters

  • T

Requireable

Requireable<T>: Requireable<T>

Type parameters

  • T

SFC

deprecated

as of recent React versions, function components can no longer be considered 'stateless'. Please use FunctionComponent instead.

see

React Hooks

Type parameters

  • P

SFCElement

SFCElement<P>: FunctionComponentElement<P>
deprecated

Please use FunctionComponentElement

Type parameters

  • P

SFCFactory

SFCFactory<P>: FunctionComponentFactory<P>
deprecated

Please use FunctionComponentFactory

Type parameters

  • P

SetStateAction

SetStateAction<S>: S | function

Type parameters

  • S

StatelessComponent

StatelessComponent<P>: FunctionComponent<P>
deprecated

as of recent React versions, function components can no longer be considered 'stateless'. Please use FunctionComponent instead.

see

React Hooks

Type parameters

  • P

TouchEventHandler

TouchEventHandler<T>: EventHandler<TouchEvent<T>>

Type parameters

  • T

TransitionEventHandler

TransitionEventHandler<T>: EventHandler<TransitionEvent<T>>

Type parameters

  • T

UIEventHandler

UIEventHandler<T>: EventHandler<UIEvent<T>>

Type parameters

  • T

ValidationMap

ValidationMap<T>: PropTypes.ValidationMap<T>

Type parameters

  • T

Validator

Validator<T>: Validator<T>

Type parameters

  • T

WeakValidationMap

WeakValidationMap<T>: object

Type parameters

  • T

Type declaration

WheelEventHandler

WheelEventHandler<T>: EventHandler<WheelEvent<T>>

Type parameters

  • T

Variables

Const Children

Children: ReactChildren

Const Fragment

Fragment: ExoticComponent<object>

Const Profiler

Const StrictMode

StrictMode: ExoticComponent<object>

Const Suspense

This feature is not yet available for server-side rendering. Suspense support will be added in a later release.

Const version

version: string

Functions

cloneElement

createContext

  • createContext<T>(defaultValue: T, calculateChangedBits?: undefined | function): Context<T>
  • Type parameters

    • T

    Parameters

    • defaultValue: T
    • Optional calculateChangedBits: undefined | function

    Returns Context<T>

createElement

createFactory

createRef

  • Type parameters

    • T

    Returns RefObject<T>

forwardRef

isValidElement

  • isValidElement<P>(object: __type | null | undefined): object is ReactElement<P>
  • Type parameters

    • P

    Parameters

    • object: __type | null | undefined

    Returns object is ReactElement<P>

lazy

  • Type parameters

    Parameters

    • factory: function
        • (): Promise<object>
        • Returns Promise<object>

    Returns LazyExoticComponent<T>

memo

  • Type parameters

    • P: object

    Parameters

    • Component: SFC<P>
    • Optional propsAreEqual: undefined | function

    Returns NamedExoticComponent<P>

  • Type parameters

    Parameters

    • Component: T
    • Optional propsAreEqual: undefined | function

    Returns MemoExoticComponent<T>

useCallback

useContext

  • useContext<T>(context: Context<T>): T
  • Accepts a context object (the value returned from React.createContext) and returns the current context value, as given by the nearest context provider for the given context.

    version

    16.8.0

    see

    https://reactjs.org/docs/hooks-reference.html#usecontext

    Type parameters

    • T

    Parameters

    Returns T

useDebugValue

  • useDebugValue<T>(value: T, format?: undefined | function): void
  • useDebugValue can be used to display a label for custom hooks in React DevTools.

    NOTE: We don’t recommend adding debug values to every custom hook. It’s most valuable for custom hooks that are part of shared libraries.

    version

    16.8.0

    see

    https://reactjs.org/docs/hooks-reference.html#usedebugvalue

    Type parameters

    • T

    Parameters

    • value: T
    • Optional format: undefined | function

    Returns void

useEffect

useImperativeHandle

  • useImperativeHandle<T, R>(ref: Ref<T> | undefined, init: function, deps?: DependencyList): void
  • useImperativeHandle customizes the instance value that is exposed to parent components when using ref. As always, imperative code using refs should be avoided in most cases.

    useImperativeHandle should be used with React.forwardRef.

    version

    16.8.0

    see

    https://reactjs.org/docs/hooks-reference.html#useimperativehandle

    Type parameters

    • T

    • R: T

    Parameters

    • ref: Ref<T> | undefined
    • init: function
        • (): R
        • Returns R

    • Optional deps: DependencyList

    Returns void

useLayoutEffect

  • The signature is identical to useEffect, but it fires synchronously after all DOM mutations. Use this to read layout from the DOM and synchronously re-render. Updates scheduled inside useLayoutEffect will be flushed synchronously, before the browser has a chance to paint.

    Prefer the standard useEffect when possible to avoid blocking visual updates.

    If you’re migrating code from a class component, useLayoutEffect fires in the same phase as componentDidMount and componentDidUpdate.

    version

    16.8.0

    see

    https://reactjs.org/docs/hooks-reference.html#uselayouteffect

    Parameters

    Returns void

useMemo

  • useMemo will only recompute the memoized value when one of the deps has changed.

    Usage note: if calling useMemo with a referentially stable function, also give it as the input in the second argument.

    function expensive () { ... }
    
    function Component () {
      const expensiveResult = useMemo(expensive, [expensive])
      return ...
    }
    version

    16.8.0

    see

    https://reactjs.org/docs/hooks-reference.html#usememo

    Type parameters

    • T

    Parameters

    Returns T

useReducer

useRef

  • useRef returns a mutable ref object whose .current property is initialized to the passed argument (initialValue). The returned object will persist for the full lifetime of the component.

    Note that useRef() is useful for more than the ref attribute. It’s handy for keeping any mutable value around similar to how you’d use instance fields in classes.

    version

    16.8.0

    see

    https://reactjs.org/docs/hooks-reference.html#useref

    Type parameters

    • T

    Parameters

    • initialValue: T

    Returns MutableRefObject<T>

  • useRef returns a mutable ref object whose .current property is initialized to the passed argument (initialValue). The returned object will persist for the full lifetime of the component.

    Note that useRef() is useful for more than the ref attribute. It’s handy for keeping any mutable value around similar to how you’d use instance fields in classes.

    Usage note: if you need the result of useRef to be directly mutable, include | null in the type of the generic argument.

    version

    16.8.0

    see

    https://reactjs.org/docs/hooks-reference.html#useref

    Type parameters

    • T

    Parameters

    • initialValue: T | null

    Returns RefObject<T>

  • useRef returns a mutable ref object whose .current property is initialized to the passed argument (initialValue). The returned object will persist for the full lifetime of the component.

    Note that useRef() is useful for more than the ref attribute. It’s handy for keeping any mutable value around similar to how you’d use instance fields in classes.

    version

    16.8.0

    see

    https://reactjs.org/docs/hooks-reference.html#useref

    Type parameters

    • T

    Returns MutableRefObject<T | undefined>

useState

Generated using TypeDoc