Skip to main content
Version: 2.0.0-alpha

Interface: PropertyPreviewProps<T, CustomProps>

Type parameters

NameType
Textends CMSType = CMSType
CustomPropsany

Properties

customProps

Optional customProps: CustomProps

Additional properties set by the developer

Defined in

lib/src/preview/PropertyPreviewProps.tsx:52


entity

Optional entity: Entity<any>

Entity this property refers to

Defined in

lib/src/preview/PropertyPreviewProps.tsx:57


height

Optional height: number

Max height assigned to the preview, depending on the context. It may be undefined if unlimited.

Defined in

lib/src/preview/PropertyPreviewProps.tsx:41


property

property: Property<T> | ResolvedProperty<T>

Property this display is related to

Defined in

lib/src/preview/PropertyPreviewProps.tsx:25


propertyKey

Optional propertyKey: string

Name of the property

Defined in

lib/src/preview/PropertyPreviewProps.tsx:15


size

size: PreviewSize

Desired size of the preview, depending on the context.

Defined in

lib/src/preview/PropertyPreviewProps.tsx:35


value

value: T

Current value of the property

Defined in

lib/src/preview/PropertyPreviewProps.tsx:20


width

Optional width: number

Max height width to the preview, depending on the context. It may be undefined if unlimited.

Defined in

lib/src/preview/PropertyPreviewProps.tsx:47

Methods

onClick

Optional onClick(): void

Click handler

Returns

void

Defined in

lib/src/preview/PropertyPreviewProps.tsx:30