Skip to content

Commit 8511c82

Browse files
update readme with new props
1 parent 20ea5b6 commit 8511c82

File tree

1 file changed

+28
-17
lines changed

1 file changed

+28
-17
lines changed

README.md

+28-17
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# vlibras
2+
23
Componente Vue.js que ajuda você a implementar o VLibras no seu site.
34

4-
Demo: https://vue-vlibras.web.app
5+
Demo: [https://vue-vlibras.web.app](https://vue-vlibras.web.app)
56

6-
Esse componente segue os padrões fornecidos na [documentação do vlibras](https://www.vlibras.gov.br/doc/widget/index.html).
7+
Esse componente segue os padrões fornecidos na [documentação do VLibras](https://www.vlibras.gov.br/doc/widget/index.html).
78

8-
> Os surdos enfrentam bastante dificuldade para ler, escrever e se comunicar na língua oral do seu país. Dessa forma, para tentar reduzir esses problemas, o objetivo da ferramenta computacional de código aberto, denominada VLibras Widget, consiste em traduzir conteúdos do Português Brasileiro para a Língua Brasileira de Sinais (LIBRAS), tornando websites acessíveis a pessoas surdas. -- [Visão geral vlibras](https://www.vlibras.gov.br/doc/widget/introduction/overview.html)
9+
> Os surdos enfrentam bastante dificuldade para ler, escrever e se comunicar na língua oral do seu país. Dessa forma, para tentar reduzir esses problemas, o objetivo da ferramenta computacional de código aberto, denominada VLibras Widget, consiste em traduzir conteúdos do Português Brasileiro para a Língua Brasileira de Sinais (LIBRAS), tornando websites acessíveis a pessoas surdas. -- [Visão geral VLibras](https://www.vlibras.gov.br/doc/widget/introduction/overview.html)
910
1011
## Instalação
1112

@@ -26,23 +27,33 @@ createApp(App)
2627
```
2728

2829
## Como usar
29-
No seu App.vue
30+
No seu `App.vue`
3031

3132
```vue
3233
<template>
33-
<div>
34-
<a href="https://vitejs.dev" target="_blank">
35-
<img src="/vite.svg" class="logo" alt="Vite logo" />
36-
</a>
37-
<a href="https://vuejs.org/" target="_blank">
38-
<img src="./assets/vue.svg" class="logo vue" alt="Vue logo" />
39-
</a>
40-
</div>
41-
<HelloWorld msg="Vite + Vue" />
42-
<VLibras />
34+
<VLibras
35+
:position="'left'"
36+
:avatar="'random'"
37+
:opacity="1.0"
38+
/>
4339
</template>
4440
```
4541

42+
### Props
43+
44+
O componente `VLibras` suporta as seguintes props para personalização:
45+
46+
- **src**: URL do script do VLibras. Padrão: `https://vlibras.gov.br/app/vlibras-plugin.js`
47+
- **urlWidget**: URL base do widget VLibras. Padrão: `https://vlibras.gov.br/app`
48+
- **position**: Define a posição do widget na tela. Valores suportados:
49+
- `'left'`, `'right'`, `'bottom'`, `'top'`, `'bottom-left'`, `'top-left'`, `'bottom-right'`, `'top-right'`
50+
- Padrão: `'bottom-right'`
51+
- **avatar**: Escolha do avatar a ser exibido no widget. Valores suportados:
52+
- `'icaro'`, `'hosana'`, `'guga'`, `'random'`
53+
- Padrão: `'random'`
54+
- **opacity**: Define a opacidade do widget. Valores entre 0 (totalmente transparente) e 1 (totalmente opaco).
55+
- Padrão: `1.0`
56+
4657
### Suporte para Vue 2
4758

4859
Se você está utilizando Vue 2 em seus projetos, também pode integrar facilmente o VLibras! A versão específica para Vue 2 do componente está disponível [aqui](https://github.com/vue-a11y/vue-vlibras/tree/vue-2), mantendo a mesma funcionalidade e acessibilidade que a versão para Vue 3.
@@ -52,9 +63,9 @@ Confira o repositório no GitHub para mais detalhes e instruções sobre como in
5263
## Contribuindo
5364

5465
- De erros de digitação na documentação à codificação de novos recursos;
55-
- Verifique os issue em aberto ou abra um novo issue para iniciar uma discussão sobre sua ideia de recurso ou o bug que você encontrou;
56-
- Dê um fork no repositório, fazendo as alterações e enviando um PR;
66+
- Verifique os issues em aberto ou abra um novo issue para iniciar uma discussão sobre sua ideia de recurso ou o bug que você encontrou;
67+
- Dê um fork no repositório, faça as alterações e envie um PR;
5768

5869
Nos siga no Twitter [@vue_a11y](https://twitter.com/vue_a11y)
5970

60-
**Obrigado por usar e fazer a web mais acessível**
71+
**Obrigado por usar e fazer a web mais acessível!**

0 commit comments

Comments
 (0)