Pular para o conteúdo principal
Versão: v11.0.0

Parâmetros

Os Parâmetros permitem configurar e personalizar o funcionamento do plugin da Hand Talk. Você pode ativar ou desativar funcionalidades conforme sua necessidade, ajustando elementos como posição, alinhamento, idioma e recursos assistivos.

Tradutor de Sites

Você pode preferir habilitar ou desabilitar algumas funcionalidades do Tradutor de Sites, para isso utilize os parâmetros abaixo:

ConfiguraçõesDescriçãoValoresPadrão
alignDefine o alinhamento vertical da janela do tradutor no site."default" ou "top" ou "bottom""default"
avatarDefine o avatar que o plugin irá utilizar."HUGO" ou "MAYA""HUGO"
doNotTrackSe o valor desta propriedade for verdadeiro, as frases traduzidas não serão armazenadas ou utilizada para a melhoria do sistema de tradução.false ou truefalse
exceptionsLista de queries que serão ignoradas pelo plugin, ex.: ["a", "form", ".main", "#site-title"]array[ ]
highContrastDefine se o plugin vai iniciar com o modo escuro ativado.false ou truefalse
maxTextSizeDefine o tamanho máximo de caracteres para captura de texto em um elemento.Número inteiro entre 500 e 1000800
mobileConfigObjeto de configuração para a plataforma mobile, quando definido, sobscreve as configurações padrões de HT.Object
customButtonStyleDefine uma customização para o botão de acessibilidade na versão mobile dentro do parâmetro mobileConfig.{borderRadius, size, horizontalMargin, bottomMargin}undefined
mobileEnabledQuando verdadeiro ativa o tradutor de sites em dispositivos móveis.false ou truetrue
remoteConfigEnabledQuando verdadeiro ativa as Configurações Remotas do Plugin.false ou truetrue
addonsEnabledQuando verdadeiro ativa os Recursos Assistivos do Plugin.false ou truetrue
opacityDefine a opacidade inicial do fundo no plugin.Número: 0 ou 50 ou 100100
parentElementElemento que receberá o plugin Hand Talk.Elementdocument.body
sideDefine o posicionamento da janela do tradutor no site. O Tradutor de Sites pode ser inicializado do lado esquerdo ou do lado direito da tela."right" ou "left""right"
textEnabledQuando verdadeiro: exibe o tradutor de sites para textos.false ou truetrue
zIndexDefine o posicionamento da profundidade do tradutor no site, ou seja, determinar se o Tradutor de Sites estará mais próximo ou mais afastado da tela.Inteiros1000000
clickablesLista de queries que serão tratadas como elementos clicaveis, pelo plugin, ex.: ["a", "form", ".main", "#site-title"]array[ ]
languageAltera a língua do plugin."en-ase" ou "ptBR-bzs""ptBR-bzs"
colorButtonDefine a cor do botão do Hand Talk Plugin."a11yColorMain" or "neutralLowMain" or "a11yColorLight""a11yColorMain"
offRedirectionQuando verdadeiro desativa o redirecionamento de links externos, útil para o contexto de máquinas de auto atendimento.false ou truefalse
addonsMapObjeto de configuração para gerenciar uso de recursos assistivos individualmente.Object{ fontControl {}, navigation {}, colorControl {}}
dica

Para mais informações sobre o customButtonStyle e a customização no mobile acesse o link: Botão de acessibilidade no mobile

Exemplo do uso dos parâmetros no Tradutor de Sites

<body>
<h1>Hand Talk</h1>
<h2>
Conte com a ajuda do Hugo e da Maya, nossos tradutores virtuais, para tornar
a sua comunicação mais acessível.
</h2>
<p>
Oferecemos tradução digital para acessibilidade em Libras, a Língua
Brasileira de Sinais.
</p>
<!-- Pega a ultima versão do plugin Hand Talk -->
<script src="https://plugin.handtalk.me/web/latest/handtalk.min.js"></script>
<script>
var ht = new HT({
// Troque por seu token de acesso
token: "TOKEN",
// Muda o avatar para o HUGO
avatar: "HUGO",
// Muda o alinhamento para cima
align: "top",
// Muda o lado para a direita
side: "right",
// Muda o botão do plugin para a cor a11yColorLight
colorButton: "a11yColorLight",
// Muda a opacidade inicial do plugin
opacity: 50,
// Inicia o plugin com o modo escuro ativado
highContrast: true,
//Inicia o plugin em ASL
language: "en-ase",
});
</script>
</body>

Recursos Assistivos

