Interface FixedPositioningHookReturnValue<E>

remarks: @since 4.0.0

Type parameters

E: HTMLElement

An HTMLElement type for the fixed element.

Hierarchy

FixedPositioningHookReturnValue

Index

Properties

Methods

updateStyle

Properties

callbacks

callbacks: Readonly<Required<FixedPositioningTransitionCallbacks>>

This should really only be used if the transitionOptions is not being used.

ref

ref: (instance: null | E) => void

Type declaration

- (instance: null | E): void
- A ref that should be passed to a component for the fixed positioning behavior to work correctly.
  
  This should really only be used if the transitionOptions is not being used.
  
  Parameters
  - instance: null | E
  Returns void

style

style: CSSProperties

see: FixedPositionStyle

transitionOptions

transitionOptions: Readonly<Required<FixedPositioningTransitionOptions<E>>>

{@inheritDoc FixedPositioningTransitionOptions}

Methods

updateStyle

updateStyle(): void

- Defined in packages/transition/src/useFixedPositioning.ts:87
A function that can be called to update the style for the fixed element.

Returns void

Generated using TypeDoc