Entity
The entity component allows the user to use entity (sections, field-rows and entity-fields) as the preview content.
Long-press on a widget
This example displays a preview after long-pressing the widget See the full example on GitHub.

preview:
isCompact: false
children:
- type: component.entity
options:
isCompact: true
children:
- type: component.section
options:
title: General info
children:
- type: component.field-row
options:
children:
- type: component.entity-field
options:
label: First Name
value: Karl
contentType: default
- type: component.entity-field
options:
label: Middle Name
value: Joseph
contentType: default
- type: component.entity-field
options:
label: Last Name
value: Fisher
contentType: default
- type: component.entity-field
options:
label: Date of birth
value: 1988-01-19
rightIcon: calendar
- type: component.entity-field
options:
label: Phone
value: +987 654 321
contentType: phone
- type: component.entity-field
options:
label: Email
value: [email protected]
contentType: email
- type: component.entity-field
options:
label: ""
value: Tap to see more details!
header:
type: component.jig-header
options:
height: small
children:
type: component.image
options:
title: Activities
source:
uri: https://images.unsplash.com/photo-1603988363607-e1e4a66962c6?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxzZWFyY2h8Njl8fHNwb3J0fGVufDB8fDB8fA%3D%3D&auto=format&fit=crop&w=900&q=60Long-press onPress action


This example displays a preview after long-pressing the list-item on the widget
This example displays a preview after long-pressing the list-item in the jig. It includes the entity component as well as the go-to actions.
As you can see in the code snippet, the original list doesn't include the preview. Our onPress action allows us to use the preview that is included in the detail jig.
See the full examples of LongPress onPress and entity-detail in GitHub.
title: Entity preview - onPress
type: jig.list
icon: world
header:
type: component.jig-header
options:
height: small
children:
type: component.image
options:
title: Activities
source:
uri: https://images.unsplash.com/photo-1603988363607-e1e4a66962c6?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxzZWFyY2h8Njl8fHNwb3J0fGVufDB8fDB8fA%3D%3D&auto=format&fit=crop&w=900&q=60
datasources:
activities:
type: datasource.static
options:
data:
- id: 1
name: Swimming
location: Pool
previewDetail: 7pm
image: love-it
- id: 2
name: Tennis
location: Court
previewDetail: 6am
image: rating-star
- id: 3
name: Exercising
location: Gym
previewDetail: 5pm
image: multiple-neutral-2
data: [email protected]
item:
type: component.list-item
options:
title: [email protected]
subtitle: [email protected]
rightElement:
element: icon
icon: [email protected]
onPress:
type: action.go-to
options:
linkTo: entity-detail
parameters:
id: [email protected]
name: [email protected]
location: [email protected]
previewDetail: [email protected]title: Activity detail
type: jig.default
header:
type: component.jig-header
options:
height: small
children:
type: component.image
options:
title: [email protected]
source:
uri: https://images.unsplash.com/photo-1603988363607-e1e4a66962c6?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxzZWFyY2h8Njl8fHNwb3J0fGVufDB8fDB8fA%3D%3D&auto=format&fit=crop&w=900&q=60
children:
- type: component.entity
options:
isCompact: true
children:
- type: component.section
options:
title: Activity - Compact entity
children:
- type: component.entity-field
options:
label: Activity
value: [email protected]
- type: component.entity-field
options:
label: Location
value: [email protected]
- type: component.entity-field
options:
label: Time
value: [email protected]
preview:
isCompact: true
actions:
- children:
- type: action.go-to
options:
title: Go To Action
linkTo: placeholder
- type: action.go-to
options:
title: Go to Danger
linkTo: placeholder
style:
isDanger: true
- type: action.go-to
options:
title: Go to Disabled
linkTo: placeholder
style:
isDisabled: true
children:
- type: component.entity
options:
isCompact: false
children:
- type: component.section
options:
title: Activity - Basic entity
children:
- type: component.entity-field
options:
label: Activity
value: [email protected]
- type: component.entity-field
options:
label: Location
value: [email protected]
- type: component.entity-field
options:
label: Time
value: [email protected]
- type: component.entity-field
options:
label: ""
value: Tap to see a compact entity!
header:
type: component.jig-header
options:
height: medium
children:
type: component.image
options:
title: [email protected]
subtitle: [email protected]
source:
uri: https://images.unsplash.com/photo-1603988363607-e1e4a66962c6?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxzZWFyY2h8Njl8fHNwb3J0fGVufDB8fDB8fA%3D%3D&auto=format&fit=crop&w=900&q=60LongPress on Calendar jig
This example displays a preview after long-pressing the event in the Calendar jig (on the widget)

