browser.fontSettings

说明

使用 chrome.fontSettings API 管理 Chrome 的字体设置。

权限

fontSettings

如需使用 Font Settings API,您必须在扩展程序清单中声明 "fontSettings" 权限。例如:

{
  "name": "My Font Settings Extension",
  "description": "Customize your fonts",
  "version": "0.2",
  "permissions": [
    "fontSettings"
  ],
  ...
}

概念和用法

Chrome 允许某些字体设置取决于特定的通用字体系列和语言脚本。例如,用于 sans-serif 简体中文的字体可能与用于 serif 日语的字体不同。

Chrome 支持的通用字体系列基于 CSS 通用字体系列,并在 GenericReference 下列出。当网页指定通用字体系列时,Chrome 会根据相应设置选择字体。如果未指定通用字体系列,Chrome 会使用“标准”通用字体系列的设置。

当网页指定了语言时,Chrome 会根据相应语言脚本的设置选择字体。如果未指定语言,Chrome 会使用默认(或全局)脚本的设置。

支持的语言脚本由 ISO 15924 脚本代码指定,并列在 ScriptCode 下。从技术上讲,Chrome 设置并非严格按照文字系统进行,还取决于语言。例如,当网页指定俄语时,Chrome 会选择西里尔字母(ISO 15924 脚本代码“Cyrl”)的字体,并且不仅将此字体用于西里尔字母,还用于该字体涵盖的所有内容,例如拉丁语。

示例

以下代码会获取阿拉伯语的标准字体。

browser.fontSettings.getFont(
  { genericFamily: 'standard', script: 'Arab' },
  function(details) { console.log(details.fontId); }
);

下一个代码段用于设置日语的 Sans Serif 字体。

browser.fontSettings.setFont(
  { genericFamily: 'sansserif', script: 'Jpan', fontId: 'MS PGothic' }
);

如需试用此 API,请从 chrome-extension-samples 代码库中安装 fontSettings API 示例。

类型

FontName

表示字体名称。

属性

  • displayName

    字符串

    字体的显示名称。

  • fontId

    字符串

    字体 ID。

GenericFamily

CSS 通用字体系列。

枚举

"standard"

"sansserif"

"serif"

"fixed"

"cursive"

"fantasy"

"math"

LevelOfControl

以下值之一: not\_controllable:无法由任何扩展程序控制 controlled\_by\_other\_extensions:由优先级较高的扩展程序控制 controllable\_by\_this\_extension:可由此扩展程序控制 controlled\_by\_this\_extension:由此扩展程序控制

枚举

"not_controllable"

"controlled_by_other_extensions"

"controllable_by_this_extension"

"controlled_by_this_extension"

ScriptCode

ISO 15924 脚本代码。默认或全局脚本由脚本代码“Zyyy”表示。

枚举

"Afak"

"Arab"

"Aran"

"Armi"

"Armn"

"Avst"

"Bali"

"Bamu"

"Bass"

"Batk"

"Beng"

"Blis"

"Bopo"

"Brah"

"Brai"

"Bugi"

"Buhd"

"Cakm"

"Cans"

"Cari"

"Cham"

"Cher"

"Cirt"

"Copt"

"Cprt"

"Cyrl"

"Cyrs"

"Deva"

"Dsrt"

"Dupl"

"Egyd"

"Egyh"

"Egyp"

"Elba"

"Ethi"

"Geor"

"Geok"

"Glag"

"Goth"

"Gran"

"Grek"

"Gujr"

"Guru"

"Hang"

"Hani"

"Hano"

"Hans"

"Hant"

"Hebr"

"Hluw"

"Hmng"

"Hung"

"Inds"

"Ital"

"Java"

"Jpan"

"Jurc"

"Kali"

"Khar"

"Khmr"

“Khoj”

"Knda"

"Kpel"

"Kthi"

"Lana"

"Laoo"

"Latf"

"Latg"

"Latn"

