Preview
Componente de pré-visualização on-line para arquivos docx, pptx, pdf e xlsx.
Use quando precisar pré-visualizar arquivos
docx,pptx,xlsxno navegador. O<r-preview>abre um diálogo de pré-visualização a partir da URL de um arquivo (agora publicado como o pacote independente@ranui/preview).
⚠️ Aviso importante: o pacote ranui deixará de fornecer este componente a partir da versão 0.1.10-alpha-27. Migre para o pacote independente @ranui/preview.
Início rápido
Instalação
# Use o pacote de pré-visualização independente (recomendado)
npm install @ranui/preview
# Ou o pacote ranui completo (antes da versão 0.1.10-alpha-27)
npm install ranuiUso básico
<r-preview id="preview-demo"></r-preview>
<r-button type="primary" onclick="uploadFile()">Escolher arquivo para pré-visualizar</r-button>
<script>
let selectedUrl;
const uploadFile = () => {
const preview = document.getElementById('preview-demo');
const input = document.createElement('input');
input.setAttribute('type', 'file');
input.setAttribute('accept', '.docx,.pptx,.pdf,.xlsx,.xls');
input.click();
input.onchange = (e) => {
const { files = [] } = input;
if (files.length > 0) {
const file = files[0];
if (selectedUrl) URL.revokeObjectURL(selectedUrl);
selectedUrl = URL.createObjectURL(file);
preview.setAttribute('src', selectedUrl);
}
};
};
window.addEventListener('pagehide', (event) => {
if (!event.persisted && selectedUrl) URL.revokeObjectURL(selectedUrl);
});
</script>Referência da API
Propriedades
| Atributo / propriedade | Tipo | Padrão | Descrição |
|---|---|---|---|
src |
string |
— | URL do arquivo; ao defini-la, abre o diálogo |
closeable |
string |
— | A string false desativa o botão de fechar e Escape |
baseUrl / baseurl |
string |
https://edit.chaxus.com |
URL da página do editor do Office |
readonly |
boolean |
false |
Modo opcional de somente leitura para Office |
pdf-mode / pdfMode |
string |
eager |
Modo PDF: eager ou virtual |
label |
string |
Preview file |
Nome acessível do acionador |
Origem do arquivo src
Defina a URL do arquivo para abrir o diálogo de pré-visualização; um valor vazio não o exibe.
<r-preview src="https://example.com/document.docx"></r-preview>Fechamento closeable
Controla se o diálogo de pré-visualização pode ser fechado.
<!-- Pode ser fechado (padrão) -->
<r-preview closeable="true"></r-preview>
<!-- Não pode ser fechado -->
<r-preview closeable="false"></r-preview>Serviço próprio baseUrl
Quando quiser usar o seu próprio serviço de pré-visualização de documentos, informe o endereço dele pela propriedade baseUrl.
<r-preview baseUrl="https://edit.chaxus.com"></r-preview>💡 Dica: por padrão usa-se o serviço hospedado em
https://edit.chaxus.com. Para hospedá-lo você mesmo, veja OnlyOffice Web Local.
Compatibilidade com 0.3.0
0.3.0 mantém o registro automático e a edição de Office por padrão. No modo PDF padrão eager, load ocorre após todas as páginas serem desenhadas. Com pdf-mode="virtual" (JavaScript: pdfMode = 'virtual'), a área visível é renderizada; load indica que a primeira visualização e seu buffer estão prontos. O worker permanece ativo até fechar, trocar a origem ou remover o elemento. Alterar readonly ou closeable preserva o editor de Office e as edições não salvas.
<r-preview pdf-mode="virtual" src="/reports/long.pdf"></r-preview>
<r-preview readonly src="/reports/annual.docx"></r-preview>Os PDFs são renderizados localmente. Os arquivos de Office são enviados ao iframe do editor configurado, cuja página pode acessar o conteúdo. Use sua própria implantação baseUrl para documentos privados ou de intranet.
Guia de migração
Se você usa hoje o componente r-preview do pacote ranui, recomendamos migrar assim:
Instale o pacote novo:
npm install @ranui/previewAtualize os imports:
// Antes import 'ranui'; // Agora import '@ranui/preview';O uso em HTML continua o mesmo:
<r-preview src="your-file-url"></r-preview>