TOADVAR

A variável __TOAD__

Uma das nossas regras é "Não misture HTML com JavaScript", e com isso queremos dizer que você não deve incluir nenhum código JavaScript nas páginas HTML. Porém tudo deve ser dosado, e por isso abrimos uma exceção.

Toda aplicação jQuery TOAD requer que antes de chamar a biblioteca jquery-toad.js em si, precisa-se definir qual será o nome do módulo principal, onde estarão aninhados todos os outros módulos, e isso é feito definindo uma variável global chamada __TOAD__.

<script>
    var __TOAD__ = "MYAPP"
</script>

O nome que for definido aqui ditará como serão construídos os demais scripts, pois tudo será acessado à partir dessa variável global. Isso também corrobora com nosso outro objetivo, "Modularize", visto que se trata de um módulo principal.

Ex:

MYAPP.namespace(/*...*/)

Tanto os objetos da própria biblioteca jQuery TOAD quanto os objetos da aplicação que está sendo desenvolvida serão acessados à partir desse módulo inicial.

Durante um tempo consideramos disponibilizar uma variável global, tipo $toad, assim como a própria jQuery faz com o uso de $, AngularJS faz com angular, ou Vue faz com Vue.

PS: Aqui não estamos falando de UMD, AMD, CommonJS & Cia. Depois falamos disso.

Pensamos em até usar algo como App ou $App, e até ClientApp, porque consideramos que se por um lado teríamos o módulo da própria jQuery TOAD a aplicação em si também poderia ter o seu próprio espaço de nomes.

Por fim, entendemos que o nome da aplicação tem muito significado quando estamos lendo o código, e como a nossa proposta é de simplesmente auxiliar no desenvolvimento da sua aplicação, preferimos ficar como coadjuvante. Então deixamos você dizer que nome prefere para sua aplicação, e então preparamos o mínimo necessário de utilitários que você precisará e o resto é contigo.

Como resultado, nós temos uma forma bem simples pra desenvolver nossa aplicação, visto que o ponto central já está definido.

Um exemplo: Caso você queira acessar um utilitário que a própria jQuery TOAD disponibiliza como a função setPageTitle (que define o título da página) ou um outro utilitário que você mesmo definiu, você fará isso da mesma forma:

var utils = MYAPP.import('utils');

utils.setPageTitle('');
utils.myMethod();

Isso é bom porque o foco é sua aplicação, então deixamos tudo em volta dela. Você só precisa saber que sem definir essa variável a jQuery TOAD se recusará a continuar.

Você pode definir qualquer string válida para o nome de sua aplicação, mas recomendamos um nome curto e significativo, como o nome de sua aplicação ou sigla dela, e apesar de não fazer diferença, sugerimos usar tudo em maiúsculo (só pra esse nome). É só uma sugestão porque achamos bonito, mas você é quem manda.