Skip to main content

SlotSettings

type SlotSettings = {
  stretchChildOnInsert?: boolean
  displayEmptyByDefault?: boolean
  minChildren?: number | null
  maxChildren?: number | null
  allowPreferredValuesOnly?: boolean
}

Slot-specific configuration for 'SLOT'-typed component properties. Passed to ComponentPropertyOptions when creating or editing a slot property, and returned on each entry in ComponentPropertyDefinitions for slot properties.

  • stretchChildOnInsert: when a layer is inserted into the slot, apply counter-axis fill.
  • displayEmptyByDefault: whether the slot highlight is always shown on empty instances of this slot.
  • minChildren / maxChildren: enforced child count range. null means "not set". minChildren must be ≤ maxChildren when both are set.
  • allowPreferredValuesOnly: restrict the slot to its preferredValues list.

Edits that cause violations to minChildren / maxChildren and allowPreferredValuesOnly do not fail or cause runtime errors. If the current slot contents violate the configured limits, the slot node's SlotNode limitViolations getter returns the set of violation kinds.