Appfarm Documentation
Getting startedDocumentationCommunityAppfarm Create
  • Overview
  • Getting Started
    • What is Appfarm?
    • Key concepts
    • Quickstart
      • Speed intro
      • Step-by-step guide
    • Appfarm Showroom
    • FAQ
  • Appcademy
    • Learning paths
    • Appfarm Fundamentals
      • Intro Course
        • 1. Intro to No-Code and Appfarm
        • 2. Navigation in Appfarm Create
        • 3. What is Apps?
        • 4. Intro to UI Editor
        • 5. Data Model
        • 6. App Data
        • 7. Actions
        • 8. Tips and Tricks
        • 9. Intro to practical walkthrough
        • 10. Create a details view of a Project
        • 11. Create a Custom List
        • 12. Swipe and Delete
        • 13. Functionality for simple Create of Data
        • 14. Upload and Download Photos
        • 15. Input Dialog with Validation and Save
        • 16. Dashboard
        • 17. Summary
        • Quiz
      • User Interface Fundamentals
        • Container - Sectioning, Styling and Repeating
        • Conditional Styles
        • Motions
        • Responsive Design
        • Step-by-step workflow
        • Featured UI Components
        • Quiz
      • App Data Fundamentals
        • Data Source Filtering
        • App Variables and Runtime Properties
        • URL Parameters
        • Quiz
      • Actions & Logic Fundamentals
        • Event Handlers
        • Featured Action Nodes
        • Context Parameters
        • Quiz
      • Services Fundamentals
        • Introduction to Services
        • Setting up a Service
        • Scheduling a Service
      • Integration Fundamentals
        • The web request action node
        • Fetch data from an endpoint
        • Map data to a data source
        • Modify the response
        • Nested data mapping
        • Path parameters
        • Authentication
        • Send data to an endpoint
        • Quiz
      • User handling and permissions
        • Users and roles
        • Permissions
        • Creating users
        • Extending the User object class
        • Updating and deleting users
        • Unauthenticated access
        • Quiz
    • Appfarm Professional
      • User Interfaces
        • Featured UI Components
        • Concepts and Use Cases
      • Data Structures & Data Handling
        • Data Features
        • Search & Filters
        • Featured Action Nodes
        • GraphQL
      • Logic & Flow
        • Logical Concepts
        • Date and Time Handling
        • Featured Action Nodes
        • Exception Handling
      • Login & Configuration
        • Login and Authentication
        • Settings, Configuration and Languages
      • Security & Operations
        • Security and Permissions
        • Deployment
        • Schedules and Logs
        • Debugging and App Health
      • Performance & Optimization
        • Optimizing Performance
        • Enhancing Functionality
    • Appfarm Sales Representative
    • Appfarm Developer Forum
      • Session 1: Data Modeling in Appfarm Create
      • Session 2: App Data in Appfarm Create
      • Session 3: Services in Appfarm Create
      • Session 4: Optimizing Performance
    • Background
      • Databases
        • Data modeling 101
        • Database normalization
  • Library
    • UI components
      • Advanced bar chart
      • Advanced bubble chart
      • Advanced combined chart
      • Advanced gantt chart
      • Advanced heatmap chart
      • Advanced line/area chart
      • Advanced pie chart
      • Advanced scatter plot chart
      • Advanced solid gauge chart
      • Animated component
      • Avatar
      • Avatar group
      • Basic bar chart
      • Basic gauge chart
      • Basic line chart
      • Basic pie chart
      • Bottom navigation
      • Button
      • Checkbox
      • Chip group
      • Circular progress
      • Coded component
      • Container
      • Date & time picker
      • Drawable canvas
      • Floating action button
      • Icon
      • Icon button
      • Iframe
      • Image
      • Linear progress
      • List
      • Map
      • Menu list
      • Multi select
      • PDF reader
      • Popover
      • Radio buttons
      • Rich text editor
      • Rich text
      • Select
      • Slider
      • Speed dial
      • Switch
      • Table
      • Tabs
      • Text
      • Text edit
      • View container
      • Visibility group
    • Action nodes
      • Aggregate data
      • Advanced search
      • Auth operations
      • Block
      • Catch exception
      • Copy to clipboard
      • Create file archive
      • Create file object
      • Create object
      • Create user account
      • Delete objects
      • Delete user account
      • Duplicate objects
      • End execution
      • Exit block
      • Exit loop
      • Export data
      • Foreach
      • Generate document
      • If
      • Import data
      • Invalidate cache
      • Log in
      • Log to console
      • Log out
      • Next iteration
      • Navigate
      • Open/close popover
      • Open confirm dialog
      • Open print dialog
      • Open snackbar
      • Open Unsplash dialog
      • Open URL
      • Persist objects
      • Push notifications
      • Read objects
      • Request permissions
      • Run code
      • Run other action
      • Run service
      • Scan barcode/QR code
      • Send email
      • Send SMS
      • Set client language
      • Set data source attributes
      • Set selection
      • Set theme
      • Set user account image
      • Show install app prompt
      • Sleep
      • Sort objects
      • Throw exception
      • Toggle drawer
      • Update object
      • Update secret
      • Update user account
      • Web request
      • While
  • Reference
    • Appfarm Create
      • Appfarm Commander
      • Blue dots
      • Copy & Paste
      • Farmer's Market
      • Find references
      • Find usage
      • Keyboard shortcuts
      • Undo/Redo
      • User preferences
    • Platform concepts
      • Conditions
      • Data bindings
      • Date and time
      • Event handlers
      • Filters
      • Functions
      • Markdown
      • Objects
      • Operators
      • Value processor
    • Dashboard
    • Apps
      • UI
        • Views
          • Dialog
          • Drawer
        • Layout designer
        • Component properties
        • Shareable UI components
      • Data
        • App variables
        • Data sources
        • Calendar data sources
      • Actions
      • App settings
      • App size
      • App health
    • Services
      • Service Endpoints
      • Service settings
      • Service health
      • API explorer
    • Data model
      • Object classes
      • Object class properties
      • Enumerated types
      • GraphQL
        • Queries
        • Mutations
      • Data Extract API
      • Time series data
    • Operations
      • Deploy
      • Schedules
      • Logs
    • Resources
      • Themes
      • Files
      • Fonts
      • Internationalization
    • Configuration
      • Environments
      • Login
        • Custom auth providers
    • Security
      • Users
      • Service accounts
      • Roles
      • Secrets
      • Permissions
        • Conditional Permissions
    • Appfarm Client
      • Developer tools for Apps
      • Developer tools for Services
      • Warnings and errors
  • How to
    • Data modeling
      • Many-to-many relationships
      • Use naming conventions
      • Offline data handling
      • Data silos and White labelling
    • User interface
      • Manage a many-to-many relationship with a Chip group
      • Configure drag and drop
      • Build a drag-and-drop calendar
      • Design a responsive layout
      • Work with flexbox
      • Use Mapbox as a map layer
      • Understand charts
    • Logic and flow
      • Event Log Design
      • Configure advanced search
    • Themes and styling
      • Change the active theme
      • Add custom email templates
    • Enhance your app
      • Add deep links
      • Add keyboard shortcuts
      • Add link previews for social media
      • Apply SEO best practices
      • Change the active language
      • Generate a PDF from a Container
    • Integrations
      • Integrate with external systems
      • Integrate with OpenAI
      • Integrate with Google Analytics (GA4)
      • Configure a custom email account
      • Integrate with a payment provider
      • Integrate with Signicat
      • Integrate directly with an external database
      • Retrieve a Bearer token from Google Cloud
      • Fetch data from BigQuery
      • Retrieve access token from Microsoft Entra ID
    • Workflow automation
      • Update an OAuth 2.0 access token from a service
    • Authentication and access control
      • Add users and assign roles
      • Configure unauthenticated access
      • Implement third-party authentication
    • Security, testing and deployment
      • Add a custom domain
      • Install an app on a device
      • Get ready for Production
      • Optimize performance
      • Security checklist
      • Test and debug
    • Example apps
      • Create an Instagram clone
        • The end result
        • Designing the feed
        • Create new post
        • Add a like-button
        • Add comment-functionality
  • Solution administration
    • Subscription and billing
    • Dedicated tier benefits
    • Guide to GDPR
      • Key principles
      • How Appfarm protects personal data
      • How you can protect your clients’ data
      • Glossary
    • Appfarm and the EU AI Act
  • Policies
    • Appfarm Policies
    • Data Processors
    • Privacy Policy
