# Class CopyToClipboard

#### Hierarchy

- Component<Props, State>
  - CopyToClipboard

- Defined in jslib/src/components/CopyToClipboard/CopyToClipboardComponent.tsx:30

##### Index

### Constructors

constructor

### Properties

context
notificationTimeout
props
refs
state
timeoutRef
contextType?

### Methods

componentDidCatch?
componentDidMount?
componentDidUpdate?
componentWillMount?
componentWillReceiveProps?
componentWillUnmount
componentWillUpdate?
doCopy
forceUpdate
getSnapshotBeforeUpdate?
render
setState
shouldComponentUpdate?
UNSAFE_componentWillMount?
UNSAFE_componentWillReceiveProps?
UNSAFE_componentWillUpdate?

## Constructors

### constructor

- new CopyToClipboard(props: Props): CopyToClipboard

  #### Parameters

  - props: Props

  #### Returns CopyToClipboard

  Overrides React.Component<Props, State>.constructor

  - Defined in jslib/src/components/CopyToClipboard/CopyToClipboardComponent.tsx:35

## 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.

#### Example

    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

React Docs

Inherited from React.Component.context

- Defined in node_modules/@types/react/index.d.ts:1014

### notificationTimeout

notificationTimeout: number

- Defined in jslib/src/components/CopyToClipboard/CopyToClipboardComponent.tsx:31

### `Readonly` props

props: Readonly<P>

Inherited from React.Component.props

- Defined in node_modules/@types/react/index.d.ts:1034

### refs

refs: { [key: string]: ReactInstance }

#### Deprecated

#### See

Legacy React Docs

Inherited from React.Component.refs

- Defined in node_modules/@types/react/index.d.ts:1041

### state

state: Readonly<S>

Inherited from React.Component.state

- Defined in node_modules/@types/react/index.d.ts:1035

### timeoutRef

timeoutRef: any

- Defined in jslib/src/components/CopyToClipboard/CopyToClipboardComponent.tsx:33

### `Static` `Optional` contextType

contextType?: Context<any>

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

#### Example

    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 React.Component.contextType

- Defined in node_modules/@types/react/index.d.ts:996

## Methods

### `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

  Inherited from React.Component.componentDidCatch

  - Defined in node_modules/@types/react/index.d.ts:1398

### `Optional` componentDidMount

- componentDidMount?(): void

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

  #### Returns void

  Inherited from React.Component.componentDidMount

  - Defined in node_modules/@types/react/index.d.ts:1377

### `Optional` componentDidUpdate

- componentDidUpdate?(
  prevProps: Readonly<P>,
  prevState: Readonly<S>,
  snapshot?: any,
  ): 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<P>
  - prevState: Readonly<S>
  - `Optional` snapshot: any

  #### Returns void

  Inherited from React.Component.componentDidUpdate

  - Defined in node_modules/@types/react/index.d.ts:1440

### `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 NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

  #### Returns void

  #### Deprecated

  16.3, use ComponentLifecycle.componentDidMount 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

  Inherited from React.Component.componentWillMount

  - Defined in node_modules/@types/react/index.d.ts:1456

### `Optional` componentWillReceiveProps

- componentWillReceiveProps?(nextProps: Readonly<P>, 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 NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

  #### Parameters

  - nextProps: Readonly<P>
  - nextContext: any

  #### Returns void

  #### Deprecated

  16.3, use static StaticLifecycle.getDerivedStateFromProps 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

  Inherited from React.Component.componentWillReceiveProps

  - Defined in node_modules/@types/react/index.d.ts:1487

### 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

  Overrides React.Component.componentWillUnmount

  - Defined in jslib/src/components/CopyToClipboard/CopyToClipboardComponent.tsx:46

### `Optional` componentWillUpdate

- componentWillUpdate?(
  nextProps: Readonly<P>,
  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 NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

  #### Parameters

  - nextProps: Readonly<P>
  - nextState: Readonly<S>
  - nextContext: any

  #### Returns void

  #### 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

  Inherited from React.Component.componentWillUpdate

  - Defined in node_modules/@types/react/index.d.ts:1519

### doCopy

- doCopy(): void

  #### Returns void

  - Defined in jslib/src/components/CopyToClipboard/CopyToClipboardComponent.tsx:50

### forceUpdate

- forceUpdate(callback?: () => void): void

  #### Parameters

  - `Optional` callback: () => void

  #### Returns void

  Inherited from React.Component.forceUpdate

  - Defined in node_modules/@types/react/index.d.ts:1031

### `Optional` getSnapshotBeforeUpdate

- getSnapshotBeforeUpdate?(prevProps: Readonly<P>, prevState: Readonly<S>): any

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

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

  #### Parameters

  - prevProps: Readonly<P>
  - prevState: Readonly<S>

  #### Returns any

  Inherited from React.Component.getSnapshotBeforeUpdate

  - Defined in node_modules/@types/react/index.d.ts:1434

### render

- render(): Element

  #### Returns Element

  Overrides React.Component.render

  - Defined in jslib/src/components/CopyToClipboard/CopyToClipboardComponent.tsx:60

### setState

- setState<K extends "isShowing">(
  state:
  | State
  | ((prevState: Readonly<S>, props: Readonly<P>) => State | Pick<State, K>)
  | Pick<State, K>,
  callback?: () => void,
  ): void

  #### Type Parameters

  - K extends "isShowing"

  #### Parameters

  - state:
    | State
    | ((prevState: Readonly<S>, props: Readonly<P>) => State | Pick<State, K>)
    | Pick<State, K>
  - `Optional` callback: () => void

  #### Returns void

  Inherited from React.Component.setState

  - Defined in node_modules/@types/react/index.d.ts:1026

### `Optional` shouldComponentUpdate

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

  #### Returns boolean

  Inherited from React.Component.shouldComponentUpdate

  - Defined in node_modules/@types/react/index.d.ts:1388

### `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 NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

  #### Returns void

  #### Deprecated

  16.3, use ComponentLifecycle.componentDidMount 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

  Inherited from React.Component.UNSAFE_componentWillMount

  - Defined in node_modules/@types/react/index.d.ts:1471

### `Optional` UNSAFE_componentWillReceiveProps

- UNSAFE_componentWillReceiveProps?(
  nextProps: Readonly<P>,
  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 NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

  #### Parameters

  - nextProps: Readonly<P>
  - nextContext: any

  #### Returns void

  #### Deprecated

  16.3, use static StaticLifecycle.getDerivedStateFromProps 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

  Inherited from React.Component.UNSAFE_componentWillReceiveProps

  - Defined in node_modules/@types/react/index.d.ts:1505

### `Optional` UNSAFE_componentWillUpdate

- UNSAFE_componentWillUpdate?(
  nextProps: Readonly<P>,
  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 NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

  #### Parameters

  - nextProps: Readonly<P>
  - nextState: Readonly<S>
  - nextContext: any

  #### Returns void

  #### 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

  Inherited from React.Component.UNSAFE_componentWillUpdate

  - Defined in node_modules/@types/react/index.d.ts:1535