Články v kategorii
- Instalace do webu - úvod 💡
- Instalace do známých platforem ⭐
- Přidání nového formuláře
- Webový konfigurátor - párování kolonek ⭐
- Webový konfigurátor - ovládací prvky
- Aplikace - párování kolonek
- 📍 Adresy - nastavení
- 💼 Firmy - nastavení
- ✉️ E-maily - nastavení
- 📞 Tel. čísla - nastavení
- 👤 Jména - nastavení
- Deaktivace/aktivace služeb ve formuláři
- Vzhled a chování Foxentry 🎨
- Javascriptové API
- ⚙️ Rest API
- Zjištění stavu validace formulářů
- Vlastní zpracování dat z validace - Callbacky
- Cookies 🍪
- Jak vymazat cache prohlížeče
Javascriptové API
Technická dokumentace na GitHubu
Kompletní technický popis metod, parametrů a příklady implementace pro vývojáře najdete v našem repozitáři na GitHubu: Foxentry Javascript-API v2.
Javascriptové API Foxentry v2 umožňuje ovládat validaci a našeptávání namapovaných vstupů přímo z vašeho vlastního kódu. Na rozdíl od standardní implementace nejste závislí pouze na automatickém chování knihovny, ale můžete si zvolit vlastní cestu, jak a kdy se mají data zpracovat.
Předpoklady pro použití
Aby vše správně fungovalo, musíte mít splněny dva základní body:
- Mít vytvořený projekt v administraci app.foxentry.com.
- Mít na svém webu správně vložený integrační javascriptový kód.
Spuštění po načtení projektu
Knihovna Foxentry v2 přichází s užitečnou globální funkcí onFoxentryProjectLoad. Pokud tuto funkci ve svém kódu nadefinujete, knihovna ji po svém úspěšném načtení automaticky zavolá. Je to ideální místo pro úvodní nastavení callbacků nebo kontrolu stavu knihovny.
function onFoxentryProjectLoad() {
console.warn("Foxentry v2 je připraveno k použití!");
}
Klíčové funkce API
Rozhraní Foxentry nabízí několik metod, které vám umožní pracovat s formuláři programově:
- Kontrola připravenosti: Pomocí metody
Foxentry.isReady()zjistíte, zda je knihovna plně načtená. - Ruční spuštění validace: Metoda
await Foxentry.validate()provede validaci nad namapovanými poli. Můžete ji spustit globálně, nebo jen nad konkrétním formulářem. - Získání stavu validace: Metoda
getValidationStatus()vrací aktuální stav polí – zda jsou validní, zda zrovna probíhá načítání a konkrétní chybové zprávy. - Nastavení callbacků: Metoda
setCallbacks()slouží k napojení vašich vlastních funkcí na výsledky validace (např. po úspěšném ověření e-mailu nebo adresy).
Tip pro migraci: Pokud přecházíte z verze v1, věnujte pozornost sekci "Migrace z v1 na v2" v GitHub dokumentaci. Došlo ke změnám v registraci callbacků a přejmenování některých validátorů.
