Jmix Documentation
Go to Jmix website

Jmix Documentation

    • Introduction
    • What’s New
    • Setup
    • Tutorial
      • 1. Project Setup
      • 2. Simple CRUD
      • 3. References and Unique Attributes
      • 4. Using Enumerations
      • 5. Working with Data in UI
      • 6. Working with Images
      • 7. Creating UI from Scratch
      • 8. Using Entity Events
      • 9. Data Access Control
      • What’s Next?
    • Using Studio
      • Installation
      • Update
      • Account and Subscription
      • Working with Project
      • Studio Features
        • Welcome Screen
        • Jmix Tool Window
        • Project Properties
        • Add-ons Marketplace
        • Entity Designer
        • Data Stores
        • Screen Wizard
        • Screen Designer
        • Fetch Plan Designer
        • Menu Designer
        • Role Designer
        • BPMN Designer
        • Coding Assistance
        • Code Snippets
        • Reverse Engineering
        • Hot Deploy
        • Quick Deployment to AWS
        • Jmix Plugin Settings
        • Custom Project Templates
        • Composite Projects
    • Data Model
      • Entities
      • Data Stores
      • Data Types
      • Enumerations
      • Soft Deletion
      • Bean Validation
      • Metadata
      • Database Migration
    • Data Access
      • Using DataManager
      • Using EntityManager
      • Data Repositories
      • Entity Events
      • Fetching Data
      • Transaction Management
      • Entity and Query Cache
      • JPQL Extensions
    • User Interface
      • Screens and Fragments
        • Screen Controllers
          • Screen Controller Annotations
          • Screen Controller Methods
          • Screen Events
          • ScreenFragment Events
        • XML Descriptors
        • Screen Mixins
        • Root Screens
        • Screen Validation
      • Opening Screens
      • Using Screen Fragments
      • Data Components
        • Data Containers
          • InstanceContainer
          • CollectionContainer
          • Property Containers
          • Key-Value Containers
        • Data Loaders
        • DataContext
        • Using Data Components
      • Visual Components Library
        • Components
          • AppMenu
          • BrowserFrame
          • Button
          • CapsLockIndicator
          • Calendar
          • CheckBox
          • CheckBoxGroup
          • ColorPicker
          • ComboBox
          • CurrencyField
          • DataGrid
          • DateField
          • DatePicker
          • EntityComboBox
          • EntityPicker
          • EntitySuggestionField
          • FileMultiUploadField
          • FileStorageUploadField
          • FileUploadField
          • Filter
            • Filter Components
          • Form
          • GroupTable
          • Image
          • Label
          • Link
          • LinkButton
          • MaskedField
          • MultiSelectList
          • Pagination
          • PasswordField
          • PopupButton
          • PopupView
          • ProgressBar
          • PropertyFilter
          • RadioButtonGroup
          • RelatedEntities
          • ResizableTextArea
          • RichTextArea
          • SideMenu
          • SimplePagination
          • SingleSelectList
          • Slider
          • SourceCodeEditor
          • SuggestionField
          • Table
          • TagField
          • TagPicker
          • TextArea
          • TextField
          • TimeField
          • Tree
          • TreeDataGrid
          • TreeTable
          • TwinColumn
          • ValuePicker
          • ValuesPicker
        • Containers
          • Accordion
          • BoxLayout
          • ButtonsPanel
          • CssLayout
          • Drawer
          • GridLayout
          • GroupBoxLayout
          • HtmlBoxLayout
          • Layout
          • ResponsiveGridLayout
          • ScrollBoxLayout
          • SplitPanel
          • TabSheet
        • Screen Layout Rules
        • Miscellaneous
          • Validator
          • Formatter
        • Components API
        • Components XML Attributes
      • Facets
        • ClipboardTrigger
        • DataLoadCoordinator
        • DynamicAttributes Facet
        • EditorScreenFacet
        • InputDialogFacet
        • LookupScreenFacet
        • MessageDialogFacet
        • NotificationFacet
        • OptionDialogFacet
        • PresentationsFacet
        • ScreenFacet
        • ScreenSettingsFacet
        • Timer
      • Actions
        • Declarative Actions
        • Standard Actions
          • AddAction
          • BulkEditAction
          • CreateAction
          • EditAction
          • EntityClearAction
          • EntityLookupAction
          • EntityOpenAction
          • EntityOpenCompositionAction
          • ExcludeAction
          • RefreshAction
          • RelatedAction
          • RemoveAction
          • TagLookupAction
          • ValueClearAction
          • ViewAction
        • Custom Action Types
        • BaseAction
      • Dialogs
      • Background Tasks
      • Notifications
      • Exception Handlers
        • Handling Unique Constraint Violation Exceptions
      • Themes
        • Using Existing Themes
        • Creating a Custom Theme
        • Creating and Using a Theme Add-on
      • Icons
        • Icon Sets
        • Using Icons from Other Font Libraries
      • MenuConfig
      • URL History and Navigation
        • Handling URL Changes
        • Routing API
        • Using URL History and Navigation API
        • URL Routes Generator
      • Anonymous Access to Screens
      • Pluggable Component Factories
      • Creating Custom Components
        • Composite Components
        • Generic JavaScriptComponent
        • Creating GWT Component
        • Creating and Using Widgets Add-On
      • UI Properties
    • Flow UI (Incubating)
      • Views
        • Opening Views
      • Visual Components
        • Components
          • button
          • comboBox
          • dataGrid
          • datePicker
          • entityComboBox
          • entityPicker
          • loginForm
          • multiValuePicker
          • passwordField
          • progressBar
          • textField
          • timePicker
          • tooltip
          • treeDataGrid
          • valuePicker
        • Layouts
        • HTML Components
        • Common Attributes
        • Common Handlers
      • Data Components
      • Actions
      • Facets
        • dataLoadCoordinator
      • Notifications
      • Dialogs
      • Background Tasks
      • Flow UI Properties
    • Generic REST
      • Getting Started with REST
      • Entities API
        • Load Entities
        • Create Entities
        • Update Entities
        • Delete Entities
      • Files API
      • Messages API
      • Metadata API
      • User Session API
      • Business Logic
      • Security
        • Authentication
      • API Documentation
      • REST Properties
    • Localization
      • Message Bundles
      • Framework Translations
    • Managing Files
      • Storing Files in Database
      • Using File Storage
      • Uploading Files
      • Downloading and Displaying Files
    • Security
      • Users
      • Resource Roles
      • Row-level Roles
      • Authentication
      • Authorization
    • Other Features
      • Sequence Generation
      • Pessimistic Locking
    • Modularity and Extension
      • Creating Add-ons
      • Extending Functionality
    • Deployment
      • Basic Deployment
      • Kubernetes Cluster
      • Amazon Web Services
      • Azure App Services
      • Google Cloud
    • Add-ons
      • Application Settings
      • Audit
        • Entity Log
        • Entity Snapshots
      • BPM
        • Getting Started with BPM
        • Administration Screens
          • Modeler
          • Process Definitions
          • Process Instances
          • User Groups
          • User Tasks
        • Process Forms
          • Input Dialog
          • Jmix Screen
          • Custom Form
        • Tasks
          • User Task
          • Service Task
          • Script Task
          • Entity Data Task
          • Email Sending Task
          • Sub-Processes and Call Activities
        • Event Listeners
        • DMN
        • Process Instances Migration
        • Automatic Models Deployment
        • BPM API
      • Business Calendars
        • Creating Business Calendar
        • Business Calendars API
      • Charts
        • Charts Types
          • AngularGaugeChart
          • FunnelChart
          • GanttChart
          • PieChart
          • RadarChart
          • SerialChart
          • StockChartGroup
          • XYChart
        • Configuring Charts
        • Charts Export
        • Connecting Data
        • Events
        • Examples
      • Dashboards
        • Configuration
        • Administration UI
        • Adding Business Logic
        • Using Dashboard in Screen
        • Dashboard Chart Add-on
      • Data Tools
        • Entity Inspector
        • Entity Information Action
      • Dynamic Attributes
        • Managing Dynamic Attributes
        • Displaying Dynamic Attributes
        • Dynamic Attributes API
      • Email Sending
        • Getting Started with Email
        • Configuration
        • Email Sending API
        • Email History
      • Email Templates
        • Getting Started with Email Templates
        • Usage
        • Email Templates API
      • GrapesJS
        • GrapesJS UI Components
        • HTML Editor UI
      • Grid Export Actions
        • Table Exporters
        • Export Actions
        • Limitations
        • Grid Export Properties
      • LDAP
        • Getting Started with LDAP
        • Obtaining User Authorities
        • In-memory User Management
        • Usage with Active Directory
        • Global User Synchronization
        • LDAP Properties
      • Maps
        • Getting Started with Maps
        • Maps UI Component
        • Layers
          • Raster Layers
          • Vector Layers
          • Heatmap Layer
          • Canvas Layer
        • Additional Options
        • Drawing Geometry
        • Map Services
      • Multitenancy
      • Notifications
        • Configuration
        • Creating Notifications
        • Viewing Notifications
      • Pivot Table
        • Elements
        • Exporting PivotTable Data
        • Using ShowPivotAction
        • Examples
      • Quartz
      • Reports
        • Getting Started with Reports
        • Report Browser
        • Creating Reports
          • Report Data Structure
          • Report Template
          • Report Parameters and Field Formatters
          • Report Access Rights
          • Report Name Localization
        • Running Reports
        • Report Execution History
        • Sample Reports
        • REST API
        • Configuration
      • Search
        • Getting Started with Search
        • Index Definitions
        • Indexing Queue
        • Using Search in UI
        • Search Configuration Options
        • Search API and Internals
        • Search Properties
      • WebDAV
        • Features
        • UI Components
        • Services
        • Configuration
    • Appendices
      • Account, Billing, and Subscription Management
      • Application Properties
      • Java API Reference
      • Migration from CUBA Platform
      • Private Artifact Repository
      • Publishing an Add-on
      • Quartz Job Scheduler Setup
Jmix Documentation 1.5
  • Jmix Documentation
    • 1.5
    • 1.4
    • 1.3
    • 1.2
    • 1.1
    • 1.0
  • Jmix Documentation
  • User Interface
  • Creating Custom Components
1.5 1.4 1.3 1.2 1.1 1.0
Edit this Page

Creating Custom Components

This section describes different ways of creating custom web UI components in Jmix applications.

Pluggable Component Factories Composite Components

This page was built using the Antora default UI.

The source code for this UI is licensed under the terms of the MPL-2.0 license.