LogoLogo
  • Adapptio User Documentation
  • Getting Started
    • Quickstart
    • Architecture Overview
      • Views
      • Actions
      • Integrations
      • API Endpoints
      • Routes
      • Events
      • Assets
    • Editor
      • Main Menu
        • Create New Resources
        • Manage the Application
        • Monitoring Errors
      • Main Toolbar
        • Deploying the Application
        • Opening the Application
        • Preview Mode
        • Error Monitor
      • Components Panel
        • Components
        • Inspector
        • View Settings
      • Outline Panel
        • Data Variables
          • State Variable
          • Data From Action
      • Data Explorer
      • Console
    • Playground
  • Working with Adapptio
    • Best Practices
    • Tutorials
      • 1. Hello World
      • 2. Visualize Data from API
      • 3. Advanced Layout Application
      • 4. Application with In-Memory Database
    • How To
      • Custom Auth
      • Action Logic
        • Transform Node
      • UI Logic
        • Logout
        • Conditional Render
        • One Of
      • Data & Dynamic values
        • Custom Variable
        • Data from Action
        • Dynamic Value
        • Change Value from Event
        • Loading Data from Action to Form
        • Sending Data to Action from a Form
        • Server-side Dropdown Autocompletion
      • Visual
        • Styling Icon Button
      • Layouts
        • Centered Box
        • Header & Sidebar Layout
        • Grid Form Layout
        • Stretched Layout in Row
    • Components
      • Composed Chart
      • Advanced Table
      • Custom Component
    • Examples of Applications
      • SaaS Platforms
      • Customers Portals
      • Information Systems
      • Internal Tools
        • Color Picker
      • IoT Applications
      • Smart Portals
      • Analytics & Calculators
      • Statistics & Monitoring Panels
      • API Data Visualization
      • Simple Games
  • DEPLOYMENT
    • Cloud Hosted
    • Self Hosted
  • REFERENCE GUIDE
    • Components List
      • Application Header
      • Box
      • Container
      • Grid
      • Sidebar Layout
      • View
      • Text Input
      • Number
      • Checkbox
      • Option
      • Date and Time
      • File Upload
    • Properties
      • ACCEPT
      • CUSTOM PLACEHOLDER
      • DESCRIPTION
      • ENABLED
      • FONT SIZE
      • FOREGROUND COLOR
      • FORM DATA KEY
      • HEADERS
      • ICON
      • ID
      • LABEL
      • METHOD
      • MULTIPLE
      • MAX FILE SIZE
      • REQUEST TIMEOUT
      • REQUIRED
      • READ-ONLY
      • SIZE
      • TEXT ALIGNMENT
      • TEXT STYLE
      • URL
      • UPLOAD IMMEDIATELY
      • VALIDATE
      • VALUE
    • Functions
      • Array
      • Date
      • Generators
      • JSON
      • Logic
      • Math
      • Object
      • String
      • Types
      • Util
  • Support
    • Get in touch
    • Release Notes
  • Legal
    • Terms and Conditions
    • GDPR
Powered by GitBook
On this page
  • Project Structure
  • Resource Naming
  • Variable Naming
  • Component Naming

Was this helpful?

  1. Working with Adapptio

Best Practices

Project Structure

Create assets, views, actions and integrations in the proper folder. It helps you to orient in your project.

To reuse the same content, create a View and embed it as a widget using View component.

Resource Naming

We recomend to use PascalCase style with dots.

Integration - name it as type.description.

Examples:

Api.MyBackend
Db.MyDatabase

Action - start with a verb describing purpose of the action.

Examples:

GetUsers
InsertArticle

View - name should represent a page content.

Examples:

Users
AddArticle

Variable Naming

Use noun related to the data that the variable contains. We recommend to use camelCase style.

Examples:

users         (calling action GetUsers)
buttonState   (represents on / off state)

Component Naming

We recommend to start each name of any component with three abbreviation letter and continue with component description with camelCase style:

  • container - cnt

  • box - box

  • sidebar - sdb

  • app header - hdr

  • advanced table - adt

  • data table - dtb

  • pagination - pgn

  • text - txt

  • label - lbl

  • icon - icn

  • image - img

  • all fields - fld

  • button - btn

  • menu button - mnb

  • property item - pri

  • repeat - rpt

  • routes - rts

  • one of - onf

  • qr code - qrc

  • composed chart - cmc

  • view - view

PreviousPlaygroundNextTutorials

Last updated 2 years ago

Was this helpful?