BabelShark Knowledge Base
  • Introduction
  • BabelShark basics
    • Getting started
    • Project modes
    • Project languages
    • Code snippets
    • Source string markup
    • Setting visitor's language
    • Project associated texts
  • Setup
    • Recommended approach
    • Coexistence with other translators
    • Scopes
    • Performance
  • FAQ
  • Site owner's manual
    • Introduction
    • Real-time language statistics
    • Working in a team
  • Developer's manual
    • Embed BabelShark script
    • API Reference
      • BabelShark config
      • Language drop-down specs
    • HTML markup
      • Variables
      • Issues
    • Integrations
      • Tilda Publishing
        • Tilda website setup
        • Elements to localize
  • Manager's manual
    • Introduction
    • Community proofreaders
  • Proofreader's manual
    • Introduction
    • How to proofread
    • Checking translations
    • Translation types
    • Request of re-checks
Powered by GitBook
On this page
  1. Developer's manual
  2. API Reference

BabelShark config

babelSharkConfig global variable is being used by BabelShark embed script to configure the behavior of the translation engine.

This object has to be set before loading babelshark.js script. The minimal configuration is the following:

<script>
window.babelSharkConfig = {
	projectId: 1000,
	accessCode: "..."
};
</script>

...

<script defer src="https://cdn.babelshark.net/static/babelshark-embed/babelshark.js"></script>

Configuration options

The complete TypeScript interface for configuration object is:

interface BabelSharkConfig {
	// Project ID
	projectId: number;
	// _Public_ access code for the embedded script
	accessCode: string;

	// Optional flag to detect language automatically using navigator.language
	detectLanguage?: boolean;
	// Optional flag to pick language from query string parameter
	detectFromQueryString?: string;	

	// Callback to be called when BabelShark is initialized
	onLoaded?: (instance: BabelShark) => void;
	
	// The instance of BabelShark currently running (set on script load)
	instance?: BabelShark;
}
PreviousAPI ReferenceNextLanguage drop-down specs

Last updated 1 year ago