kui_shell_plugin_electron_components.Screenshot.md

Kui API Documentation - v11.0.0 / @kui-shell/plugin-electron-components / Screenshot

Class: Screenshot

@kui-shell/plugin-electron-components.Screenshot

Hierarchy

• PureComponent<Props, State>

  ↳ Screenshot

Table of contents

Constructors

• constructor

Properties

• _onClose
• cleaners
• context
• overlayCleaner
• props
• refs
• renderOverlayTransparent
• state
• toggleOverlayTransparency
• contextType

Methods

• UNSAFE_componentWillMount
• UNSAFE_componentWillReceiveProps
• UNSAFE_componentWillUpdate
• captureRegion
• closeNotification
• componentDidCatch
• componentDidMount
• componentDidUpdate
• componentWillMount
• componentWillReceiveProps
• componentWillUnmount
• componentWillUpdate
• deactivate
• forceUpdate
• getSnapshotBeforeUpdate
• notification
• onClickScreenshotRegion
• render
• saveToDisk
• saveToDiskButton
• setState
• shouldComponentUpdate

Constructors

constructor

• new Screenshot(props)

Parameters

Name	Type
props	Props

Overrides

React.PureComponent<Props, State&gt;.constructor

Defined in

plugins/plugin-electron-components/src/components/Screenshot.tsx:56

Properties

_onClose

• Private Readonly _onClose: any

Defined in

plugins/plugin-electron-components/src/components/Screenshot.tsx:186

---

cleaners

• Private cleaners: () => void[] = []

Defined in

plugins/plugin-electron-components/src/components/Screenshot.tsx:50

---

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>

see https://reactjs.org/docs/context.html

Inherited from

React.PureComponent.context

Defined in

node_modules/@types/react/index.d.ts:479

---

overlayCleaner

• Private overlayCleaner: () => void

Type declaration

▸ (): void

Returns

void

Defined in

plugins/plugin-electron-components/src/components/Screenshot.tsx:49

---

props

• Readonly props: Readonly<Props> & Readonly<{ children?: ReactNode }>

Inherited from

React.PureComponent.props

Defined in

node_modules/@types/react/index.d.ts:504

---

refs

• refs: Object

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

Index signature

▪ [key: string]: ReactInstance

Inherited from

React.PureComponent.refs

Defined in

node_modules/@types/react/index.d.ts:510

---

renderOverlayTransparent

• Private renderOverlayTransparent: boolean = false

see #4170

Defined in

plugins/plugin-electron-components/src/components/Screenshot.tsx:53

---

state

• state: Readonly<State>

Inherited from

React.PureComponent.state

Defined in

node_modules/@types/react/index.d.ts:505

---

toggleOverlayTransparency

• Private toggleOverlayTransparency: () => void

Type declaration

▸ (): void

Returns

void

Defined in

plugins/plugin-electron-components/src/components/Screenshot.tsx:54

---

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://reactjs.org/docs/context.html#classcontexttype

Inherited from

React.PureComponent.contextType

Defined in

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

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://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

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

Returns

void

Inherited from

React.PureComponent.UNSAFE_componentWillMount

Defined in

node_modules/@types/react/index.d.ts:717

---

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://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

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

Parameters

Name	Type
nextProps	Readonly<Props>
nextContext	any

Returns

void

Inherited from

React.PureComponent.UNSAFE_componentWillReceiveProps

Defined in

node_modules/@types/react/index.d.ts:749

---

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://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

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

Parameters

Name	Type
nextProps	Readonly<Props>
nextState	Readonly<State>
nextContext	any

Returns

void

Inherited from

React.PureComponent.UNSAFE_componentWillUpdate

Defined in

node_modules/@types/react/index.d.ts:777

---

captureRegion

▸ Private captureRegion(element): Promise<void>

This is the actual work to screenshot a given region of the screen defined by the extent of the given dom.

Parameters

