Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPropertyMetadata

Hierarchy

  • IPropertyMetadata

Index

Properties

default

default: any

The default value that this property takes on, if applicable.

Optional documentation

documentation: undefined | string

A short, one-or-two-line summary of this property.

This should be descriptive but terse- it is displayed as a tooltip on the property, alongisde the type and default value.

prettyName

prettyName: string

The user-facing name of this property.

If groupOnDots is true, the properties will be rendered as a hierarchy.

see

PropertiesEditor.IProps.groupOnDots

Optional schema

schema: undefined | object

Optional schema describing how this property should be shaped.

NOTE: Right now, the only thing using this is the String editor for rendering a dropdown if the schema indicates that the type is an enum.

type

type: Type

The type of editor to use with this property.

Generated using TypeDoc