Configuração da Rybená

A Rybená oferece diversos parâmetros de configuração que permitem personalizar a aparência, posição e comportamento da solução. Todos os parâmetros são adicionados à URL do script `rybena.js`.

Sintaxe Básica

Para adicionar parâmetros, use o seguinte formato:

<script
  type="text/javascript"
  src="https://cdn.rybena.com.br/dom/master/latest/rybena.js?parametro1=valor1&parametro2=valor2"
></script>

Nota: Use & para separar múltiplos parâmetros. A ordem dos parâmetros não importa.

Parâmetros de Posição

Posição do Player (Desktop)

Controla onde o player de tradução aparece na tela em dispositivos desktop.

Parâmetro	Valores	Padrão	Descrição
`positionPlayer`	`left`, `right`	`left`	Posição horizontal do player

<script
  type="text/javascript"
  src="https://cdn.rybena.com.br/dom/master/latest/rybena.js?positionPlayer=right"
></script>

Posição do Player (Mobile)

Controla onde o player aparece em dispositivos móveis.

Parâmetro	Valores	Padrão	Descrição
`positionPlayerMobile`	`left`, `right`	`left`	Posição horizontal do player em mobile

<script
  type="text/javascript"
  src="https://cdn.rybena.com.br/dom/master/latest/rybena.js?positionPlayerMobile=right"
></script>

Posição da Barra de Acessibilidade

Controla onde a barra de acessibilidade aparece na tela.

Atenção: Esta configuração só funciona quando não há uma

Barra de acessibilidade customizada

Parâmetro	Valores	Padrão	Descrição
`positionBar`	`left`, `right`	`left`	Posição horizontal da barra
`offsetTopBar`	`40%`, `100px`, `12rem`, `30vh`	`40%`	Posição vertical da barra

<script
  type="text/javascript"
  src="https://cdn.rybena.com.br/dom/master/latest/rybena.js?positionBar=right&offsetTopBar=30vh"
></script>

Posição do Player (Eixos X e Y)

Ajuste fino da posição do player na página.

Parâmetro	Valores	Padrão	Descrição
`offsetX`	número (pixels)	`60`	Posição horizontal do player
`offsetY`	número (pixels)	`60`	Posição vertical do player

<script
  type="text/javascript"
  src="https://cdn.rybena.com.br/dom/master/latest/rybena.js?offsetX=100&offsetY=100"
></script>

Parâmetros de Aparência

Tamanho do Player

Controla o tamanho do player de tradução.

Parâmetro	Valores	Padrão	Descrição
`size`	número (pixels)	`280`	Tamanho do player

<script
  type="text/javascript"
  src="https://cdn.rybena.com.br/dom/master/latest/rybena.js?size=350"
></script>

Cor da Barra de Acessibilidade

Personaliza a cor de fundo da barra de acessibilidade.

Atenção: Esta configuração só funciona quando não há uma

Barra de acessibilidade customizada

Parâmetro	Valores	Padrão	Descrição
`backgroundColorBar`	código hexadecimal	`#316181`	Cor de fundo da barra

<script
  type="text/javascript"
  src="https://cdn.rybena.com.br/dom/master/latest/rybena.js?backgroundColorBar=#316181"
></script>

<script
  type="text/javascript"
  src="https://cdn.rybena.com.br/dom/master/latest/rybena.js?backgroundColorBar=#2E7D32"
></script>

Ordem da Pilha (Z-Index)

Controla a ordem de sobreposição da barra de acessibilidade.

Parâmetro	Valores	Padrão	Descrição
`zIndexBar`	número	-	Ordem da pilha da barra

<script
  type="text/javascript"
  src="https://cdn.rybena.com.br/dom/master/latest/rybena.js?zIndexBar=100"
></script>

Parâmetros de Comportamento

Tempo de Renderização

Controla o tempo de espera antes de renderizar a barra de acessibilidade.

Parâmetro	Valores	Padrão	Recomendado	Descrição
`renderTimeout`	número (ms)	`0`	`300`	Tempo de renderização da barra