This example displays a preview after long-pressing the event in the Calendar jig (on the event)

See the full example of entity longpress and entity-calendar-detail in GitHub.
title: Entity preview - Calendar
type: jig.calendar
icon: career
inputs:
title:
type: string
description:
type: string
type:
type: string
header:
type: component.jig-header
options:
height: small
children:
type: component.image
options:
title: Upcoming meetings
source:
uri: https://images.unsplash.com/photo-1517245386807-bb43f82c33c4?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxzZWFyY2h8Mnx8bWVldGluZ3xlbnwwfHwwfHw%3D&auto=format&fit=crop&w=900&q=60
datasources:
calendar_data:
type: datasource.static
options:
data:
- description: New features to be added
id: 1
title: Documentation Discussion
type: meeting
color: color2
people: https://images.unsplash.com/photo-1548449112-96a38a643324?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=774&q=80
- description: Project manager position
id: 2
title: Second interview - Maria Booyens
type: interview
color: color3
people: https://images.unsplash.com/photo-1573497019940-1c28c88b4f3e?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=774&q=80
data: [email protected]_data
item:
type: component.event
options:
from:
text: =$fromMillis($toMillis($now()) + ($number(@ctx.current.item.id)- 1) * 3600000)
format:
dateFormat: "l"
to: =$fromMillis($toMillis($now()) + $number(@ctx.current.item.id) *
3600000)
title: [email protected]
description: [email protected]
tags: "=[{'title': @ctx.current.item.type, 'color': @ctx.current.item.color}]"
people: "=[{'avatarUrl': @ctx.current.item.people}]"
onPress:
type: action.go-to
options:
linkTo: entity-calendar-detail
inputs:
title: [email protected]
description: [email protected]
type: [email protected]
onButtonPress:
type: action.go-to
options:
title: Go to detail
linkTo: entity-calendar-detail
inputs:
title: [email protected]
description: [email protected]
type: [email protected]
buttonTitle: Go to detail
preview:
isCompact: true
children:
- type: component.entity
options:
isCompact: true
children:
- type: component.entity-field
options:
label: Meeting
value: Documentation Discussion
- type: component.entity-field
options:
label: Interview
value: Second interview - Maria Booyens
header:
type: component.jig-header
options:
height: medium
children:
type: component.image
options:
title: Upcoming meetings
source:
uri: https://images.unsplash.com/photo-1517245386807-bb43f82c33c4?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxzZWFyY2h8Mnx8bWVldGluZ3xlbnwwfHwwfHw%3D&auto=format&fit=crop&w=900&q=60title: Meeting detail
type: jig.default
header:
type: component.jig-header
options:
height: small
children:
type: component.image
options:
title: Meeting detail
source:
uri: https://images.unsplash.com/photo-1517245386807-bb43f82c33c4?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxzZWFyY2h8Mnx8bWVldGluZ3xlbnwwfHwwfHw%3D&auto=format&fit=crop&w=900&q=60
children:
- type: component.entity
options:
isCompact: true
children:
- type: component.section
options:
title: Meeting - Compact entity
children:
- type: component.entity-field
options:
label: Title
value: [email protected]
- type: component.entity-field
options:
label: Type
value: [email protected]
rightIcon: conversation-chat-2
- type: component.entity-field
options:
label: Description
value: [email protected]
preview:
isCompact: true
actions:
- children:
- type: action.go-to
options:
title: Join the meeting
linkTo: placeholder
- type: action.go-to
options:
title: Cancel the meeting
linkTo: placeholder
style:
isDanger: true
- type: action.go-to
options:
title: Change the location
linkTo: placeholder
style:
isDisabled: true
children:
- type: component.entity
options:
isCompact: true
children:
- type: component.section
options:
title: Meeting - Compact entity
children:
- type: component.entity-field
options:
label: Title
value: [email protected]
- type: component.entity-field
options:
label: Description
value: [email protected]
- type: component.entity-field
options:
label: Type
value: [email protected]
header:
type: component.jig-header
options:
height: medium
children:
type: component.image
options:
title: Meeting detail
source:
uri: https://images.unsplash.com/photo-1517245386807-bb43f82c33c4?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxzZWFyY2h8Mnx8bWVldGluZ3xlbnwwfHwwfHw%3D&auto=format&fit=crop&w=900&q=60Last updated
Was this helpful?