"Lepc"

"Limb"

"Lina"

"Linb"

"Lisu"

"Loma"

"Lyci"

"Lydi"

"Mand"

"Mani"

"Maya"

"Mend"

"Merc"

"Mero"

"Mlym"

"Moon"

"Mong"

"Mroo"

"Mtei"

"Mymr"

"Narb"

"Nbat"

"Nkgb"

"Nkoo"

"Nshu"

"Ogam"

"Olck"

"Orkh"

"Orya"

"Osma"

"Palm"

"Perm"

"Phag"

"Phli"

"Phlp"

"Phlv"

"Phnx"

"Plrd"

"Prti"

"Rjng"

"Roro"

"Runr"

"Samr"

"Sara"

"Sarb"

"Saur"

"Sgnw"

"Shaw"

"Shrd"

"Sind"

"Sinh"

"Sora"

"Sund"

"Sylo"

"Syrc"

"Syre"

"Syrj"

"Syrn"

"Tagb"

"Takr"

"Tale"

"Talu"

"Taml"

"Tang"

"Tavt"

"Telu"

"Teng"

"Tfng"

"Tglg"

"Thaa"

"Thai"

"Tibt"

"Tirh"

"Ugar"

"Vaii"

"Visp"

"Wara"

"Wole"

"Xpeo"

"Xsux"

"Yiii"

"Zmth"

"Zsym"

"Zyyy"

方法

clearDefaultFixedFontSize()

chrome.fontSettings.clearDefaultFixedFontSize(
  details?: object,
)
: Promise<void>

清除此扩展程序设置的默认固定字体大小(如果有)。

参数

  • 详细信息

    对象(可选)

    此参数目前尚未使用。

返回

  • 承诺<void>

    Chrome 96 及更高版本

clearDefaultFontSize()

chrome.fontSettings.clearDefaultFontSize(
  details?: object,
)
: Promise<void>

清除此扩展程序设置的默认字体大小(如果有)。

参数

  • 详细信息

    对象(可选)

    此参数目前尚未使用。

返回

  • 承诺<void>

    Chrome 96 及更高版本

clearFont()

chrome.fontSettings.clearFont(
  details: object,
)
: Promise<void>

清除此扩展程序设置的字体(如果有)。

参数

  • 详细信息

    对象

    • genericFamily

      应清除字体的通用字体系列。

    • 文字

      ScriptCode 可选

      应清除字体的脚本。如果省略,则会清除全局脚本字体设置。

返回

  • 承诺<void>

    Chrome 96 及更高版本

clearMinimumFontSize()

chrome.fontSettings.clearMinimumFontSize(
  details?: object,
)
: Promise<void>

清除此扩展程序设置的最小字号(如果有)。

参数

  • 详细信息

    对象(可选)

    此参数目前尚未使用。

返回

  • 承诺<void>

    Chrome 96 及更高版本

getDefaultFixedFontSize()

chrome.fontSettings.getDefaultFixedFontSize(
  details?: object,
)
: Promise<object>

获取等宽字体的默认大小。

参数

  • 详细信息

    对象(可选)

    此参数目前尚未使用。

返回

  • Promise<object>

    Chrome 96 及更高版本

getDefaultFontSize()

chrome.fontSettings.getDefaultFontSize(
  details?: object,
)
: Promise<object>

获取默认字体大小。

参数

  • 详细信息

    对象(可选)

    此参数目前尚未使用。

返回

  • Promise<object>

    Chrome 96 及更高版本

getFont()

chrome.fontSettings.getFont(
  details: object,
)
: Promise<object>

获取给定脚本和通用字体系列的字体。

参数

  • 详细信息

    对象

    • genericFamily

      应检索的字体所属的通用字体系列。

    • 文字

      ScriptCode 可选

      应检索其字体的脚本。如果省略,系统会检索全局脚本(脚本代码为“Zyyy”)的字体设置。