<script
  type="text/javascript"
  src="https://cdn.rybena.com.br/dom/master/latest/rybena.js?renderTimeout=300"
></script>

Dica: Use renderTimeout=300 para evitar problemas de renderização em sites com carregamento lento.

Modo de Operação

Controla o modo de funcionamento da Rybená.

Parâmetro	Valores	Padrão	Descrição
`mode`	`full`, `api`	`full`	Modo de operação

<script
  type="text/javascript"
  src="https://cdn.rybena.com.br/dom/master/latest/rybena.js?mode=api"
></script>

Atenção: O modo api requer implementação adicional. Consulte a Documentação da API para mais detalhes.

Parâmetros de Idioma

Idioma Inicial

Define o idioma em que a Rybená será inicializada.

Parâmetro	Valores	Padrão	Descrição
`lang`	`ptBR`, `esES`, `enUS`	`ptBR`	Idioma inicial

<script
  type="text/javascript"
  src="https://cdn.rybena.com.br/dom/master/latest/rybena.js?lang=enUS"
></script>

<script
  type="text/javascript"
  src="https://cdn.rybena.com.br/dom/master/latest/rybena.js?lang=esES"
></script>

Importante: A funcionalidade de tradução em LIBRAS está disponível apenas quando a Rybená está configurada em Português (ptBR). Para outros idiomas, apenas as funcionalidades de voz e acessibilidade visual estão disponíveis.

Parâmetros de Botões

Desabilitar Botões Específicos

Controla quais botões da Rybená serão exibidos.

Parâmetro	Valores	Padrão	Descrição
`disableLibrasButton`	`true`, `false`	`false`	Desabilita botão de LIBRAS
`disableVoiceButton`	`true`, `false`	`false`	Desabilita botão de Voz
`disableAccessibilityButton`	`true`, `false`	`false`	Desabilita botão de Acessibilidade

<script
  type="text/javascript"
  src="https://cdn.rybena.com.br/dom/master/latest/rybena.js?disableLibrasButton=true"
></script>

<script
  type="text/javascript"
  src="https://cdn.rybena.com.br/dom/master/latest/rybena.js?disableLibrasButton=true&disableVoiceButton=true"
></script>

Nota: Quando um botão é desabilitado, ele não é inserido no DOM, economizando recursos. Os atalhos de teclado (ALT+SHIFT+1/2/3) também respeitam os botões desabilitados.

Parâmetros de Privacidade

Desabilitar Coleta de Dados

Controla a coleta de dados de soletramento para melhoria da base de sinais.

Parâmetro	Valores	Padrão	Descrição
`doNotTrack`	`true`, `false`	`false`	Desabilita coleta de dados

<script
  type="text/javascript"
  src="https://cdn.rybena.com.br/dom/master/latest/rybena.js"
  doNotTrack="true"
></script>

Dica: Saiba mais sobre privacidade e coleta de dados na seção Privacidade e Coleta de Dados.

Exemplos de Configuração

Configuração Minimalista

Player pequeno, à direita, sem botão de LIBRAS:

<script
  type="text/javascript"
  src="https://cdn.rybena.com.br/dom/master/latest/rybena.js?size=250&positionPlayer=right&disableLibrasButton=true"
></script>

Configuração para Sites Corporativos

Barra personalizada, player maior, em inglês:

<script
  type="text/javascript"
  src="https://cdn.rybena.com.br/dom/master/latest/rybena.js?size=350&backgroundColorBar=#1a365d&lang=enUS&renderTimeout=300"
></script>

Configuração para Sites Brasileiros

Configuração completa em português:

<script
  type="text/javascript"
  src="https://cdn.rybena.com.br/dom/master/latest/rybena.js?lang=ptBR&size=300&positionPlayer=left&backgroundColorBar=#316181&renderTimeout=300"
></script>

Configuração para Integração API

Modo API com desabilitação de coleta de dados:

<script
  type="text/javascript"
  src="https://cdn.rybena.com.br/dom/master/latest/rybena.js?mode=api"
  doNotTrack="true"
></script>