IFocusParameters interface

Package:

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

Interface to give third party developers the capability to determine which element should recieve focus, when, and how often content should be read.

Remarks

focusTarget is ignored for the initial opening of the quick view. Any subsequent quick view changes will utilize focusTarget.

Properties

ariaLive	Sets the accessibility reading of the contents within the focus target. Polite - Content in the target's subtree is read when the user is idle. Assertive - Disrupts any announcement in favor of the changed contents within the target's subtree. Off - The screen reader will not read contents within the target's subtree.
focusTarget	Sets the default focus on the DOM. Developers pass in the id of a unique element that is to attain focus within a quick view. If the focusTarget is not defined then the root element is selected.

Property Details

ariaLive

Sets the accessibility reading of the contents within the focus target. Polite - Content in the target's subtree is read when the user is idle. Assertive - Disrupts any announcement in favor of the changed contents within the target's subtree. Off - The screen reader will not read contents within the target's subtree.

ariaLive?: 'polite' | 'assertive' | 'off';

Property Value

'polite' | 'assertive' | 'off'

focusTarget

Sets the default focus on the DOM. Developers pass in the id of a unique element that is to attain focus within a quick view. If the focusTarget is not defined then the root element is selected.

focusTarget: string | undefined;

Property Value

string | undefined