Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • S
  • SS
  • S

Hierarchy

Constructors

constructor

Parameters

Returns CodeBlock

Parameters

Returns CodeBlock

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. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>

Readonly props

props: Readonly<CodeBlockProps> & Readonly<object>

refs

refs: object

state

state: Readonly<S>

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}</>;
  }
}

Accessors

modules

  • get modules(): any

Returns any

Static AllPreviews

  • get AllPreviews(): any

Returns any

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

Returns void

Optional UNSAFE_componentWillReceiveProps

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

Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component#setState generally does not trigger this method.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

Parameters

Returns void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<CodeBlockProps>, nextState: Readonly<S>, nextContext: any): void

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component#setState here.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

Parameters

  • nextProps: Readonly<CodeBlockProps>
  • nextState: Readonly<S>
  • nextContext: any

Returns 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<CodeBlockProps>, 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<CodeBlockProps>
  • prevState: Readonly<S>
  • snapshot: SS Optional

Returns void

Optional componentWillMount

  • componentWillMount(): void

Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

Returns void

Optional componentWillReceiveProps

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

Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component#setState generally does not trigger this method.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

Parameters

Returns 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<CodeBlockProps>, nextState: Readonly<S>, nextContext: any): void

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component#setState here.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

Parameters

  • nextProps: Readonly<CodeBlockProps>
  • nextState: Readonly<S>
  • nextContext: any

Returns void

forceUpdate

  • forceUpdate(callback?: function): void

Parameters

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

Returns void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<CodeBlockProps>, 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

Returns SS | null

render

  • render(): Element

Returns Element

setState

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

Type parameters

  • K: keyof S

Parameters

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

Returns void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<CodeBlockProps>, 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<CodeBlockProps>
  • nextState: Readonly<S>
  • nextContext: any

Returns boolean

Object literals

Static defaultProps

defaultProps: object

content

content: string = ""

language

language: string = "plaintext"
  • Inherited
  • Protected
  • Private
  • Static
  • Module
  • Object
  • Property
  • Function
  • Variable
  • Index
  • Type
  • Class
  • Interface
  • Enum
  • Constructor
  • Getter/Setter
Made with ❤️ by pirix-gh. Documentation generated by TypeDoc.