JS API Documentation
Feeling lost? Head to the JS APIs section of the docs to read more about using these packages in your Fliplet apps, components and themes.
Are you rather looking for our RESTful APIs for complex backend integrations? Jump to our documentation to read more.
Core
All your apps come with this pre-included set of useful core libraries to help you out doing the most common tasks such as reading information about the current app or screen.
Sample use cases
- Interact with the current screen and user
- Navigate the app to different screen
- Read and save data locally
Data Sources
Apps very frequently need to interact with dynamic data you manage. Use these JS APIs to read and write data from your app to your Data Sources.
Sample use cases
- Read and write data to a Data Source
- Integrate apps with data from DIS
- Create dynamic screens
Communicate
Send emails, texts and share URLs to users of your apps.
Sample use cases
- Send an email to your users
- Let the user compose an email
Encryption
Set up encryption and decryption for your apps.
Sample use cases
- Use a encrypted Data Source
- Integrate with data from DIS
All JS APIs you can use in apps
These JS APIs falls into the most common category and almost all apps, components and themes use at least one of them. All apps include fliplet-core
by default, and any other can easily be included on your app screens via Fliplet Studio.
- Audio (
fliplet-audio
) - Audio Player (
fliplet-audio-player
) - Barcode (
fliplet-barcode
) - Communicate (
fliplet-communicate
) - Content (
fliplet-content
) - Core (
fliplet-core
) - CSV (
fliplet-csv
) - Data Sources (
fliplet-datasources
) - Database (
fliplet-database
) - Encryption (
fliplet-encryption
) - Helper (
fliplet-helper
) - Gamify (
fliplet-gamify
) - Like Buttons (
fliplet-like:0.2
) (Beta) - Media (
fliplet-media
) - Notifications (
fliplet-notifications
) - OAuth2 (
fliplet-oauth2
) (Beta) - Payments (
fliplet-payments
) - Session (
fliplet-session
) - Studio UI (
fliplet-studio-ui
) - Themes (
fliplet-themes
) - Page (
fliplet-pages
) - UI
Fliplet Components
- Accordions
- Data Directory
- List (from data source)
- Form
- Chat
- Charts
- Push Notifications
- Interactive Graphics
- Email Verification
- Bottom icon bar menu
Third-party integrations
- Single Sign-on with SAML2
- Single Sign-on with OAuth2 (Coming soon)
Third-party libraries
Private JS APIs
These APIs are currently undocumented and reserved for internal use. They are usually available to components in the system hence don’t require the user to access them directly.
- App Submissions
- App Logs
- Chat
- Interact
- Menu
- Native
- Pages
- Runtime
- Security