Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TypeWriter<SS>

Type parameters

  • SS

Hierarchy

Index

Constructors

constructor

Properties

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

props

props: Readonly<object> & Readonly<TypeWriterProps>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

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<TypeWriterProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

_resetState

  • _resetState(): 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
  • Returns void

Optional componentDidUpdate

  • 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

    Returns void

Optional componentWillMount

  • componentWillMount(): void

componentWillReceiveProps

  • componentWillReceiveProps(nextProps: any, nextContext: any): void
  • Parameters

    • nextProps: any
    • nextContext: any

    Returns void

componentWillUnmount

  • componentWillUnmount(): void
  • Returns void

Optional componentWillUpdate

forceUpdate

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

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

    Returns void

getDisplayString

  • getDisplayString(string: string, upTo: number): string

getNextTimeDelay

  • getNextTimeDelay(): number

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

render

  • render(): string

renderCharacter

  • renderCharacter(): void

renderString

  • renderString(): void

setState

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

    • K: keyof TypeWriterState

    Parameters

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

    Returns void

shouldComponentUpdate

Object literals

Static defaultProps

defaultProps: object

preserve

preserve: false = false

string

string: string = ""

timePerCharacter

timePerCharacter: number = 65

variance

variance: number = 25

Generated using TypeDoc