Configurações

A classe HTApi é a entrada principal para toda a configuração da biblioteca, através do construtor da classe, é possível dar toda a configuração inicial necessária.

Um exemplo de configuração total pode ser o seguinte:

new window.HTApi({
	token: "SEU TOKEN",
	avatar: "HUGO",
	language: "ptBR",
	signLanguage: "ptBR-bzs",
	parentElement: document.body,
	enableComponents:{
		widget: true;
  		promptLink: true;
	}
	theme: {
		activationButton: {
          border: '#FFFFFF',
          background: '#003087',
          foreground: '#FFFFFF',
        },

        promptLink: {
          border: '#FFFFFF',
          background: '#2E2E2E',
          foreground: '#FFFFFF',
        },

        widget: {
          border: '#FFFFFF',
          background: '#2E2E2E',
          foreground: '#FFFFFF',
        },
	}
});

Com exceção do campo token, todos os outros campos possuem um valor padrão.

token

• type: string

Esse campo recebe a chave de acesso recebida durante a contratação com a Hand Talk S.A. Com ele, a biblioteca consegue autenticar suas requisições e garantir acesso a seus recursos.

ATENÇÃO

Sempre que alterar o canal de lançamento entre beta e latest, o campo token deve ser alterado, pois esses dois canais utilizam tokens diferentes para se autenticar. Não realizar essa mudança, vai acarretar na negação de solicitações de tradução.

O canal latest e versão fixa utilizam o mesmo token.

Veja mais informações em Canais de lançamento

avatar

• tipo: string
• padrão: HUGO
• opções: HUGO, MAYA

Esse campo pode receber dois valores: HUGO ou MAYA e serve para determinar qual personagem 3D vai aparecer durante as traduções.

language

• tipo: string
• padrão: ptBR
• opções: ptBR, enUS, esES

Campo que define o idioma da aplicação. Ele traduz textos, arias e outros elementos textuais para o idioma escolhido.

ATENÇÃO

Esse campo não muda a língua de sinais que a biblioteca vai traduzir, servindo apenas para internacionalização dos componentes internos e elementos HTML. Para mudar a língua de sinais, use o campo signLanguage.

signLanguage

• tipo: string
• padrão: ptBR-bzs
• opções: ptBR-bzs, en-ase

Campo que define qual língua de sinais será utilizada para traduzir os textos passados.

parentElement

• tipo: HTMLElement
• padrão: document.body

Esse campo define o elemento pai que a biblioteca vai se alocar e é útil para determinar a hierarquia dos elementos da biblioteca, ou seja, os componentes, janela de tradução e etc ficarão hierarquicamente localizados como filhos do elemento passado em parentElement. Por padrão, o elemento pai é o body do seu HTML,

enableComponents

• tipo: object
• padrão:

{
	"widget": true,
	"promptLink": true
}

Esse campo serve para habilitar ou desabilitar os componentes da biblioteca. Cada campo é opcional e não é necessário informar todos os valores. Recomendamos utilizar essa propriedade, caso deseje desativar os componentes que a biblioteca fornece e criar suas próprias implementações.

ATENÇÃO

A janela de tradução não pode ser desativada, tendo em vista que é ela que exibe as traduções.

widget

• tipo: boolean
• padrão: true

Habilita ou desabilita o widget da biblioteca.

promptLink

• tipo: boolean
• padrão: true

Habilita ou desabilita o prompt link da biblioteca.

theme

• tipo: object
• padrão:

{
	"activationButton": {
		"border": "#FFFFFF",
		"background": "#003087",
		"foreground": "#FFFFFF"
	},

	"promptLink": {
		"border": "#FFFFFF",
		"background": "#2E2E2E",
		"foreground": "#FFFFFF"
	},

	"widget": {
		"border": "#FFFFFF",
		"background": "#2E2E2E",
		"foreground": "#FFFFFF"
	}
}

Esse campo serve para personalizar o estilo dos elementos da biblioteca. Cada campo é opcional e não é necessário informar todos os valores.

activationButton

border

• tipo: string
• padrão: #FFFFFF

Define a cor do contorno do botão de ativação da biblioteca.

background

• tipo: string
• padrão: #003087

Define a cor de fundo do botão de ativação da biblioteca.

foreground

• tipo: string
• padrão: #FFFFFF

Define a cor do texto do botão de ativação da biblioteca.

promptLink

border

• tipo: string
• padrão: #FFFFFF

Define a cor do contorno do prompt link da biblioteca.

background

• tipo: string
• padrão: #2E2E2E

Define a cor de fundo do prompt link da biblioteca.

foreground

• tipo: string
• padrão: #FFFFFF

Define a cor do texto do prompt link da biblioteca.

widget

border

• tipo: string
• padrão: #FFFFFF

Define a cor do contorno do widget da biblioteca.

background

• tipo: string
• padrão: #2E2E2E

Define a cor de fundo do widget da biblioteca.

foreground

• tipo: string
• padrão: #FFFFFF

Define a cor do texto do widget da biblioteca.