Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Affix<SS>

Type parameters

  • SS

Hierarchy

Index

Constructors

constructor

Properties

affix

affix: boolean = false

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType.

static contextType = MyContext
context!: React.ContextType<typeof MyContext>
deprecated

if used without a type annotation, or without static contextType

see

https://reactjs.org/docs/legacy-context.html

handleResize

handleResize: (Anonymous function) & ICancelable = throttle(() => {this.updatePin();this.setWidth();}, 20)

handleScroll

handleScroll: (Anonymous function) & ICancelable = throttle(() => {this.updatePin();}, 20)

props

props: Readonly<IAffixProps> & Readonly<object>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

Static Optional contextType

contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<IAffixProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IAffixProps>, nextState: Readonly<IAffixState>, nextContext: any): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void

componentDidUpdate

  • componentDidUpdate(): void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<IAffixProps>, nextContext: any): void

componentWillUnmount

  • componentWillUnmount(): void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<IAffixProps>, nextState: Readonly<IAffixState>, nextContext: any): void

forceUpdate

  • forceUpdate(callBack?: function): void
  • Parameters

    • Optional callBack: function
        • (): void
        • Returns void

    Returns void

Optional getSnapshotBeforeUpdate

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

getStyleObj

  • getStyleObj(): CSSProperties

pin

  • pin(): void

render

  • render(): Element

setState

  • setState<K>(state: function | S | object, callback?: function): void
  • Type parameters

    • K: keyof IAffixState

    Parameters

    • state: function | S | object
    • Optional callback: function
        • (): void
        • Returns void

    Returns void

setWidth

  • setWidth(): void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<IAffixProps>, nextState: Readonly<IAffixState>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    Returns boolean

unpin

  • unpin(): void

updatePin

  • updatePin(): void

Object literals

state

state: object

placeHoldStyle

placeHoldStyle: object

Type declaration

position

position: "static" = "static"

width

width: undefined = undefined

Static defaultProps

defaultProps: object

offsetTop

offsetTop: number = 0

prefix

prefix: string = "zent"

zIndex

zIndex: number = 10

Generated using TypeDoc