BaseWebQuickView class

Package:

@microsoft/sp-adaptive-card-extension-base

Base class for a Web Quick view.

Extends

BaseQuickView<TProperties, TState>

Properties

domElement

Reference to the DOM element that hosts this quick view.

Methods

dispose()	Disposes the quick view.
render()	This API is called to render the HTML quick view. It will be invoked when opening this view.
setState(newState)	Update the state of the Adaptive Card Extension.

Property Details

domElement

Reference to the DOM element that hosts this quick view.

protected get domElement(): HTMLDivElement;

Property Value

HTMLDivElement

Remarks

• DOM element will be undefined in the constructor and after the quick view is disposed.

Method Details

dispose()

Disposes the quick view.

/** @virtual */
dispose(): void;

Returns

void

Remarks

• This method is invoked when HTML Quick View's DOM element is removed from the Document. It will trigger when quick view modal is closed, or navigating between quick views.

render()

This API is called to render the HTML quick view. It will be invoked when opening this view.

/** @virtual */
abstract render(): void;

Returns

void

setState(newState)

Update the state of the Adaptive Card Extension.

setState(newState?: Partial<TState> | undefined): void;

Parameters

newState

Partial<TState> | undefined

The new state to set.

Returns

void

Remarks

• This method will not trigger a re-render and only update the ACE with the new state.