Name	Type
element	Element

Returns

Promise<void>

Defined in

plugins/plugin-electron-components/src/components/Screenshot.tsx:102

---

closeNotification

▸ Private closeNotification(): void

Returns

void

Defined in

plugins/plugin-electron-components/src/components/Screenshot.tsx:182

---

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

React.PureComponent.componentDidCatch

Defined in

node_modules/@types/react/index.d.ts:646

---

componentDidMount

▸ Optional componentDidMount(): void

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

Returns

void

Inherited from

React.PureComponent.componentDidMount

Defined in

node_modules/@types/react/index.d.ts:625

---

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<Props>
prevState	Readonly<State>
snapshot?	any

Returns

void

Inherited from

React.PureComponent.componentDidUpdate

Defined in

node_modules/@types/react/index.d.ts:688

---

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://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

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

Returns

void

Inherited from

React.PureComponent.componentWillMount

Defined in

node_modules/@types/react/index.d.ts:703

---

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://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

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

Parameters

Name	Type
nextProps	Readonly<Props>
nextContext	any

Returns

void

Inherited from

React.PureComponent.componentWillReceiveProps

Defined in

node_modules/@types/react/index.d.ts:732

---

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

React.PureComponent.componentWillUnmount

Defined in

node_modules/@types/react/index.d.ts:641

---

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://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

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

Parameters

Name	Type
nextProps	Readonly<Props>
nextState	Readonly<State>
nextContext	any

Returns

void

Inherited from

React.PureComponent.componentWillUpdate

Defined in

node_modules/@types/react/index.d.ts:762

---

deactivate

▸ Private deactivate(): void

Transition back to a normal state, where are aren't ready to capture a screenshot

Returns

void

Defined in

plugins/plugin-electron-components/src/components/Screenshot.tsx:69

---

forceUpdate

▸ forceUpdate(callback?): void

Parameters

Name	Type
callback?	() => void

Returns

void

Inherited from

React.PureComponent.forceUpdate

Defined in

node_modules/@types/react/index.d.ts:496

---

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<Props>
prevState	Readonly<State>

Returns

any

Inherited from

React.PureComponent.getSnapshotBeforeUpdate

Defined in

node_modules/@types/react/index.d.ts:682

---

notification

▸ Private notification(): Element

Render an Alert to tell the user what we captured

Returns

Element

Defined in

plugins/plugin-electron-components/src/components/Screenshot.tsx:189

---

onClickScreenshotRegion

▸ Private onClickScreenshotRegion(element): void

User has clicked on a region to be captured

Parameters

Name	Type
element	Element

Returns

void

Defined in

plugins/plugin-electron-components/src/components/Screenshot.tsx:82

---

render

▸ render(): Element

Returns

Element

Overrides

React.PureComponent.render

Defined in

plugins/plugin-electron-components/src/components/Screenshot.tsx:209

---

saveToDisk

▸ Private saveToDisk(): Promise<void>

User has clicked on the Save to Desktop button

Returns

Promise<void>

Defined in

plugins/plugin-electron-components/src/components/Screenshot.tsx:148

---

saveToDiskButton

▸ Private saveToDiskButton(): Element

Inside of the ToastNotification, render a Save to Desktop button

Returns

Element

Defined in

plugins/plugin-electron-components/src/components/Screenshot.tsx:169

---

setState

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

Type parameters

Name	Type
K	extends keyof State

Parameters

Name	Type
state	State | (prevState: Readonly<State>, props: Readonly<Props>) => State | Pick<State, K> | Pick<State, K>
callback?	() => void

Returns

void

Inherited from

React.PureComponent.setState

Defined in

node_modules/@types/react/index.d.ts:491

---

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<Props>
nextState	Readonly<State>
nextContext	any

Returns

boolean

Inherited from

React.PureComponent.shouldComponentUpdate

Defined in

node_modules/@types/react/index.d.ts:636