文档
单词

Word<T extends string | DynamicWord | Pausing = string | DynamicWord | Pausing>

⚠️

此页面正在建设中

Word 是句子的一部分。它用于为文本添加样式。

构建一个红色的单词:

import { Word } from 'narraleaf-react';
 
const word = new Word("Hello", {color: "#f00"});

构建一个带有注音的单词:

const word = new Word("你好", {ruby: "nǐ hǎo"});

构建一个动态单词:

// This word will be executed when it is displayed
const word = new Word((ctx) => 
    `Now it is ${new Date().toLocaleTimeString()}`
, {color: "#f00"});

静态方法

isWord

  • obj: any - 要检查的对象
  • 如果对象是 Word 的实例,则返回 true,否则返回 false

color

  • text: string | Word - 要着色的文本或 Word 实例
  • color: Color - 要应用的颜色,参见 Color
  • 返回一个具有指定颜色的新 Word 实例

bold

  • text: string | Word - 要加粗的文本或 Word 实例
  • 返回一个具有加粗格式的新 Word 实例

italic

  • text: string | Word - 要斜体化的文本或 Word 实例
  • 返回一个具有斜体格式的新 Word 实例

公共方法

构造函数

  • text: T - 单词的内容
  • config?: Partial<WordConfig> - WordConfig

toString

如果单词是字符串,则返回该字符串。否则,返回一个空字符串

  • 返回 string