Você pode adicionar parâmetros específicos para gerenciar a disponibilidade dos recursos assistivos. Para isso, utilize a propriedade addonsMap e adicione os parâmetros que irão sobrescrever as configurações padrão.

ConfiguraçõesDescriçãoValores
addonsMapObjeto de configuração para gerenciar uso de recursos assistivos individualmente{ fontControl {}, navigation {}, colorControl {}}

O gerenciamento dos recursos ocorre através do objeto de cada seção. Você pode desabilitar um ou mais recursos de acordo com a seção escolhida. Abaixo, segue uma tabela com os objetos das seções disponíveis:

ConfiguraçõesDescriçãoValores
fontControlObjeto de configuração para gerenciar uso de recursos assistivos relacionados a controle de fonte{ fontSize, textStyle, highlightLetters, letterSpacing, lineHeight }
navigationObjeto de configuração para gerenciar uso de recursos assistivos relacionados a navegação{ pageSpeech, readerMode, readingMask, magnifier, pageStructure, hideImages, highlightHeadings, highlightLinks, readingGuide, pauseAnimations }
colorControlObjeto de configuração para gerenciar uso de recursos assistivos relacionados a controle de cores{ contrastMode, saturationMode }

Dentro do objeto da seção escolhida, você pode adicionar um ou mais recursos caso deseje desativá-los. Para isso, defina o recurso específico de acordo com sua seção.

dica

Por padrão todos os parâmetros dos recursos assistivos são definidos como true.

📌 fontControl

Objeto responsável por agrupar recursos assistivos relacionados a controle de texto

ConfiguraçõesDescriçãoValores
fontSizeGerencia o estado do recurso tamanho de fontetrue ou false
textStyleGerencia o estado do recurso estilo de textotrue ou false
highlightLettersGerencia o estado do recurso letras destacadastrue ou false
letterSpacingGerencia o estado do recurso espaço entre letrastrue ou false
lineHeightGerencia o estado do recurso espaço entre linhastrue ou false

📌 navigation

Objeto responsável por agrupar recursos assistivos relacionados a navegação

ConfiguraçõesDescriçãoValores
pageSpeechGerencia o estado do recurso leitor de sitestrue ou false
readerModeGerencia o estado do recurso modo de leituratrue ou false
readingMaskGerencia o estado do recurso máscara de leituratrue ou false
magnifierGerencia o estado do recurso lupa de conteúdotrue ou false
pageStructureGerencia o estado do recurso estrutura de páginastrue ou false
hideImagesGerencia o estado do recurso esconder imagenstrue ou false
highlightHeadingsGerencia o estado do recurso destacar cabeçalhostrue ou false
highlightLinksGerencia o estado do recurso destaque de linkstrue ou false
readingGuideGerencia o estado do recurso guia de leituratrue ou false
pauseAnimationsGerencia o estado do recurso pausar animaçõestrue ou false
disableSoundsGerencia o estado do recurso Parar Sonstrue ou false

📌 colorControl

Objeto responsável por agrupar recursos assistivos relacionados a controle de cores

ConfiguraçõesDescriçãoValores
contrastModeGerencia o estado do recurso contraste de corestrue ou false
saturationModeGerencia o estado do recurso saturaçãotrue ou false
pageColorsGerencia o estado do recurso modo daltônicotrue ou false

Exemplo do uso dos parâmetros nos Recursos Assistivos

<body>
<h1>Hand Talk</h1>
<h2>
Conte com a ajuda do Hugo e da Maya, nossos tradutores virtuais, para tornar
a sua comunicação mais acessível.
</h2>
<p>
Oferecemos tradução digital para acessibilidade em Libras, a Língua
Brasileira de Sinais.
</p>
<!-- Pega a ultima versão do plugin Hand Talk -->
<script src="https://plugin.handtalk.me/web/latest/handtalk.min.js"></script>
<script>
var ht = new HT({
// Troque por seu token de acesso
token: "TOKEN",
// Objeto responsável por agrupar recursos assistivos
addonsMap: {
// Desativa recursos da seção controle de fonte individualmente
fontControl: {
fontSize: false,
textStyle: false,
highlightLetters: false,
letterSpacing: false,
lineHeight: false,
},
// Desativa recursos da seção de navegação individualmente
navigation: {
pageSpeech: false,
readerMode: false,
readingMask: false,
magnifier: false,
pageStructure: false,
hideImages: false,
highlightHeadings: false,
highlightLinks: false,
readingGuide: false,
pauseAnimations: false,
},
// Desativa recursos da seção controle de cores individualmente
colorControl: {
contrastMode: false,
saturationMode: false,
pageColors: false,
},
},
});
</script>
</body>