| name | fliplet-js-api |
| description | The Fliplet client-side JavaScript API: every Fliplet.X namespace (Storage, User, Navigate, Profile, Communicate, Media, Notifications, UI, ...). |
Fliplet JavaScript API (Fliplet.*)
The Fliplet client-side JavaScript API: every Fliplet.X namespace (Storage, User, Navigate, Profile, Communicate, Media, Notifications, UI, ...).
Documentation
- JS API Documentation: Index of Fliplet's JavaScript APIs (Core, Data Sources, Media, UI, Communicate) for working with apps, screens, users, and components from custom code.
- Accordion component: The Accordion component supports query parameters to open specific accordions when linking to a screen.
- Charts component: Use the Charts JS API to retrieve chart instances on a screen and update their data, labels, and series at runtime.
- Chat JS APIs: Start conversations, list contacts, count unread messages, and modify chat rendering via Fliplet.Chat on screens that use the Chat layout component.
- Data Directory JS APIs: Hook into the Data Directory component to override its data source, transform entries, and run code before render or initialization on directory screens.
- Dynamic Container JS APIs: Bind a screen region to a data source query via Fliplet.DynamicContainer so the component renders a list of entries with bound expressions.
- Email Verification component: Use the Email Verification JS API to retrieve the component instance on a screen and trigger verification flows for a given email address.
- Form JS APIs: Populate fields, read values, react to validation, and submit programmatically via Fliplet.FormBuilder on screens that contain a Form component.
- Interactive Graphics JS APIs: Override marker data, preselect a marker or map, and respond to label clicks via Interactive Graphics component hooks on screens that use it.
- List (from Data Source) component: Configure templates, hooks, and query parameters for the List (from Data Source) component, which renders summary and detail views backed by a data source.
- List Repeater JS APIs: Render a list of data source entries inside a Dynamic Container via
Fliplet.ListRepeater, with hooks to modify rows before and after render.
- Login: Run custom code after a user authenticates or when a returning user's session is re-validated via the Login component's
login and sessionValidate hooks.
- Bottom Icon Bar menu component: Use a query parameter to highlight the active item when linking into a screen that uses the Bottom Icon Bar menu component.
- Push Notifications JS APIs: Prompt users to subscribe, read device push settings, fetch the subscription ID and token, and unsubscribe via Fliplet's push notifications JS API.
- Record container JS APIs: Render a single data source entry in a screen via Fliplet.RecordContainer, with hooks to modify the query and react when data is retrieved.
- Fliplet.AI: Build AI features with
Fliplet.AI — chat, completions, streaming, image generation, transcription, and embeddings via OpenAI or Google Gemini proxies.
- Fliplet.Analytics: Enable, disable, and check analytics tracking, and record custom app events and page views from JavaScript.
- Fliplet.API.request(): Make authenticated HTTP requests to Fliplet APIs with automatic URL construction, caching, offline queueing, and error handling.
- Fliplet.App: Retrieve the current app's public slug, build shareable screen URLs, and access app-level settings from JavaScript.
- Fliplet.Apps: List the Fliplet apps the current user can access, and filter between legacy V1 and modern V2 apps.
- Fliplet.User.Biometrics: Check biometric availability and verify users with Face ID, Touch ID, or fingerprint inside native Fliplet apps.
- Fliplet.Cache: Run async operations once and memoize their results, with optional expiry and background refresh.
- Fliplet.Encode: Encode strings as base64 and double-encode URL query parameters safely for transport.
- Fliplet.Env: Read environment variables such as
appId, appName, mode, and apiUrl from the current runtime.
- Fliplet.parseError(): Turn any error response or object into a human-readable message by scanning common error properties.
- Fliplet.Hooks: Register callbacks that run before or after key app events (e.g. form submit), with sync or async Promise handlers.
- Fliplet.Locale: Translate strings and format dates and numbers in Fliplet components via Fliplet.Locale, the T() shorthand, and translation.json files using i18next.
- Fliplet common functions: Utility helpers on the global
Fliplet object: Fliplet.compile() for templating and Fliplet.guid() for unique IDs.
- Fliplet.Modal: Show confirmation, alert, and prompt dialogs from widget interfaces in Fliplet Studio via
Fliplet.Modal, powered by Bootbox.
- Fliplet.Navigate: Navigate between app screens, open external URLs, pass query parameters, and handle back, home, and modal navigation via Fliplet.Navigate.
- Fliplet.Navigator: Detect online/offline state, listen for connectivity changes, and wait for the device to be ready.
- Fliplet.Navigator.Notifications: Check notification support, request permission, and send local device notifications from JavaScript.
- Fliplet.Organizations: List the current user's organizations and fetch audit logs with filters for type, date range, app, and session.
- Fliplet Core overview: Fliplet Core is the JS library bundled into every app screen — storage, navigation, user, API, and dozens of device helpers.
- Fliplet.Profile: Read and write namespaced user profile attributes (email, name, company, phone) and fetch the device UUID.
- Fliplet.Registry: Store and retrieve runtime values and functions by key so components can share state and helpers.
- Fliplet.require: Load scripts and stylesheets on demand, and resolve lazy dependencies registered in the app bundle.
- Fliplet.Pages and Fliplet.Page: List app screens, get the current screen's public URL, and build shareable URLs for any screen by ID.
- Fliplet.Storage and Fliplet.App.Storage: Persist JSON-serializable values to device or browser storage, scoped globally or to the current app.
- Fliplet.Studio: Emit events to Fliplet Studio and listen for events from it when building widget interfaces.
- Fliplet.User: Get and set the current user's auth token, profile details, and preferences, and sign the user out.
- Fliplet.Widget: Access widget instance IDs, settings, and data, and coordinate save and ready events between widget and interface.
- fliplet-analytics-spa: Auto page-view tracker for V3 SPA apps. Hooks the History API so every client-side route change emits a pageView — no app code required.
- Fliplet.App.Submissions: Read App Store and Google Play submission metadata for the current Fliplet app — version, status, build numbers — via the fliplet-app-submissions package.
- Fliplet.Media.Audio.Player: Embed an audio player UI in a screen by tagging HTML elements with audio URLs; the framework auto-initializes players on screen load.
- Fliplet.Media.Audio: Play, pause, stop, and seek audio files on device or from a URL in Fliplet apps via the Audio namespace.
- Fliplet.Barcode: Scan QR codes and 1D/2D barcodes from the camera on web and native (attachScanner / scan) and generate barcode images, via the fliplet-barcode package.
- Fliplet.Chat: Build one-to-one, group, and public-channel chat features. Fliplet.Chat owns the conversations and messages data sources internally — supply only the contacts list (who can chat with whom).
- Fliplet.Communicate: Send email, SMS, push notifications, and share URLs from a Fliplet app using a single Communicate namespace.
- Fliplet.Content(): Create, query, update, and delete shared content records (bookmarks, likes, saved searches) backed by a data source via Fliplet.Content.
- Fliplet.CSV: Encode and decode CSV in Fliplet apps via the fliplet-csv package.
- Fliplet.Database: Low-level helper for reading and querying JSON data from a local file as a database; used internally by Fliplet.DataSources.
- Fliplet.DataSources.Encryption: Automatically encrypt and decrypt selected Data Source columns on-device by registering a private key and column list.
- fliplet-error-tracking: Auto-loading runtime that captures JavaScript exceptions and unhandled promise rejections and batches them to Fliplet.App.Logs.
- Fliplet.Gamify: Configure gamification with logs, variables, and achievements via Fliplet.Gamify; track points, milestones, and badges backed by a data source per user.
- Fliplet.Media: Browse folders, upload and manage files, and download media to devices via the Fliplet Media namespace.
- Fliplet.Native: Cordova-bridge APIs for native Fliplet apps — app management, updates, downloads, locale, notifications, status bar, and lifecycle interactions.
- Fliplet.Native.Downloads: Native asset download orchestrator for Fliplet apps — manages app-bundle downloads with concurrency, retries, incremental updates, and progress tracking.
- Fliplet.Native.Maintenance: File-system abstraction layer for Cordova: read, write, copy, move, delete, unzip, directory ops. The plumbing under Fliplet.Native.Downloads and Fliplet.Native.Updates.
- Fliplet.Notifications: Read, send, and schedule in-app and push notifications in Fliplet apps, with support for scopes, read receipts, and badge counts.
- Fliplet.Page: Utilities for interacting with the current Fliplet screen — including smooth-scrolling to an element with configurable duration and offsets.
- Fliplet.Payments: Accept Stripe payments and checkout in Fliplet apps via Fliplet.Payments, with a products data source and webhook-driven order tracking.
- Fliplet.Profile.Content(): Create, query, update, and delete user-attributed content records in a data source so each user only sees their own entries via Fliplet.Profile.Content.
- Fliplet Router JS API: Fliplet.Router JS API reference for V3 apps. Covers getBasePath, isNative, getHistoryMode (platform-conditional history — path on web, hash on native), getRouteManifest, getRouteConfig, and resolveRo…
- fliplet-runtime: V3 SPA bootstrap that wires Fliplet.Env, Registry, Studio, Navigator, and Locale into the global Fliplet object and manages the page-ready lifecycle.
- Fliplet.Security: Persist a per-app structured object to encrypted device storage via the fliplet-security package — for app-local secrets, device tokens, and per-user preferences. Distinct from fliplet-encryption (Da…
- fliplet-service-worker: Background service worker that receives web push notifications, displays them, and marks them read — automatically registered by fliplet-core on web.
- Fliplet.Session: Read, write, and clear the current user session — including cached offline sessions — for authentication state in Fliplet apps.
- Fliplet.Socket: Real-time WebSocket connection to the Fliplet API with auto-authentication, server URL discovery, and dev/prod transport fallback via the fliplet-socket package.
- Fliplet.UI.Table: Render searchable, sortable tables with pagination, row selection, expandable rows, and custom cell rendering via
Fliplet.UI.Table.
- Fliplet.App.Tokens: Read the list of API tokens that authorise external services and backend integrations to call Fliplet APIs on behalf of an app.
- Fliplet.UI.Actions(): Show a native-style action sheet with a title, labeled options, and a cancel button, resolving with the chosen index via Fliplet.UI.Actions.
- Fliplet.UI.AddressField(): Add a Google Maps autocomplete address field to a screen via
Fliplet.UI.AddressField() to search, select, and retrieve location details.
- Fliplet.UI.DatePicker(): Render a date picker input with optional preset value, required flag, and get/set/change methods via Fliplet.UI.DatePicker.
- Fliplet.UI.DateRange(): Render a paired start/end date range input with required flag, default value, and get/set/change methods via Fliplet.UI.DateRange.
- Fliplet.UI.NumberInput(): Render a numeric input with required flag, preset value, and get/set/change methods for reading user-entered numbers via Fliplet.UI.NumberInput.
- Fliplet.UI.PanZoom: Pan, zoom, and place markers on images or interactive graphics via
Fliplet.UI.PanZoom, with pinch, mouse wheel, and double-tap support.
- Fliplet.UI.RangeSlider(): Render a range slider input with min, max, step, and default value, plus get/set/change methods via Fliplet.UI.RangeSlider.
- Fliplet.UI.TimePicker(): Render a time picker input in 24-hour HH:mm format with required flag and get/set/change methods via Fliplet.UI.TimePicker.
- Fliplet.UI.TimeRange(): Render a paired start/end time range input in HH:mm format with required flag, default value, and get/set/change methods via Fliplet.UI.TimeRange.
- Fliplet.UI.Toast.error(): Parse an error object and show a toast with a friendly initial message plus a button to reveal the detailed technical error via Fliplet.UI.Toast.error.
- Fliplet.UI.Toast(): Show minimal or regular auto-dismissing toast notifications with title, message, position, duration, progress bar, and action buttons via Fliplet.UI.Toast.
- Fliplet.UI.Typeahead(): Render a typeahead input with real-time suggestions, free-input toggle, max items, and get/set/change methods via Fliplet.UI.Typeahead.
- Fliplet.UI: Fliplet-managed UI primitives — toasts, action sheets, modals, date/time pickers, typeahead, tables, panzoom — under the Fliplet.UI namespace.
- Using Handlebars in your apps: Use Handlebars 2.15.2 in Fliplet app screens for templating, with built-in helpers for images, dates, auth URLs, JSON, and conditional comparisons.
- LikeButton: Embed a one-tap like button on any screen element, backed by a Data Source that records likes per content ID.
- Data Source provider: The Data Source provider lets users pick or create a data source for a component, including default columns, entries, and access rules.
- Email provider: Compose email templates (subject, body, recipients, headers) in a reusable provider UI for sending via
Fliplet.Communicate.sendEmail().
- File Picker provider: The File Picker provider lets users select one or more files from Fliplet's File Manager, optionally scoped by file type or restricted to single-select.
- Link Action provider: Configure link actions (navigate to screen, open URL, document, video, or run JS) in a reusable provider UI executable via
Fliplet.Navigate.to().
- V3 app analytics and event tracking: V3 app analytics and event tracking. Page views are tracked automatically by the fliplet-analytics-spa runtime; this doc covers what you get for free and when to add event() calls for intent-bearing…
- V3 app bootstrap constraints: The four constraints every V3 boot HTML must satisfy. Covers Fliplet.require.lazy for dependencies, Fliplet.Media.getContents for source files, the Fliplet().then(...) init sequence, and the locked v…
- V3 App Settings Convention: V3 app settings convention for storing public and private configuration. Covers the underscore prefix convention for editor-private settings.
- V3 Authentication Patterns: V3 authentication patterns for email/password login, session management, logout, and protected routes. Use these patterns when building authentication flows in V3 apps.
- V3 barcodes: Scan and generate QR codes and barcodes in V3 apps with Fliplet.Barcode — attachScanner() to scan (web + native) and encode() to render barcode images.
- V3 Alpine.js apps: Constraints for building V3 apps in Alpine.js. Alpine is attribute-driven HTML with no build step, so it maps cleanly to the V3 runtime. Covers x-init timing relative to Fliplet().then and platform-c…
- V3 framework guide — picking and setup: Picking a frontend framework for a V3 app. Lists the runtime constraints every framework must cope with (no build step, no bundler, no transpile) and compares Vue, React, Alpine, and vanilla JS again…
- V3 React apps: Constraints for building V3 apps in React. Covers the JSX transpilation problem (the #1 cause of first-deploy failures) with three alternatives, React Router 6 createHashRouter wiring (no basename —…
- V3 vanilla-JS apps: Constraints for building V3 apps in vanilla JavaScript. The simplest baseline — no framework deps to load, no transpile traps. Covers platform-conditional routing (History API + Fliplet.Router.getBas…
- V3 Vue apps: Constraints for building V3 apps in Vue 3. Covers the runtime-compiler vs runtime-only build choice, the .vue single-file-component tradeoff without a loader, and the platform-conditional Vue Router…
- V3 media: Capture or select a photo and upload files in V3 apps with Fliplet.Media — capture() to take or pick a photo (web + native) and Files.upload() to store it and get a URL back.
- V3 routing: Canonical routing patterns for V3 SPA apps. Covers base path, route manifest, access guard, per-framework examples, and the full list of forbidden patterns that break V3 apps.
- Fliplet-approved JavaScript libraries (coding-standards edition): The JavaScript libraries Fliplet pre-approves for app development, why you should prefer them over custom ones, and when to reach for each.
- Fliplet API patterns and categories: Overview of the main Fliplet JS API categories (Data Sources, Users, Media, Navigation) and when to pick each one.
- Fliplet-approved JavaScript libraries (reference list): Reference list of every JavaScript library Fliplet pre-approves in apps, including versions and optional add-on libraries.
- Fliplet SDK: Load Fliplet JS APIs on any external website via sdk.js with an auth token and optional comma-separated package list (e.g. fliplet-media, fliplet-datasources).
- The Fliplet JavaScript APIs: How the Fliplet JS APIs (SDK, not a framework) let you interact with data, screens, users, and components from Studio custom code, themes, and widgets.
How to load full content
The URLs above are raw .md and can be fetched directly. To search across all Fliplet developer docs, use the MCP server at https://developers.fliplet.com/mcp (tools: search_fliplet_docs, fetch_fliplet_doc), or fetch https://developers.fliplet.com/.well-known/llms-full.txt for the entire site as a single stream.
