块编辑器开发文档

WithSpokenMessages

💡 云策文档标注

概述

withSpokenMessages 是一个高阶组件(HOC),用于为 WordPress 组件添加语音消息功能,通过 speak 和 debouncedSpeak 函数实现即时或延迟的语音输出。

关键要点

  • withSpokenMessages 是一个高阶组件,用于包装 React 组件以提供语音消息功能。
  • 它向包装组件注入 speak 和 debouncedSpeak 两个函数,分别用于立即和延迟触发语音消息。
  • 适用于需要无障碍访问或用户反馈的场景,如按钮点击时提供语音提示。

代码示例

import { withSpokenMessages, Button } from '@wordpress/components';

const MyComponentWithSpokenMessages = withSpokenMessages(
    ( { speak, debouncedSpeak } ) => (
        <div>
            <Button
                variant="secondary"
                onClick={ () => speak( 'Spoken message' ) }
            >
                Speak
            </Button>
            <Button
                variant="secondary"
                onClick={ () => debouncedSpeak( 'Delayed message' ) }
            >
                Debounced Speak
            </Button>
        </div>
    )
);

📄 原文内容

Usage

import { withSpokenMessages, Button } from '@wordpress/components';

const MyComponentWithSpokenMessages = withSpokenMessages(
    ( { speak, debouncedSpeak } ) => (
        <div>
            <Button
                variant="secondary"
                onClick={ () => speak( 'Spoken message' ) }
            >
                Speak
            </Button>
            <Button
                variant="secondary"
                onClick={ () => debouncedSpeak( 'Delayed message' ) }
            >
                Debounced Speak
            </Button>
        </div>
    )
);