Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Bubble<T, S, SS>

A pre-canned message bubble. Can be used in the onRenderMessage callback on {@link List}

Type parameters

  • T

  • S

  • SS

Hierarchy

  • PureComponent<IProps<T>>
    • Bubble

Index

Accessors

fadeDelay

  • get fadeDelay(): number

fadeDuration

  • get fadeDuration(): number

fadeEasing

  • get fadeEasing(): EasingFunction | undefined

them

  • get them(): boolean

us

  • get us(): boolean

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

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

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IProps<T>>, nextState: Readonly<S>, 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

Optional componentDidMount

  • componentDidMount(): void
  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<IProps<T>>, prevState: Readonly<S>, snapshot?: SS): void
  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<IProps<T>>
    • prevState: Readonly<S>
    • Optional snapshot: SS

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

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

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<IProps<T>>, nextState: Readonly<S>, nextContext: any): void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<IProps<T>>, prevState: Readonly<S>): SS | null
  • 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

    • prevProps: Readonly<IProps<T>>
    • prevState: Readonly<S>

    Returns SS | null

render

  • render(): React.ReactNode

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<IProps<T>>, nextState: Readonly<S>, 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

    • nextProps: Readonly<IProps<T>>
    • nextState: Readonly<S>
    • nextContext: any

    Returns boolean

Static renderContentArguments

  • renderContentArguments<T>(props: Pick<IProps<T>, "theme" | "user" | "message">): [T, TextStyle, boolean, ITheme | undefined]
  • Determines the arguments that are used to render the content

    Type parameters

    • T

    Parameters

    • props: Pick<IProps<T>, "theme" | "user" | "message">

      the necessary properties to determine the arguments

    Returns [T, TextStyle, boolean, ITheme | undefined]

    the arguments that can be passed to a onRenderContent function

Static them

  • them<T>(props: Pick<IProps<T>, "user" | "message">): boolean
  • Determines if the message is from any other user

    Type parameters

    • T

    Parameters

    • props: Pick<IProps<T>, "user" | "message">

      the necessary properties to determine the ownership

    Returns boolean

Static us

  • us<T>(props: Pick<IProps<T>, "user" | "message">): boolean
  • Determines if the message is from the user specified

    Type parameters

    • T

    Parameters

    • props: Pick<IProps<T>, "user" | "message">

      the necessary properties to determine the ownership

    Returns boolean