# Class: default

@makerx/repository-website-generator / pages/_document / default

pages/_document.default

Hierarchy

• default

  ↳ default

Table of contents

Constructors

• constructor

Properties

• context
• props
• refs
• state
• contextType

Methods

• UNSAFE_componentWillMount
• UNSAFE_componentWillReceiveProps
• UNSAFE_componentWillUpdate
• componentDidCatch
• componentDidMount
• componentDidUpdate
• componentWillMount
• componentWillReceiveProps
• componentWillUnmount
• componentWillUpdate
• forceUpdate
• getSnapshotBeforeUpdate
• render
• setState
• shouldComponentUpdate
• getInitialProps

Constructors

constructor

• new default(props)

Parameters

Name	Type
props	RenderPageResult & { styles?: ReactFragment | Element | ReactElement<any, string | JSXElementConstructor<any>>[] } & HtmlProps | Readonly<RenderPageResult & { styles?: ReactFragment | Element | ReactElement<any, string | JSXElementConstructor<any>>[] } & HtmlProps>

Inherited from

Document.constructor

Defined in

node_modules/@types/react/ts5.0/index.d.ts:451

• new default(props, context)

Deprecated

See

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

Parameters

Name	Type
props	RenderPageResult & { styles?: ReactFragment | Element | ReactElement<any, string | JSXElementConstructor<any>>[] } & HtmlProps
context	any

Inherited from

Document.constructor

Defined in

node_modules/@types/react/ts5.0/index.d.ts:456

Properties

context

• context: unknown

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>

See

https://react.dev/reference/react/Component#context

Inherited from

Document.context

Defined in

node_modules/@types/react/ts5.0/index.d.ts:449

---

props

• Readonly props: Readonly<RenderPageResult & { styles?: ReactFragment | Element | ReactElement<any, string | JSXElementConstructor<any>>[] } & HtmlProps>

Inherited from

Document.props

Defined in

node_modules/@types/react/ts5.0/index.d.ts:469

---

refs

• refs: Object

Deprecated

https://legacy.reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Index signature

▪ [key: string]: ReactInstance

Inherited from

Document.refs

Defined in

node_modules/@types/react/ts5.0/index.d.ts:475

---

state

• state: Readonly<{}>

Inherited from

Document.state

Defined in

node_modules/@types/react/ts5.0/index.d.ts:470

---

contextType

▪ Static Optional 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://react.dev/reference/react/Component#static-contexttype

Inherited from

Document.contextType

Defined in

node_modules/@types/react/ts5.0/index.d.ts:432

Methods

UNSAFE_componentWillMount

▸ Optional 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.

Deprecated

16.3, use componentDidMount or the constructor instead

See

• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns

void

Inherited from

Document.UNSAFE_componentWillMount

Defined in

node_modules/@types/react/ts5.0/index.d.ts:666

---

UNSAFE_componentWillReceiveProps

▸ Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): 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.

Deprecated

16.3, use static getDerivedStateFromProps instead

See

• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters

Name	Type
nextProps	Readonly<RenderPageResult & { styles?: ReactFragment | Element | ReactElement<any, string | JSXElementConstructor<any>>[] } & HtmlProps>
nextContext	any

Returns

void

Inherited from

Document.UNSAFE_componentWillReceiveProps

Defined in

node_modules/@types/react/ts5.0/index.d.ts:698

---

UNSAFE_componentWillUpdate

▸ Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): 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.

Deprecated

16.3, use getSnapshotBeforeUpdate instead

See

• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters

Name	Type
nextProps	Readonly<RenderPageResult & { styles?: ReactFragment | Element | ReactElement<any, string | JSXElementConstructor<any>>[] } & HtmlProps>
nextState	Readonly<{}>
nextContext	any

Returns

void

Inherited from

Document.UNSAFE_componentWillUpdate

Defined in

node_modules/@types/react/ts5.0/index.d.ts:726

---

componentDidCatch

▸ Optional componentDidCatch(error, errorInfo): void

Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

Parameters

Name	Type
error	Error
errorInfo	ErrorInfo

Returns

void

Inherited from

Document.componentDidCatch

Defined in

node_modules/@types/react/ts5.0/index.d.ts:595

---

componentDidMount

▸ Optional componentDidMount(): void

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

Returns

void

Inherited from

Document.componentDidMount

Defined in

node_modules/@types/react/ts5.0/index.d.ts:574

