LogoLogo
What's NewDeveloper CommunitySupportStatus
  • 🚀Get Started
    • What is JourneyApps Platform?
    • Tutorial: Build your First App
      • 1. Introduction
      • 2. Create a new App
      • 3. OXIDE IDE Overview
      • 4. Hello World app
      • 5. The Data Model
      • 6. View Components
      • 7. Queries and Data Sync
      • 8. Simple Navigation
      • 9. View Stack
      • 10. Input Validation
      • 11. View Parameters
      • 12. Data Manipulation
      • 13. Responsive Apps
      • 14. Styling
      • 15. Lists
      • 16. GPS Capturing
      • 17. Relationships
      • 18. Multiple User Roles
      • 19. Deployment and Users
      • 20. Version Control
      • 21. CSV and APIs
      • 22. Conclusion
    • JourneyApps Platform Fundamentals
      • Creating a New App
        • Git-enabled Apps
      • What are Views?
      • What is the Data Model?
      • JourneyApps Syntax Basics
      • Access the Database (DB)
        • Manipulate DB Objects
        • Query DB Objects
      • View Navigation
        • Deep Linking
      • CloudCode Overview
      • OXIDE (Online IDE)
  • 💻Build your App
    • JourneyApps Syntax
      • Syntax Basics
      • Access the DB
      • View Navigation
      • Async & Await
      • TypeScript Apps (Beta)
        • runtime-build package
        • TypeScript App Troubleshooting
      • What's New in V4
        • Updating to the V4 API
    • Configure your Data Model
      • What is the data model?
      • Reference: model
        • field
        • belongs-to
        • has-many
        • index
      • Data Rules
        • Data Buckets
        • Sync Rules - Limit data synced to devices
        • Data ACLs - Limit access to data
        • Real-world example for Data Rules
        • ❔FAQs
        • Migrate to Data Rules
      • App Indexes
      • Webhooks
    • UI Components
      • All UI Components
        • actionSheet
        • Attachments
        • button
        • button-group
        • capture-coordinates
          • marker
          • marker-query
        • capture-file
        • capture-photo
        • capture-signature
        • card
          • accent
          • action
        • columns
          • column
        • component
        • context-menu
          • divider
          • item
        • CSV
        • date-input
        • datetime-input
        • dialog
          • body
        • display-3d-model
          • 📖display-3d-model Guides
            • Guide 1: Initialize and layout a 3D model in a view
            • Guide 2: Control playback position
            • Guide 3: Troubleshooting controls
        • display-coordinates
        • display-file
        • display-image
        • display-photo
        • display-signature
        • heading
        • html
          • HTML Advanced Topics
          • ❔HTML FAQs
          • 📖Guide: HTML & JourneyApps iFrame Client
        • icons
        • info
        • info-table
          • row
        • journey.photos (capture multiple photos)
        • JourneyPrinter (print PDFs)
        • grid
          • cell
          • 📖grid Examples
        • list
          • list-item
            • accent
            • asset
            • pills
              • pill
            • action
        • multiple-choice-checklist
        • navigation (Navigation drawer)
          • general-section
            • item
          • section
            • item
              • item
          • ❔navigation FAQs
        • notification
        • object-dropdown
        • object-list
          • action
        • object-repeat
        • object-table
          • action
          • column
            • action
            • edit-boolean
            • edit-date
            • edit-datetime
            • edit-integer
            • edit-number
            • edit-select
            • edit-text
            • edit-time
            • edit-typeahead
              • action
            • header-action
          • column-group
          • empty-action
          • 📖object-table Guides
            • Actions
            • Cell callouts
            • Column groups
            • Columns
            • Controlled object-table
            • Controls
            • Copy & paste data
            • Edit cells
            • Filters
            • Frozen columns
            • Fullscreen object-table
            • Mode
            • State
            • Styles
        • optionList
        • PhotonSync (transfer data offline)
        • power-bi
          • 📖Guide: PowerBI Embedding
        • scan-barcode
        • shortcut
        • sidebar
        • single-choice-dropdown
        • single-choice-radio
        • template
        • text-input
        • time-input
        • toggle
        • view
      • JS/TS Events
      • Show / Hide UI Components
      • View Templates
      • XML Fields (Attributes)
        • align-content
        • align-controls
        • align-label
        • bind
        • clear-button-visibility
        • control-order
        • disabled
        • error-message
        • icon-position
        • id
        • hide-if
        • modifier-text
        • label
        • label-case
        • label-color
        • on-change
        • on-press
        • placeholder
        • required
        • show-if
    • JS / TS APIs
      • Attachment
      • Bluetooth (Beta)
      • Broadcast
      • component
      • CSV
      • DB
      • HardwareBarcode
      • journey
        • journey.config
        • journey.container
        • journey.device
        • journey.diagnostics
        • journey.dialog
        • journey.files
        • journey.hardware
        • journey.photos
        • journey.runtime
        • journey.sensors
        • journey.viewStack
      • JourneyPrinter
      • KeyboardBarcode
      • LocalDB
      • NFC
      • OnlineDB
      • PhotonSync
      • SerialPort
      • ShortcutManager
      • TCPSocket
      • user
    • Extend your App with Custom Code
      • App packages
        • App packages overview
        • PDF report package
        • TypeScript library & unit tests
        • Manage External Dependencies
      • Custom HTML
    • Style & Customize your App
      • Style & configure UI components
        • Overview
        • Understand extendable themes
        • Use themes on a view
        • Theme specific components on a view
        • Examples
        • Debugging
        • ❔FAQs
      • Change your App Font
      • Custom Branding
        • Custom Container Features
        • Special Requirements for iOS Containers
    • Integrate your App
      • Backend integrations with CloudCode
      • Barcode Scanning
        • Barcode Scanning using Keyboard Emulation
        • Hardware Barcode Scanning
        • scan-barcode
      • Bluetooth Low Energy (BLE)
      • Broadcast API
      • HTTP requests (Fetch API)
      • JourneyApps Print (Android)
      • Maps and navigation
      • NFC
      • Opening external links/apps
      • Serial Port
      • TCP Sockets
    • Design Intuitive Apps
      • UX Guidelines
      • Write Effective Copy
  • 📱App Features
    • RealWear® Voice Control
      • Automatic Voice Commands
        • Automatic Voice Commands - Advanced
      • Manual Voice Commands
    • App, Runtime and Container Updates
    • Batch Operations (App)
    • Call JS/TS Functions from XML
    • Capture GPS Locations
    • Push Notifications
    • Translations
    • XML Format Strings
    • Webhooks (External)
  • 🌐CloudCode
    • CloudCode Overview
    • Trigger a CloudCode Task
      • Trigger CC with a Schedule
      • Trigger CC via a Webhook
      • Trigger CC from an App
      • Trigger CC from Another Task
      • Trigger CC via HTTP
    • Attachments in CloudCode
    • Timezones
    • Advanced CloudCode Topics
      • Access Multiple DBs in CloudCode Tasks
      • Batch API (CloudCode)
      • CloudCode Dependencies
      • Configure HTTPS in CloudCode
      • Deployment environment variables
      • Local CloudCode Development
      • PDF Reports using CloudCode
      • Shared CloudCode Tasks
      • Translations in CloudCode
  • 📥Backend API
    • Introduction
    • API Reference
      • Retrieve All Objects
      • Query Objects
      • Sort Results
      • Limit and Skip
      • Count Objects
      • Create a New Object
      • Retrieve a Single Object
      • Update a Single Object
      • Delete a Single Object
      • Batch Operations (v4 API)
      • Oplog API
      • Retrieve the App Data Model
      • Manage App Users and Sessions
      • Field Representation
      • Error Responses
    • API Limits
    • Update to the V4 API
  • ⚙️Technical
    • Data Synchronization Priority
    • Device Diagnostics
    • JSON1 Query Engine
    • Improve App Performance
    • Security Measures
    • Supported Platforms
      • Web Container
      • Windows Installer
    • Domain Whitelist
  • 🖥️OXIDE
    • Get started with OXIDE
      • OXIDE Overview
      • Components of OXIDE
    • Configure Testing Deployments
    • Edit and Manage Files
      • How to Navigate to a Function
      • Manage External Dependencies
    • Create and Manage App Containers
    • Debugging & Troubleshooting
      • Common Troubleshooting Pointers
      • App Diagnostics Reports
      • Build Logs
    • OXIDE Workspaces
      • OXIDE Trees
  • ❕Deprecated Features
    • Deprecated Features and Components
