Class ReactWidget Abstract

Hierarchy

BaseWidget
- ReactWidget

Constructors

constructor

new ReactWidget(options?: IOptions): ReactWidget

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

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: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>): void

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

Protected addEventListener

addEventListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>, useCapture?: boolean): void

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

Protected addKeyListener

addKeyListener<K>(element: HTMLElement, keysOrKeyCodes: KeyCode.Predicate | KeysOrKeyCodes, action: ((event: KeyboardEvent) => boolean | void | Object), ...additionalEventTypes: K[]): void

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

Protected addUpdateListener

addUpdateListener<K>(element: HTMLElement, type: K, useCapture?: boolean): void

Inherited from BaseWidget.addUpdateListener
- Defined in packages/core/src/browser/widgets/widget.ts:197
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- element: HTMLElement
- type: K
- Optional useCapture: boolean
Returns void

clearFlag

clearFlag(flag: Flag): void

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

Protected disableScrollBarFocus

disableScrollBarFocus(scrollContainer: HTMLElement): void

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

dispose

dispose(): void

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

Protected getScrollContainer

getScrollContainer(): MaybePromise<HTMLElement>

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

Protected onAfterAttach

onAfterAttach(msg: Message): void

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

Protected onAfterDetach

onAfterDetach(msg: Message): void

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

Protected onBeforeAttach

onBeforeAttach(msg: Message): void

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

Protected onBeforeDetach

onBeforeDetach(msg: Message): void

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

Protected onCloseRequest

onCloseRequest(msg: Message): void

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

Protected onUpdateRequest

onUpdateRequest(msg: Message): void

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

Protected Abstract render

render(): ReactNode

- Defined in packages/core/src/browser/widgets/react-widget.tsx:50
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

setFlag

setFlag(flag: Flag): void

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