vlibras-player-webjs
Version:
Biblioteca JavaScript moderna para integração do VLibras Player com React, Vue, Angular e vanilla JS
95 lines • 2.87 kB
TypeScript
/**
* Presets prontos para casos de uso comuns do VLibras Player
* Simplifica a configuração para diferentes cenários
*/
import { PresetConfig } from '../../types/core.types';
/**
* Presets prontos para diferentes cenários de uso
*/
export declare class VLibrasPresets {
/**
* Preset para dicionários e catálogos de palavras
* - Não reproduz automaticamente
* - Mostra controles para o usuário
* - Permite repetir a animação
* - Mostra badge com a palavra
*/
static get dictionary(): PresetConfig;
/**
* Preset para jogos e quizzes
* - Reproduz automaticamente
* - Esconde controles
* - Esconde texto (modo quiz)
* - Callback quando termina
*/
static get quiz(): PresetConfig;
/**
* Preset para tutoriais e cursos
* - Reproduz automaticamente
* - Mostra progresso
* - Permite pular
* - Mostra legendas
*/
static get tutorial(): PresetConfig;
/**
* Preset para widgets compactos
* - Interface mínima
* - Tamanho pequeno
* - Controles essenciais apenas
*/
static get compact(): PresetConfig;
/**
* Preset para apresentações em tela cheia
* - Tamanho grande
* - Auto-escala
* - Seletor de qualidade
* - Interface completa
*/
static get presentation(): PresetConfig;
/**
* Preset para acessibilidade máxima
* - Todas as funcionalidades de acessibilidade ativadas
* - Navegação por teclado
* - Alto contraste
* - Anúncios para screen readers
*/
static get accessibility(): PresetConfig;
/**
* Preset para desenvolvimento e debug
* - Logs detalhados
* - Controles completos
* - Informações de debug
*/
static get development(): PresetConfig;
/**
* Aplica um preset ao player
*/
static apply(presetName: keyof typeof VLibrasPresets, customConfig?: Partial<PresetConfig>): PresetConfig;
/**
* Lista todos os presets disponíveis
*/
static list(): Array<{
name: string;
description: string;
}>;
/**
* Cria um preset customizado baseado em um existente
*/
static createCustom(basePreset: keyof typeof VLibrasPresets, customConfig: Partial<PresetConfig>): PresetConfig;
}
/**
* Função utilitária para usar presets de forma simples
*/
export declare function usePreset(presetName: keyof typeof VLibrasPresets, customConfig?: Partial<PresetConfig>): PresetConfig;
/**
* Hook para React (se estiver sendo usado)
*/
export declare function useVLibrasPreset(presetName: keyof typeof VLibrasPresets, customConfig?: Partial<PresetConfig>): {
config: PresetConfig;
preset: PresetConfig;
availablePresets: {
name: string;
description: string;
}[];
};
//# sourceMappingURL=VLibrasPresets.d.ts.map