Descrição
Use a API chrome.fontSettings
para gerenciar as configurações de fonte do Chrome.
Permissões
fontSettings
Para usar a API Font Settings, é necessário declarar a permissão "fontSettings"
no manifesto
de extensões. Exemplo:
{
"name": "My Font Settings Extension",
"description": "Customize your fonts",
"version": "0.2",
"permissions": [
"fontSettings"
],
...
}
Conceitos e uso
O Chrome permite que algumas configurações de fonte dependam de determinadas famílias de fontes genéricas e scripts de linguagem. Por exemplo, a fonte usada para chinês simplificado sem serifa pode ser diferente da fonte usada para japonês com serifa.
As famílias de fontes genéricas com suporte no Chrome são baseadas em famílias de fontes genéricas do CSS e
estão listadas em GenericReference
. Quando uma página da Web especifica uma família de fontes genérica, o Chrome seleciona
a fonte com base na configuração correspondente. Se nenhuma família de fontes genérica for especificada, o Chrome usará a
configuração da família de fontes genéricas "padrão".
Quando uma página da Web especifica um idioma, o Chrome seleciona a fonte com base na configuração do script de idioma correspondente. Se nenhum idioma for especificado, o Chrome usará a configuração como script padrão ou global.
Os scripts de idioma compatíveis são especificados pelo código de script ISO 15924 e listados em
ScriptCode
. Tecnicamente, as configurações do Chrome não são estritamente por script, mas também dependem do idioma. Por exemplo, o Chrome escolhe a fonte para cirílico (código de script ISO 15924 "Cyrl") quando uma
página da Web especifica o idioma russo e usa essa fonte não apenas para o script cirílico, mas para
tudo o que a fonte cobre, como o latino.
Exemplos
O código a seguir recebe a fonte padrão para o árabe.
chrome.fontSettings.getFont(
{ genericFamily: 'standard', script: 'Arab' },
function(details) { console.log(details.fontId); }
);
O próximo snippet define a fonte Sans Serif para japonês.
chrome.fontSettings.setFont(
{ genericFamily: 'sansserif', script: 'Jpan', fontId: 'MS PGothic' }
);
Para testar essa API, instale o exemplo da API fontSettings no repositório chrome-extension-samples.
Tipos
FontName
Representa um nome de fonte.
Propriedades
-
displayName
string
O nome de exibição da fonte.
-
fontId
string
O ID da fonte.
GenericFamily
Uma família de fontes genérica de CSS.
Tipo enumerado
"sansserif"
LevelOfControl
Uma destas
not\_controllable
: não pode ser controlada por nenhuma extensão
controlled\_by\_other\_extensions
: controlada por extensões com maior precedência
controllable\_by\_this\_extension
: pode ser controlada por esta extensão
controlled\_by\_this\_extension
: controlada por esta extensão
Tipo enumerado
"not_controllable"
"controllable_by_this_extension"
ScriptCode
Um código de script ISO 15924. O script padrão ou global é representado pelo código "Zyyy".
Tipo enumerado
"Afak"
"Armi"
"Armn"
"Avst"
"Bali"
"Bamu"
"Batk"
"Beng"
"Blis"
"Bopo"
"Brah"
"Brai"
"Bugi"
"Buhd"
"Cakm"
"Cham"
"Cher"
"Copt"
"Cprt"
"Cyrl"
"Deva"
"Egyd"
"Elba"
"Geor"
"Geok"
"Glag"
"Gujr"
"Guru"
"Hani"
"Hano"
"Hans"
"Hant"
"Hebr"
"Hluw"
"Hmng"
"Inds"
"Ital"
"Java"
"Jpan"
"Jurc"
"Kali"
"Khmr"
"Khoj"
"Knda"
"Kpel"
"Kthi"
"Lana"
"Laoo"
"Latf"
"Latg"
"Latn"
"Lepc"
"Lina"
"Linb"
"Lisu"
"Loma"
"Lyci"
"Lydi"
"Mand"
"Mero"
"Mlym"
"Mong"
"Mtei"
"Mymr"
"Nbat"
"Nkgb"
"Nkoo"
"Nshu"
"Ogam"
"Olck"
"Orkh"
"Orya"
"Osma"
"Phag"
"Phli"
"Phlp"
"Phlv"
"Phnx"
"Plrd"
"Prti"
"Rjng"
"Roro"
"Runr"
"Samr"
"Sara"
"Sarb"
"Sgnw"
"Shrd"
"Sind"
"Sinh"
"Sora"
"Sund"
"Syrc"
"Syre"
"Syrn"
"Takr"
"Talu"
"Taml"
"Tang"
"Tavt"
"Telu"
"Teng"
"Tfng"
"Thaa"
"Tibt"
"Ugar"
"Vaii"
"Visp"
"Wara"
"Xpeo"
"Xsux"
"Yiii"
"Zmth"
"Zsym"
Métodos
clearDefaultFixedFontSize()
chrome.fontSettings.clearDefaultFixedFontSize(
details?: object,
callback?: function,
)
Limpa o tamanho de fonte fixo padrão definido por esta extensão, se houver.
Parâmetros
-
detalhes
objeto opcional
Esse parâmetro não é usado no momento.
-
callback
função optional
O parâmetro
callback
tem esta aparência:() => void
Retorna
-
Promise<void>
Chrome 96 ou mais recentePromessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.
clearDefaultFontSize()
chrome.fontSettings.clearDefaultFontSize(
details?: object,
callback?: function,
)
Limpa o tamanho de fonte padrão definido por esta extensão, se houver.
Parâmetros
-
detalhes
objeto opcional
Esse parâmetro não é usado no momento.
-
callback
função optional
O parâmetro
callback
tem esta aparência:() => void
Retorna
-
Promise<void>
Chrome 96 ou mais recentePromessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.
clearFont()
chrome.fontSettings.clearFont(
details: object,
callback?: function,
)
Limpa a fonte definida pela extensão, se houver.
Parâmetros
-
detalhes
objeto
-
genericFamily
A família genérica de fontes para a qual a fonte deve ser removida.
-
script
ScriptCode opcional
O script para o qual a fonte deve ser apagada. Se omitida, a configuração de fonte do script global será apagada.
-
-
callback
função optional
O parâmetro
callback
tem esta aparência:() => void
Retorna
-
Promise<void>
Chrome 96 ou mais recentePromessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.
clearMinimumFontSize()
chrome.fontSettings.clearMinimumFontSize(
details?: object,
callback?: function,
)
Limpa o tamanho mínimo da fonte definido pela extensão, se houver.
Parâmetros
-
detalhes
objeto opcional
Esse parâmetro não é usado no momento.
-
callback
função optional
O parâmetro
callback
tem esta aparência:() => void
Retorna
-
Promise<void>
Chrome 96 ou mais recentePromessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.
getDefaultFixedFontSize()
chrome.fontSettings.getDefaultFixedFontSize(
details?: object,
callback?: function,
)
Recebe o tamanho padrão para fontes de largura fixa.
Parâmetros
-
detalhes
objeto opcional
Esse parâmetro não é usado no momento.
-
callback
função optional
O parâmetro
callback
tem esta aparência:(details: object) => void
-
detalhes
objeto
-
levelOfControl
O nível de controle da extensão sobre a configuração.
-
pixelSize
number
O tamanho da fonte em pixels.
-
-
Retorna
-
Promise<object>
Chrome 96 ou mais recentePromessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.
getDefaultFontSize()
chrome.fontSettings.getDefaultFontSize(
details?: object,
callback?: function,
)
Recebe o tamanho da fonte padrão.
Parâmetros
-
detalhes
objeto opcional
Esse parâmetro não é usado no momento.
-
callback
função optional
O parâmetro
callback
tem esta aparência:(details: object) => void
-
detalhes
objeto
-
levelOfControl
O nível de controle da extensão sobre a configuração.
-
pixelSize
number
O tamanho da fonte em pixels.
-
-
Retorna
-
Promise<object>
Chrome 96 ou mais recentePromessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.
getFont()
chrome.fontSettings.getFont(
details: object,
callback?: function,
)
Recebe a fonte de um determinado script e família de fontes genérica.
Parâmetros
-
detalhes
objeto
-
genericFamily
A família genérica de fontes para a qual a fonte precisa ser recuperada.
-
script
ScriptCode opcional
O script para o qual a fonte precisa ser recuperada. Se omitida, a configuração de fonte do script global (código de script "Zyyy") será recuperada.
-
-
callback
função optional
O parâmetro
callback
tem esta aparência:(details: object) => void
-
detalhes
objeto
-
fontId
string
O ID da fonte. Em vez do valor de preferência do ID de fonte literal, ele pode ser o ID da fonte para a qual o sistema resolve o valor de preferência. Portanto, a
fontId
pode ser diferente da fonte transmitida parasetFont
se, por exemplo, a fonte não estiver disponível no sistema. A string vazia significa substituto para a configuração de fonte do script global. -
levelOfControl
O nível de controle da extensão sobre a configuração.
-
-
Retorna
-
Promise<object>
Chrome 96 ou mais recentePromessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.
getFontList()
chrome.fontSettings.getFontList(
callback?: function,
)
Extrai uma lista de fontes no sistema.
Parâmetros
Retorna
-
Promise<FontName[]>
Chrome 96 ou mais recentePromessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.
getMinimumFontSize()
chrome.fontSettings.getMinimumFontSize(
details?: object,
callback?: function,
)
Recebe o tamanho mínimo da fonte.
Parâmetros
-
detalhes
objeto opcional
Esse parâmetro não é usado no momento.
-
callback
função optional
O parâmetro
callback
tem esta aparência:(details: object) => void
-
detalhes
objeto
-
levelOfControl
O nível de controle da extensão sobre a configuração.
-
pixelSize
number
O tamanho da fonte em pixels.
-
-
Retorna
-
Promise<object>
Chrome 96 ou mais recentePromessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.
setDefaultFixedFontSize()
chrome.fontSettings.setDefaultFixedFontSize(
details: object,
callback?: function,
)
Define o tamanho padrão para fontes com largura fixa.
Parâmetros
-
detalhes
objeto
-
pixelSize
number
O tamanho da fonte em pixels.
-
-
callback
função optional
O parâmetro
callback
tem esta aparência:() => void
Retorna
-
Promise<void>
Chrome 96 ou mais recentePromessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.
setDefaultFontSize()
chrome.fontSettings.setDefaultFontSize(
details: object,
callback?: function,
)
Define o tamanho da fonte padrão.
Parâmetros
-
detalhes
objeto
-
pixelSize
number
O tamanho da fonte em pixels.
-
-
callback
função optional
O parâmetro
callback
tem esta aparência:() => void
Retorna
-
Promise<void>
Chrome 96 ou mais recentePromessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.
setFont()
chrome.fontSettings.setFont(
details: object,
callback?: function,
)
Define a fonte de um determinado script e família de fontes genérica.
Parâmetros
-
detalhes
objeto
-
fontId
string
O ID da fonte. A string vazia significa substituir a configuração de fonte do script global.
-
genericFamily
A família genérica de fontes para a qual a fonte precisa ser definida.
-
script
ScriptCode opcional
O código de script em que a fonte deve ser definida. Se omitida, a configuração de fonte do script global (código de script "Zyyy") será definida.
-
-
callback
função optional
O parâmetro
callback
tem esta aparência:() => void
Retorna
-
Promise<void>
Chrome 96 ou mais recentePromessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.
setMinimumFontSize()
chrome.fontSettings.setMinimumFontSize(
details: object,
callback?: function,
)
Define o tamanho mínimo da fonte.
Parâmetros
-
detalhes
objeto
-
pixelSize
number
O tamanho da fonte em pixels.
-
-
callback
função optional
O parâmetro
callback
tem esta aparência:() => void
Retorna
-
Promise<void>
Chrome 96 ou mais recentePromessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.
Eventos
onDefaultFixedFontSizeChanged
chrome.fontSettings.onDefaultFixedFontSizeChanged.addListener(
callback: function,
)
Disparado quando a configuração padrão de tamanho de fonte fixa muda.
Parâmetros
-
callback
função
O parâmetro
callback
tem esta aparência:(details: object) => void
-
detalhes
objeto
-
levelOfControl
O nível de controle da extensão sobre a configuração.
-
pixelSize
number
O tamanho da fonte em pixels.
-
-
onDefaultFontSizeChanged
chrome.fontSettings.onDefaultFontSizeChanged.addListener(
callback: function,
)
Disparado quando a configuração de tamanho de fonte padrão é alterada.
Parâmetros
-
callback
função
O parâmetro
callback
tem esta aparência:(details: object) => void
-
detalhes
objeto
-
levelOfControl
O nível de controle da extensão sobre a configuração.
-
pixelSize
number
O tamanho da fonte em pixels.
-
-
onFontChanged
chrome.fontSettings.onFontChanged.addListener(
callback: function,
)
Disparado quando uma configuração de fonte é alterada.
Parâmetros
-
callback
função
O parâmetro
callback
tem esta aparência:(details: object) => void
-
detalhes
objeto
-
fontId
string
O ID da fonte. Consulte a descrição em
getFont
. -
genericFamily
A família de fontes genérica para a qual a configuração de fonte foi alterada.
-
levelOfControl
O nível de controle da extensão sobre a configuração.
-
script
ScriptCode opcional
O código de script para o qual a configuração de fonte foi alterada.
-
-
onMinimumFontSizeChanged
chrome.fontSettings.onMinimumFontSizeChanged.addListener(
callback: function,
)
Disparado quando a configuração de tamanho mínimo da fonte é alterada.
Parâmetros
-
callback
função
O parâmetro
callback
tem esta aparência:(details: object) => void
-
detalhes
objeto
-
levelOfControl
O nível de controle da extensão sobre a configuração.
-
pixelSize
number
O tamanho da fonte em pixels.
-
-