返回

  • Promise<object>

    Chrome 96 及更高版本

getFontList()

chrome.fontSettings.getFontList(): Promise<FontName[]>

获取系统中的字体列表。

返回

  • Promise<FontName[]>

    Chrome 96 及更高版本

getMinimumFontSize()

chrome.fontSettings.getMinimumFontSize(
  details?: object,
)
: Promise<object>

获取最小字号。

参数

  • 详细信息

    对象(可选)

    此参数目前尚未使用。

返回

  • Promise<object>

    Chrome 96 及更高版本

setDefaultFixedFontSize()

chrome.fontSettings.setDefaultFixedFontSize(
  details: object,
)
: Promise<void>

设置等宽字体的默认大小。

参数

  • 详细信息

    对象

    • pixelSize

      数值

      字体大小(以像素为单位)。

返回

  • 承诺<void>

    Chrome 96 及更高版本

setDefaultFontSize()

chrome.fontSettings.setDefaultFontSize(
  details: object,
)
: Promise<void>

设置默认字体大小。

参数

  • 详细信息

    对象

    • pixelSize

      数值

      字体大小(以像素为单位)。

返回

  • 承诺<void>

    Chrome 96 及更高版本

setFont()

chrome.fontSettings.setFont(
  details: object,
)
: Promise<void>

为给定脚本和通用字体系列设置字体。

参数

  • 详细信息

    对象

    • fontId

      字符串

      字体 ID。空字符串表示回退到全局脚本字体设置。

    • genericFamily

      应为其设置字体的通用字体系列。

    • 文字

      ScriptCode 可选

      应设置字体的脚本代码。如果省略,系统会设置全局脚本(脚本代码“Zyyy”)的字体设置。

返回

  • 承诺<void>

    Chrome 96 及更高版本

setMinimumFontSize()

chrome.fontSettings.setMinimumFontSize(
  details: object,
)
: Promise<void>

设置最小字体大小。

参数

  • 详细信息

    对象

    • pixelSize

      数值

      字体大小(以像素为单位)。

返回

  • 承诺<void>

    Chrome 96 及更高版本

事件

onDefaultFixedFontSizeChanged

chrome.fontSettings.onDefaultFixedFontSizeChanged.addListener(
  callback: function,
)

在默认固定字体大小设置发生更改时触发。

参数

  • callback

    函数

    callback 参数如下所示:

    (details: object) => void

    • 详细信息

      对象

      • levelOfControl

        此扩展程序对该设置的控制级别。

      • pixelSize

        数值

        字体大小(以像素为单位)。

onDefaultFontSizeChanged

chrome.fontSettings.onDefaultFontSizeChanged.addListener(
  callback: function,
)

在默认字体大小设置发生更改时触发。

参数

  • callback

    函数

    callback 参数如下所示:

    (details: object) => void

    • 详细信息

      对象

      • levelOfControl

        此扩展程序对该设置的控制级别。

      • pixelSize

        数值

        字体大小(以像素为单位)。

onFontChanged

chrome.fontSettings.onFontChanged.addListener(
  callback: function,
)

在字体设置发生更改时触发。

参数

  • callback

    函数

    callback 参数如下所示:

    (details: object) => void

    • 详细信息

      对象

      • fontId

        字符串

        字体 ID。请参阅 getFont 中的说明。

      • genericFamily

        字体设置已更改的通用字体系列。

      • levelOfControl

        此扩展程序对该设置的控制级别。

      • 文字

        ScriptCode 可选

        字体设置已更改的文字代码。

onMinimumFontSizeChanged

chrome.fontSettings.onMinimumFontSizeChanged.addListener(
  callback: function,
)

在最小字体大小设置发生更改时触发。

参数

  • callback

    函数

    callback 参数如下所示:

    (details: object) => void

    • 详细信息

      对象

      • levelOfControl

        此扩展程序对该设置的控制级别。

      • pixelSize

        数值

        字体大小(以像素为单位)。