Powered by GitBook
On this page
  • General properties
  • App bar
  • Actions
  • Keyboard event handlers
  • Event handlers

Was this helpful?

Export as PDF
  1. Reference
  2. Apps
  3. UI

Views

PreviousUINextDialog

Last updated 8 months ago

Was this helpful?

Views are the primary interface in an app. A view can be thought of as a page or screen that serves a specific purpose, such as displaying data, or creating new items. Each view has a unique URL path that can be accessed in the app by using the or by directly accessing the URL. When you create a new app, a is automatically created.

There are also and , which are types of views that can be used in the context of a primary view.

General properties

Property
Description

Name

An descriptive name for the view. This is used as a reference throughout Appfarm Create.

URL Path Key

A slug to use in the view's public URL. For example, in the following app URL the URL Path Key is my-events: https://thirty50.appfarm.app/events/my-events. It is recommended to provide a value that describes the purpose of the view. The value must consist only of valid URL characters. Illegal characters will be automatically removed. If not provided, an automatically generated technical ID will be used instead.

App bar

An app bar is a toolbar located at the top of the view used to display information and actions relating to the current view.

Property
Description

Enable App Bar

Display an app bar.

Title

The primary label for the app bar.

Sub Title

A secondary label placed under the Title.

Left Actions

Right Actions