Powered by GitBook
On this page
  • Overview
  • Basic Example
  • Standard Attributes
  • bind
  • label
  • required
  • Advanced Attributes
  • align-content
  • align-dialog-content
  • align-label
  • clear-button-visibility
  • dialog-title
  • disabled
  • empty-message
  • icon-position
  • id
  • label-case
  • label-color
  • modifier-text
  • on-change
  • placeholder
  • search-controls
  • show-if and hide-if
  • Component Methods
  • clear
  • clearSearch
  • openDropdown
  • closeDropdown
  • scrollDown
  • scrollIntoView
  • scrollUp
  • selectItem
  • selectItemByIndex
  • setSearch
  1. Build your App
  2. UI Components
  3. All UI Components

single-choice-dropdown

PrevioussidebarNextsingle-choice-radio

Last updated 1 year ago

Overview

Version compatibility

  • single-choice-dropdown is supported in all versions of the JourneyApps Container and Runtime.

  • It received several functional updates in version 4.84.0 of the JourneyApps Runtime.

A single-choice-dropdown component allows users to make a single selection from a pre-defined set of options in a dropdown component.

Basic Example

main.view.xml
<var name="selected_country" type="single-choice">
    <option key="us">USA</option>
    <option key="uk">UK</option>
    <option key="de">Germany</option>
    ...
