All files / roosterjs-content-model-api/lib/publicApi/image setImageAltText.ts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
1x
 
 
 
 
 
 
 
 
1x
5x
 
5x
3x
 
 
 
import { formatImageWithContentModel } from '../utils/formatImageWithContentModel';
import type { ContentModelImage, IEditor } from 'roosterjs-content-model-types';
 
/**
 * Set image alt text for all selected images at selection. If no images is contained
 * in selection, do nothing.
 * @param editor The editor instance
 * @param altText The image alt text
 */
export function setImageAltText(editor: IEditor, altText: string) {
    editor.focus();
 
    formatImageWithContentModel(editor, 'setImageAltText', (image: ContentModelImage) => {
        image.alt = altText;
    });
}