---

componentDidUpdate

▸ Optional componentDidUpdate(prevProps, prevState, snapshot?): 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

Name	Type
prevProps	Readonly<RenderPageResult & { styles?: ReactFragment | Element | ReactElement<any, string | JSXElementConstructor<any>>[] } & HtmlProps>
prevState	Readonly<{}>
snapshot?	any

Returns

void

Inherited from

Document.componentDidUpdate

Defined in

node_modules/@types/react/ts5.0/index.d.ts:637

---

componentWillMount

▸ Optional 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.

Deprecated

16.3, use componentDidMount or the constructor instead; will stop working in React 17

See

• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns

void

Inherited from

Document.componentWillMount

Defined in

node_modules/@types/react/ts5.0/index.d.ts:652

---

componentWillReceiveProps

▸ Optional componentWillReceiveProps(nextProps, nextContext): 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.

Deprecated

16.3, use static getDerivedStateFromProps instead; will stop working in React 17

See

• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters

Name	Type
nextProps	Readonly<RenderPageResult & { styles?: ReactFragment | Element | ReactElement<any, string | JSXElementConstructor<any>>[] } & HtmlProps>
nextContext	any

Returns

void

Inherited from

Document.componentWillReceiveProps

Defined in

node_modules/@types/react/ts5.0/index.d.ts:681

---

componentWillUnmount

▸ Optional 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

Inherited from

Document.componentWillUnmount

Defined in

node_modules/@types/react/ts5.0/index.d.ts:590

---

componentWillUpdate

▸ Optional componentWillUpdate(nextProps, nextState, nextContext): 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.

Deprecated

16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

See

• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
• https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters

Name	Type
nextProps	Readonly<RenderPageResult & { styles?: ReactFragment | Element | ReactElement<any, string | JSXElementConstructor<any>>[] } & HtmlProps>
nextState	Readonly<{}>
nextContext	any

Returns

void

Inherited from

Document.componentWillUpdate

Defined in

node_modules/@types/react/ts5.0/index.d.ts:711

---

forceUpdate

▸ forceUpdate(callback?): void

Parameters

Name	Type
callback?	() => void

Returns

void

Inherited from

Document.forceUpdate

Defined in

node_modules/@types/react/ts5.0/index.d.ts:466

---

getSnapshotBeforeUpdate

▸ Optional getSnapshotBeforeUpdate(prevProps, prevState): any

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

Name	Type
prevProps	Readonly<RenderPageResult & { styles?: ReactFragment | Element | ReactElement<any, string | JSXElementConstructor<any>>[] } & HtmlProps>
prevState	Readonly<{}>

Returns

any

Inherited from

Document.getSnapshotBeforeUpdate

Defined in

node_modules/@types/react/ts5.0/index.d.ts:631

---

render

▸ render(): Element

Returns

Element

Overrides

Document.render

Defined in

pages/_document.tsx:5

---

setState

▸ setState<K>(state, callback?): void

Type parameters

Name	Type
K	extends never

Parameters

Name	Type
state	null | {} | (prevState: Readonly<{}>, props: Readonly<RenderPageResult & { styles?: ReactFragment | Element | ReactElement<any, string | JSXElementConstructor<any>>[] } & HtmlProps>) => null | {} | Pick<{}, K> | Pick<{}, K>
callback?	() => void

Returns

void

Inherited from

Document.setState

Defined in

node_modules/@types/react/ts5.0/index.d.ts:461

---

shouldComponentUpdate

▸ Optional shouldComponentUpdate(nextProps, nextState, nextContext): 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

Name	Type
nextProps	Readonly<RenderPageResult & { styles?: ReactFragment | Element | ReactElement<any, string | JSXElementConstructor<any>>[] } & HtmlProps>
nextState	Readonly<{}>
nextContext	any

Returns

boolean

Inherited from

Document.shouldComponentUpdate

Defined in

node_modules/@types/react/ts5.0/index.d.ts:585

---

getInitialProps

▸ Static getInitialProps(ctx): Promise<DocumentInitialProps>

getInitialProps hook returns the context object with the addition of renderPage. renderPage callback executes React rendering logic synchronously to support server-rendering wrappers

Parameters

Name	Type
ctx	DocumentContext

Returns

Promise<DocumentInitialProps>

Inherited from

Document.getInitialProps

Defined in

node_modules/next/dist/pages/_document.d.ts:53