Class ReactWidget`Abstract`

Hierarchy (view full)

BaseWidget
- ReactWidget

Constructors

constructor

new ReactWidget(options?): ReactWidget
Parameters
- Optional options: IOptions
Returns ReactWidget
Overrides BaseWidget.constructor
- Defined in packages/core/src/browser/widgets/react-widget.tsx:29

Properties

`Protected` nodeRoot

nodeRoot: Root

`Readonly` onDidChangeVisibility

onDidChangeVisibility: Event<boolean> = ...

`Protected` `Readonly` onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean> = ...

`Readonly` onDidDispose

onDidDispose: Event<void> = ...

`Protected` `Readonly` onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void> = ...

`Readonly` onScrollUp

onScrollUp: Event<void> = ...

`Protected` `Readonly` onScrollUpEmitter

onScrollUpEmitter: Emitter<void> = ...

`Readonly` onScrollYReachEnd

onScrollYReachEnd: Event<void> = ...

`Protected` `Readonly` onScrollYReachEndEmitter

onScrollYReachEndEmitter: Emitter<void> = ...

`Protected` `Optional` scrollBar

scrollBar?: PerfectScrollbar

`Protected` `Optional` scrollOptions

scrollOptions?: Options

`Protected` `Readonly` toDispose

toDispose: DisposableCollection = ...

`Protected` `Readonly` toDisposeOnDetach

toDisposeOnDetach: DisposableCollection = ...

Methods

`Protected` addClipboardListener

addClipboardListener<K>(element, type, listener): void
Type Parameters
- K extends "copy" | "cut" | "paste"
Parameters
- element: HTMLElement
- type: K
- listener: EventListenerOrEventListenerObject<K>
Returns void
Inherited from BaseWidget.addClipboardListener
- Defined in packages/core/src/browser/widgets/widget.ts:217

`Protected` addEventListener

addEventListener<K>(element, type, listener, useCapture?): void
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- type: K
- listener: EventListenerOrEventListenerObject<K>
- Optional useCapture: boolean
Returns void
Inherited from BaseWidget.addEventListener
- Defined in packages/core/src/browser/widgets/widget.ts:206

`Protected` addKeyListener

addKeyListener<K>(element, keysOrKeyCodes, action, ...additionalEventTypes): void
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- keysOrKeyCodes: KeysOrKeyCodes | core.Predicate
- action: ((event) => boolean | void | Object)
  - - (event): boolean | void | Object
    - Parameters
      event: KeyboardEvent
      Returns boolean | void | Object
- Rest ...additionalEventTypes: K[]
Returns void
Inherited from BaseWidget.addKeyListener
- Defined in packages/core/src/browser/widgets/widget.ts:210

`Protected` addUpdateListener

addUpdateListener<K>(element, type, useCapture?): void
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- type: K
- Optional useCapture: boolean
Returns void
Inherited from BaseWidget.addUpdateListener
- Defined in packages/core/src/browser/widgets/widget.ts:199

clearFlag

clearFlag(flag): void
Parameters
- flag: Flag
Returns void
Inherited from BaseWidget.clearFlag
- Defined in packages/core/src/browser/widgets/widget.ts:232

`Protected` disableScrollBarFocus

disableScrollBarFocus(scrollContainer): void
Parameters
- scrollContainer: HTMLElement
Returns void
Inherited from BaseWidget.disableScrollBarFocus
- Defined in packages/core/src/browser/widgets/widget.ts:181

dispose

dispose(): void
Returns void
Inherited from BaseWidget.dispose
- Defined in packages/core/src/browser/widgets/widget.ts:124

getPreviewNode

getPreviewNode(): undefined | Node
Returns undefined | Node
Inherited from BaseWidget.getPreviewNode
- Defined in packages/core/src/browser/widgets/widget.ts:221

`Protected` getScrollContainer

getScrollContainer(): MaybePromise<HTMLElement>
Returns MaybePromise<HTMLElement>
Inherited from BaseWidget.getScrollContainer
- Defined in packages/core/src/browser/widgets/widget.ts:177

`Protected` onAfterAttach

onAfterAttach(msg): void
Parameters
- msg: Message
Returns void
Inherited from BaseWidget.onAfterAttach
- Defined in packages/core/src/browser/widgets/widget.ts:156

`Protected` onAfterDetach

onAfterDetach(msg): void
Parameters
- msg: Message
Returns void
Inherited from BaseWidget.onAfterDetach
- Defined in packages/core/src/browser/widgets/widget.ts:144

`Protected` onBeforeAttach

onBeforeAttach(msg): void
Parameters
- msg: Message
Returns void
Inherited from BaseWidget.onBeforeAttach
- Defined in packages/core/src/browser/widgets/widget.ts:137

`Protected` onBeforeDetach

onBeforeDetach(msg): void
Parameters
- msg: Message
Returns void
Inherited from BaseWidget.onBeforeDetach
- Defined in packages/core/src/browser/widgets/widget.ts:151

`Protected` onCloseRequest

onCloseRequest(msg): void
Parameters
- msg: Message
Returns void
Inherited from BaseWidget.onCloseRequest
- Defined in packages/core/src/browser/widgets/widget.ts:132

`Protected` onUpdateRequest

onUpdateRequest(msg): void
Parameters
- msg: Message
Returns void
Overrides BaseWidget.onUpdateRequest
- Defined in packages/core/src/browser/widgets/react-widget.tsx:39

`Protected` `Abstract` render

render(): ReactNode
Render the React widget in the DOM.
- If the widget has been previously rendered, any subsequent calls will perform an update and only change the DOM if absolutely necessary.
Returns ReactNode
- Defined in packages/core/src/browser/widgets/react-widget.tsx:52

setFlag

setFlag(flag): void
Parameters
- flag: Flag
Returns void
Inherited from BaseWidget.setFlag
- Defined in packages/core/src/browser/widgets/widget.ts:225