RichTextView
O que o editor salvou
Aula 3: formulários
Revisão da validação no navegador, exercícios com rótulos e o atributo autocomplete em cada campo.
Entregas
Formulário de cadastro
Lista de conferência de acessibilidade
Envio até sexta-feira, pelo portal do aluno.
Detalhes em rivocode.com.br.
HTML de fora, sem o que não é texto
Texto colado de fora, com um link que não abre.
Vazio
Sem descrição.
import { RichTextView } from '@rivocode/ui/editor'Quando usar
Exibe o que o RichTextEditor salvou, com a mesma tipografia do editor:
título no tamanho do Heading, código no desenho do Code, link no do
Link. Vive em @rivocode/ui/editor, e não usa o Tiptap: a página que só
lê não carrega editor nenhum.
import { RichTextView } from '@rivocode/ui/editor'
<RichTextView value={lesson.description} empty="Sem descrição." />
Por que é seguro exibir
A peça não usa innerHTML. Ela lê o HTML com um leitor próprio, fica só com
os blocos e as marcas que o editor escreve (parágrafo, h2, h3, listas,
citação, bloco de código, linha, quebra, negrito, itálico, sublinhado,
tachado, código e link) e monta cada um como elemento React. O resto não tem
por onde entrar:
script,style,iframe,img,svge controle de formulário somem com o conteúdo.- Atributo nenhum atravessa: nem
style, nemclass, nemonclick. - Link só sai com
http,https,mailto,telou endereço relativo, e sempre comrel="noopener noreferrer nofollow".javascript:perde o endereço e fica só o texto. - Tag desconhecida (
span,div,font) sai do caminho e deixa o texto.
Por isso não há sanitizador a instalar. O cuidado que continua sendo seu é o
de qualquer HTML vindo do navegador: se ele for exibido por outro caminho
(e-mail, PDF, dangerouslySetInnerHTML), sanitize no servidor. A página do
RichTextEditor diz como.
HTML ou JSON
value aceita o HTML do onValueChange ou o JSON do onJsonChange, e os
dois desenham a mesma coisa.
<RichTextView value={lesson.descriptionJson} />
A peça roda no servidor: o leitor não depende de DOM, então a página renderizada no servidor já sai com o texto formatado no primeiro desenho.
O conversor que a peça usa para ler o HTML também é exportado:
htmlToRichTextJson(html) devolve o JSON do Tiptap, para migrar o que foi
salvo em HTML, mandar o texto ao app do celular ou ler por máquina. Ele mora em
@rivocode/ui/editor e não importa o Tiptap: quem chama só ele, ou só o
RichTextView, não paga pelo editor.
import { htmlToRichTextJson } from '@rivocode/ui/editor'
const json = htmlToRichTextJson(nota.descricaoHtml)
Ele lê o mesmo recorte que a peça desenha: os blocos e as marcas do editor, e
link só com endereço seguro. script, style, atributo on* e link
javascript: não chegam ao JSON. HTML vazio vira um documento com um parágrafo
vazio.
Vazio
null, string vazia e o <p></p> de um editor em branco não desenham nada.
Com empty, a peça desenha a frase no lugar, e marca a raiz com
data-empty:
<RichTextView value={lesson.description} empty={<Text tone="muted">Sem descrição.</Text>} />
Largura
O texto ocupa a largura que recebe. Para leitura corrida, limite pela classe:
className="max-w-prose".
Bloco de código não quebra linha: o que passa da largura rola de lado dentro do próprio bloco. Quando rola, o bloco vira parada de Tab com o nome "Bloco de código", para quem usa teclado alcançar o fim da linha com as setas.
Quando não usar
- Texto sem formatação é
Text. Uma observação salva de umTextareanão tem marca nenhuma para desenhar, e passar texto puro aqui transformaria quebra de linha em espaço. - Editar é
RichTextEditor, que já mostra o conteúdo formatado enquanto carrega. - Código, log ou retorno de API é
CodeBlock, que numera linha e copia.
No React Native
Traduz, no índice principal @rivocode/ui-native, com os mesmos value e empty. Lê o HTML do onValueChange e o JSON do onJsonChange do RichTextEditor pelo mesmo leitor do web, que é código puro compartilhado entre os dois pacotes: não há WebView, não há peer, e nada do conteúdo executa.
Cada bloco vira View e cada marca vira Text aninhado: o título é o Heading (e se anuncia como cabeçalho), a lista numerada começa do start salvo, a citação sai no tom apagado com a borda à esquerda, o bloco de código em fonte mono e selecionável, e o link é o Link, que abre pelo Linking e só com http, https, mailto, tel ou endereço relativo.
Não mora num subcaminho. No web ele sai de @rivocode/ui/editor porque divide o caminho com o editor; no celular não há editor, então não há peer a separar, e a peça vive junto do Text.
size e tone mudam o corpo do parágrafo, da lista e da citação (base e neutral por padrão), e classNames veste cada bloco: paragraph, heading, list, quote, code e rule.
O htmlToRichTextJson, que o web exporta de @rivocode/ui/editor para converter o HTML salvo no JSON do Tiptap, sai da raiz do nativo, ao lado do RichTextView, como lá ele sai ao lado do RichTextView. É conversão pura, a mesma função dos dois lados, e não cobra peer. Ele não entra no /pure porque o /pure dos dois pacotes tem os mesmos nomes, e no web ele mora no /editor.
API
| Prop | Tipo |
|---|---|
valueobrigatóriaO conteudo salvo: o HTML que o `onValueChange` do `RichTextEditor` entregou, ou o JSON do `onJsonChange`. | stringRichTextJsonnullundefined |
emptyO que aparece quando o conteudo nao tem texto: `null`, string vazia ou o `<p></p>` de um editor em branco. | ReactNode |
labelsOs textos da peca, para trocar o idioma: `code` e o nome que o leitor de tela ouve no bloco de codigo que rola de lado. | Partial<RichTextViewLabels> |
ref | Ref<HTMLDivElement> |
Além destas, a peça aceita className, style, id e children, repassados ao elemento de baixo.