</var>

<single-choice-dropdown label="Country of residence" bind="selected_country" required="false" />

Standard Attributes

bind

label

required

Advanced Attributes

align-content

Version compatibility

align-content was introduced in version 4.84.0 of the JourneyApps Runtime.

align-dialog-content

Optional

Type: center | left | right

Default: center

Version compatibility

align-dialog-content was introduced in version 4.84.0 of the JourneyApps Runtime.

Specifies how the content of the list of options dialog should be aligned. This includes the display value of each option, as well as the header text of the dialog.

<single-choice-dropdown label="Country of residence" align-dialog-content="left" bind="selected_country" />

align-label

clear-button-visibility

dialog-title

Optional

Default: "Choose an option"

Version compatibility

dialog-title was introduced in version 4.84.0 of the JourneyApps Runtime.

Header text of the dialog that displays the list of options of the single-choice-dropdown.

<single-choice-dropdown label="Country of residence" dialog-title="Choose the country of residence" bind="selected_country" />

disabled

empty-message

Version compatibility

empty-message was introduced in version 4.84.0 of the JourneyApps Runtime.

Optional

Default: unset

Text that is displayed if no options are available to list once the user opens the single-choice-dropdown.

<single-choice-dropdown label="Country of residence" bind="selected_country" empty-message="No countries are available. Please contact your administrator." />

icon-position

Version compatibility

icon-position was introduced in version 4.86.1 of the JourneyApps Runtime.

id

label-case

Version compatibility

label-case was introduced in version 4.84.0 of the JourneyApps Runtime.

label-color

modifier-text

Version compatibility

modifier-text was introduced in version 4.84.0 of the JourneyApps Run

on-change

placeholder

search-controls

Optional

Type: auto | none | show

Default: auto

Version compatibility

search-controls was introduced in version 4.84.0 of the JourneyApps Runtime.

Set the visibility of the search box of the single-choice-dropdown component. auto shows the search box when the list of options contains 12 options or more. none never shows the search box, and show always shows the search box at the top of the list of options.

<single-choice-dropdown label="Country of residence" bind="selected_country" search-controls="show" />

show-if and hide-if

Component Methods

clear

Programmatically clear the selected value bound to the single-choice-dropdown.

clearSearch

Programmatically clear a value entered into the search box.

openDropdown

Programmatically open the list of items.

closeDropdown

Programmatically close the list of items.

scrollDown

Programmatically scroll down the list of items when the single-choice-dropdown is opened.

scrollIntoView

Programmatically scroll until the single-choice-dropdown is visible in the view.

scrollUp

Programmatically scroll up the list of items when the single-choice-dropdown is opened.

selectItem

Programmatically select an item from the list by its label.

main.view.xml
<var name="favorite_color" type="single-choice">
    <option key="green">Green</option>
    <option key="red">Red</option>
    <option key="yellow">Yellow</option>
</var>

<single-choice-dropdown id="my-dropdown" bind="favorite_color" label="Favorite Color" />
main.js
function select() {
    component.singleChoiceDropdown({id: 'my-dropdown'}).openDropdown(); // Need to open the dropdown first
    component.singleChoiceDropdown({id: 'my-dropdown'}).selectItem('Yellow');
}

selectItemByIndex

Programmatically select an item from the list by its index. Note: Indexes begin at 1.

main.view.xml
<var name="favorite_color" type="single-choice">
    <option key="green">Green</option>
    <option key="red">Red</option>
    <option key="yellow">Yellow</option>
</var>

<single-choice-dropdown id="my-dropdown" bind="favorite_color" label="Favorite Color" />
main.js
function select() {
    component.singleChoiceDropdown({id: 'my-dropdown'}).openDropdown(); // Need to open the dropdown first
    component.singleChoiceDropdown({id: 'my-dropdown'}).selectItemByIndex(2);
    // Selects "Red"
}

setSearch

Programmatically enter a search value and triggers a search of the single-choice-dropdown.

Type: string (static text, a or the return value of a )

Type: string (static text, a or the return value of a )

The following component methods are available when an is assigned to the component and component.singleChoiceDropdown({id:'my-id'}) is called from JS/TS:

💻
bind
label
required
align-content
align-label
clear-button-visibility
format string
JS/TS function
disabled
format string
JS/TS function
icon-position
id
label-case
label-color
modifier-text
on-change
placeholder
show-if
hide-if
id