ObjectList
ObjectList

Render a list of links to the objects matching a YAML filter.

ObjectList renders a <ul> of links to the objects matching the YAML filter in its body. Each item links to the object page (text = object title).

Supported props

PropTypeRequiredDefaultPurpose
model_keystringyes*current route modelWhich model to read
childrenYAML text/code blocknoall objectsfilter.objects.include/exclude.id

* Set model_key explicitly on specs pages.

Filter syntax

Ids are model-relative and support masks: * (one level) and ** (recursive).

filter:
  objects:
    include:
      id:
        - iomodel.*
    exclude:
      id:
        - iomodel.redis

Example

Source syntax

<ObjectList model_key="deployment">
  ```yaml filter: objects: include: id: - iomodel.* exclude: id: - iomodel.redis
  ```
</ObjectList>

Rendered output

No objects match this filter.

Common pitfalls

  • Writing invalid YAML in the body silently disables filtering
  • * matches one level only — use ** for nested objects
  • For free-form item templates (not just links), use Each

Last updated on