jstts-native 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +135 -0
  2. package/index.js +33 -0
  3. package/package.json +22 -0
package/README.md ADDED
@@ -0,0 +1,135 @@
1
+ # jsTTS 🔊
2
+
3
+ **jsTTS** é uma biblioteca JavaScript leve e simplificada para conversão de texto em fala (Text-to-Speech), que faz a ponte direta com o motor de síntese de voz nativo do sistema operacional (como o Windows SAPI) através da **Web Speech API** nativa dos navegadores.
4
+
5
+ ---
6
+
7
+ ## 🚀 Tecnologias Utilizadas
8
+
9
+ - **JavaScript (ES6+)**: Manipulação do DOM, funções e controle da API de voz.
10
+ - **Web Speech API (`SpeechSynthesis`)**: Interface nativa dos navegadores web para síntese de voz.
11
+ - **Windows SAPI / System.Speech**: Motor nativo do sistema operacional executado em segundo plano.
12
+ - **HTML5 & CSS3**: Para páginas de demonstração e testes de interface.
13
+
14
+ ---
15
+
16
+ ## 🛠️ Como o Código Funciona
17
+
18
+ A função `lerElemento` localiza um elemento HTML através do seu seletor CSS, extrai a informação solicitada (o texto interno ou o valor de um atributo específico) e envia essa mensagem diretamente para o motor de áudio do sistema operacional.
19
+
20
+ ### Fluxo de Execução:
21
+
22
+ 1. **Seleção do Elemento**: Utiliza `document.querySelector` para encontrar a tag no DOM.
23
+ 2. **Extração de Conteúdo**:
24
+ - Se a propriedade informada for `"text"` ou `"innerText"`, captura o conteúdo textual visível do elemento (`innerText`).
25
+ - Para qualquer outra propriedade (como `"alt"`, `"title"`, `"id"`, `"name"`, `"src"`), captura o valor do atributo via `getAttribute()`.
26
+ 3. **Gerenciamento do Motor de Áudio**: Cancela leituras anteriores em andamento com `speechSynthesis.cancel()` para evitar sobreposição de vozes.
27
+ 4. **Instanciação e Configuração**: Cria um objeto `SpeechSynthesisUtterance` com o texto extraído e aplica as configurações de idioma (`lang`), velocidade (`rate`) e tom (`pitch`).
28
+ 5. **Execução**: Dispara a leitura com `window.speechSynthesis.speak()`.
29
+
30
+ ---
31
+
32
+ ## 📦 Código da Função
33
+
34
+ ```javascript
35
+ function lerElemento(seletorTag, propriedade, opcoes = {}) {
36
+ const elemento = document.querySelector(seletorTag);
37
+
38
+ if (!elemento) {
39
+ console.warn(`Elemento '${seletorTag}' não foi encontrado.`);
40
+ return;
41
+ }
42
+
43
+ let textoParaLer = "";
44
+
45
+ if (propriedade.toLowerCase() === "text" || propriedade.toLowerCase() === "innertext") {
46
+ textoParaLer = elemento.innerText || elemento.textContent;
47
+ } else {
48
+ textoParaLer = elemento.getAttribute(propriedade);
49
+ }
50
+
51
+ if (!textoParaLer) {
52
+ console.warn(`A propriedade/atributo '${propriedade}' não possui texto para leitura.`);
53
+ return;
54
+ }
55
+
56
+ if (window.speechSynthesis.speaking) {
57
+ window.speechSynthesis.cancel();
58
+ }
59
+
60
+ const mensagem = new SpeechSynthesisUtterance(textoParaLer);
61
+
62
+ mensagem.lang = opcoes.lang || "pt-BR";
63
+ mensagem.rate = opcoes.rate || 1.0;
64
+ mensagem.pitch = opcoes.pitch || 1.0;
65
+
66
+ window.speechSynthesis.speak(mensagem);
67
+ }
68
+ ```
69
+
70
+ ---
71
+
72
+ ## 💡 Exemplos de Uso
73
+
74
+ ### 1. Lendo o texto de um parágrafo
75
+ ```javascript
76
+ lerElemento("p", "text");
77
+ ```
78
+
79
+ ### 2. Lendo o atributo `alt` de uma imagem
80
+ ```javascript
81
+ lerElemento("img.avatar", "alt");
82
+ ```
83
+
84
+ ### 3. Lendo o atributo `title` de um botão
85
+ ```javascript
86
+ lerElemento("button#btn-salvar", "title");
87
+ ```
88
+
89
+ ### 4. Lendo o `name` de um campo de formulário
90
+ ```javascript
91
+ lerElemento("input[type='text']", "name");
92
+ ```
93
+
94
+ ### 5. Customizando idioma, velocidade e tom da fala
95
+ ```javascript
96
+ lerElemento("div.noticia", "text", {
97
+ lang: "pt-BR",
98
+ rate: 1.2,
99
+ pitch: 0.9
100
+ });
101
+ ```
102
+
103
+ ---
104
+
105
+ ## ⚙️ Propriedades e Opções
106
+
107
+ | Parâmetro | Tipo | Descrição | Padrão |
108
+ | :--- | :--- | :--- | :--- |
109
+ | `seletorTag` | `string` | Seletor CSS do elemento (`"p"`, `"#id"`, `".classe"`). | *Obrigatório* |
110
+ | `propriedade` | `string` | Atributo ou conteúdo a ser lido (`"text"`, `"alt"`, `"title"`, `"id"`, etc). | *Obrigatório* |
111
+ | `opcoes.lang` | `string` | Idioma da voz a ser utilizada pelo motor de fala. | `"pt-BR"` |
112
+ | `opcoes.rate` | `number` | Velocidade da fala (de `0.1` até `10`). | `1.0` |
113
+ | `opcoes.pitch` | `number` | Tom de frequência da voz (de `0` até `2`). | `1.0` |
114
+
115
+ ---
116
+
117
+ ## 📜 Selo de Autoria
118
+
119
+ ```text
120
+ ===================================================================
121
+ PROJETO jsTTS
122
+ Módulo de Leitura Nativa via Web Speech API
123
+ ===================================================================
124
+ Desenvolvido por: LUKASALMEIDA
125
+ Licença: MIT
126
+ Compatibilidade: Navegadores Modernos (Chrome, Edge, Firefox, Safari)
127
+ Motor de Voz: Nativo do Sistema Operacional (Windows/SAPI, macOS, Linux)
128
+ ===================================================================
129
+ ```
130
+
131
+ ---
132
+
133
+ ## 📄 Licença
134
+
135
+ Este projeto está sob a licença MIT. Sinta-se à vontade para usar, modificar e distribuir.
package/index.js ADDED
@@ -0,0 +1,33 @@
1
+ function lerElemento(seletorTag, propriedade, opcoes = {}) {
2
+ const elemento = document.querySelector(seletorTag);
3
+
4
+ if (!elemento) {
5
+ console.warn(`Elemento '${seletorTag}' não foi encontrado.`);
6
+ return;
7
+ }
8
+
9
+ let textoParaLer = "";
10
+
11
+ if (propriedade.toLowerCase() === "text" || propriedade.toLowerCase() === "innertext") {
12
+ textoParaLer = elemento.innerText || elemento.textContent;
13
+ } else {
14
+ textoParaLer = elemento.getAttribute(propriedade);
15
+ }
16
+
17
+ if (!textoParaLer) {
18
+ console.warn(`A propriedade/atributo '${propriedade}' não possui texto para leitura.`);
19
+ return;
20
+ }
21
+
22
+ if (window.speechSynthesis.speaking) {
23
+ window.speechSynthesis.cancel();
24
+ }
25
+
26
+ const mensagem = new SpeechSynthesisUtterance(textoParaLer);
27
+
28
+ mensagem.lang = opcoes.lang || "pt-BR";
29
+ mensagem.rate = opcoes.rate || 2.0;
30
+ mensagem.pitch = opcoes.pitch || 1.0;
31
+
32
+ window.speechSynthesis.speak(mensagem);
33
+ }
package/package.json ADDED
@@ -0,0 +1,22 @@
1
+ {
2
+ "name": "jstts-native",
3
+ "version": "1.0.0",
4
+ "description": "Biblioteca simplificada para conversão de texto em fala nativa do sistema operacional via Web Speech API.",
5
+ "main": "index.js",
6
+ "scripts": {
7
+ "test": "echo \"Sem testes configurados\""
8
+ },
9
+ "files": [
10
+ "index.js",
11
+ "README.md"
12
+ ],
13
+ "keywords": [
14
+ "tts",
15
+ "speech-synthesis",
16
+ "web-speech-api",
17
+ "accessibility",
18
+ "javascript"
19
+ ],
20
+ "author": "Lukas Almeida",
21
+ "license": "MIT"
22
+ }