← All types
Ob Object

PortalSiteComponentProp

One prop of a component's contract.

Fields

name

String!Non-null

Name of the prop.

type

String!Non-null

Type of the prop: any, array, boolean, integer, number, object or string.

Whether a caller must pass the prop.

Whether the prop accepts null.

Default value as authored, or null for none.

enum

StringNullable

Allowed values as authored, space-separated, or null for any.

What the prop is for, or null.

Fields of an object prop, in authored order; empty otherwise.

Shape of an array prop's elements, or null.

Referenced by (3)
Exact type SDL
"""One prop of a component's contract."""
type PortalSiteComponentProp {
  """Name of the prop."""
  name: String!
  """
  Type of the prop: any, array, boolean, integer, number, object or string.
  """
  type: String!
  """Whether a caller must pass the prop."""
  required: Boolean!
  """Whether the prop accepts null."""
  nullable: Boolean!
  """Default value as authored, or null for none."""
  default: String
  """Allowed values as authored, space-separated, or null for any."""
  enum: String
  """What the prop is for, or null."""
  description: String
  """Fields of an object prop, in authored order; empty otherwise."""
  props: [PortalSiteComponentProp!]!
  """Shape of an array prop's elements, or null."""
  items: PortalSiteComponentPropItems
}