browser-update-notifier
v1.0.1
Published
A lightweight, dependency-free browser update notification library
Readme
Browser Update Notifier
Tudo que você precisa para integrar o Browser Update Notifier.
1. Instalação
Adicione a biblioteca ao seu projeto via npm ou yarn:
yarn add browser-update-notifierOu use como módulo ES no seu bundler:
import BrowserUpdateNotifier from 'browser-update-notifier';2. Uso Básico
Chame BrowserUpdateNotifier.init() com as opções desejadas. A biblioteca detectará automaticamente o navegador do usuário e mostrará uma notificação se estiver desatualizado.
BrowserUpdateNotifier.init({
position: 'bottom-right',
delay: 2000,
dismissible: true,
theme: 'auto',
language: 'en-US',
});3. Todas as Opções
Toda opção é opcional. Os defaults funcionam bem para a maioria dos casos.
| Opção | Tipo | Padrão | Descrição |
| --- | --- | --- | --- |
| position | string | "bottom-left" | Posição: bottom-left, bottom-right, top-left, top-right |
| delay | number | 2000 | Milissegundos antes do popover aparecer |
| dismissible | boolean | true | Mostrar botões Dispensar e fechar (x) |
| dismissDays | number | 30 | Dias para ocultar após dispensar |
| threshold | number | 2 | Versões principais de atraso para ativar |
| theme | string | "auto" | Tema: dark, light ou auto (preferência do sistema) |
| language | string | "en-US" | Idioma: en-US ou pt-BR |
| minVersions | object | {} | Sobrescrever versão mais recente por navegador |
| forceShow | boolean | false | Mostrar sempre (para testes) |
4. Suporte a Idiomas
Defina a prop language para alterar o texto do popover. Atualmente suporta en-US (padrão) e pt-BR.
BrowserUpdateNotifier.init({
language: 'pt-BR', // or 'en-US'
});5. Tema
Defina a prop theme para "dark", "light" ou "auto" (padrão). auto segue a preferência do sistema do usuário.
BrowserUpdateNotifier.init({
theme: 'dark', // 'dark', 'light', or 'auto'
});6. Referência da API
init(config)
Inicializa o notificador. Aceita um objeto de configuração.
detect()
Retorna o nome e versão do navegador detectado, ou null para bots.
version
Retorna a string de versão da biblioteca.