Color

Background Image

An image to use as the background of the app bar.

Visual Overlay

Available when Color is Transparent or a Background Image is selected. Add an overlay to emphasize content and to tone down a background image.

Overlay Type

Available when Visual Overlay is selected. The overlay type to apply, either Dark or Light.

Overlay Transparency

Available when Visual Overlay is selected. The amount of transparency to apply. 0% will not have any impact will 100% will completely cover the background image or color.

Content Color

The color applied to text, buttons, and icons. The default color is Inherit, which in this case will apply sensible colors from the active theme based on the chosen Color.

Elevation

The amount of drop shadow to apply. A value of 0 will remove all drop shadow. The default value is 1.

Dense

Reduce the height of the app bar. Only recommended for use on Large devices such as desktops.

Keyboard Event Handlers

Actions

Actions are buttons that can be added to either the left or right side of the app bar. On the left side, only one button can be displayed at a time. On the right side, buttons can be displayed side-by-side or in a dropdown menu.

General properties

Property
Description

Name

A descriptive name for the button. Displayed only in Appfarm Create.

Variant

The type of button to display, either an Icon Button or a Button.

Label

Depending on the selected Variant, used either as the tooltip for an Icon button or as the label for a Button. If Overflow Menu is selected, this will be used as the label for the menu item.

Icon

An icon from the built-in icon library.

Icon Value

Button Variant

Available when Variant is Button. The appearance of the button.

Button Color

Available when Variant is Button. The color of the button.

Overflow Menu

Display the button in a dropdown menu at the far right of the app bar.

Visible

Bind a value or condition to determine if the button should be displayed or not.

Disabled

Bind a value or condition to determine if the button should be disabled or not.

Badge

Property
Description

Enable Badge

Display a badge in the top-right corner of the button.

Value

The value to display inside the badge. Usually a number.

Variant

The appearance of the badge. The options are: - Standard where the Value is rendered inside the badge. - Dot where a small filled-in circle is shown without a value.

Color

The color of the badge.

Max Value

The highest Value that will be displayed. If Value execeds this number, a "+" will be shown after the value.

Event handlers

Property
Description

On Click

Triggered when the button is clicked.

Keyboard event handlers

Draft feature

Draft features are in early development and may crash your solution. Functionality may stop working or crash your solution when Appfarm Create is updated.

Property
Description

Key Binding

The string representing the key presses that will trigger the Action. Use + to combine multiple key bindings. For example, to set a key binding when ctrl and a are pressed simultaneously, the value would be ctrl+a.

Supported modifier keys: shift, ⇧, option, ⌥, alt, ctrl, command, ⌘

Supported special keys: backspace, tab, clear, enter, return, esc, escape, space, up, down, left, right, home, end, pageup, pagedown, del, delete, F1–F19

Note: Avoid overriding native browser and operating system shortcuts.

Enable On Form Fields

Select this option to enable this event handler on form input components. To avoid conflicts, keyboard event handlers are disabled by default when form input components, such as Text edit and Switch are focused.

Action

The action to run when the key binding is pressed.

Description

A short description of the action displayed in a dialog in the app listing available shortcuts. The description will be displayed next to the key combination. The dialog can be opened by pressing F1 on the keyboard.

Disabled

Bind a value or condition to determine if the button should be disabled or not.

Event handlers

Run an action when a view is loaded or unloaded. For example, if a view displays live information populated by a web request to an external API, you could run a new web request every time the view is loaded to ensure the latest data is always shown.

Property
Description

On View Load

Triggered before the view is visible to the user. Note: A long-running action will increase the loading time of the view. Use with care.

On View Loaded

Triggered immediately after the view is visible.

On View Unload

Triggered after the view has been navigated away from and is no longer visible.

Add an (button) to the left-hand side. This is typically used to display a menu icon button. Only one button is displayed at a time, so the first visible button will be shown if multiple are defined.

Add an (button) to the right-hand side. Buttons can be displayed side-by-side or in a dropdown menu.

The background color of the app bar. The default color is the from the active theme.

Select an which has enum values with icons specified. If an enum value does not have an icon defined, the icon selected in Icon (if any) will used instead. The enum value must be for the icon to display.

You can add keyboard shortcuts to a view by adding keyboard event handlers. For a detailed walkthrough of using keyboard event handlers, see .

How to add keyboard shortcuts
action
action
Navigate action node
dialogs
drawers
enum
primary color
selected
default view
An example app bar
Example of a menu icon button as a left action
Example of a dropdown menu holding two right actions
A screenshot of an example app bar