Skip to content

Latest commit

 

History

History
102 lines (64 loc) · 2.1 KB

IPropertyOptions.md

File metadata and controls

102 lines (64 loc) · 2.1 KB

Interface: IPropertyOptions

Options used to configure @Property decorator

Table of contents

Properties

Properties

displayName

• displayName: string

Name of the property displayed in Composer.

description

• Optional description: string

Description of the property displayed in Composer.

defaultValue

• Optional defaultValue: any

Default value of the property.

minValue

• Optional minValue: number

Minimum value for this property.
If specified, any number value smaller than this value will be ignored when and replaced by the minimum.

maxValue

• Optional maxValue: number

Maximum value for this property.
If specified, any number value greater than this value will be ignored when and replaced by the maximum.

readOnly

• Optional readOnly: boolean

True if property is read only in Intuiface Composer. The property will only be usable as a binding source.

type

• Optional type: any

The type of the property. It's optional but highly recommended for better binding conversion. It can be:

  • String
  • Number
  • Boolean
  • Array
  • Class name of a convertible type (Color, Font, Path, Resource, Time)
  • Enum type
  • Class name of another class you created

itemType

• Optional itemType: any

The item type in case the type is Array. It's optional but useful in interface assets to display item's properties in Intuiface Composer. It can be:

  • Class name
  • String
  • Number
  • Boolean

Help

Found a problem, a bug? Or need some help?
Please do not create an issue in Github! Ask us via our Support page : https://support.intuiface.com/