atomic-result-children-template

Coveo Relevance Cloud Developer Atomic Product Documentation

In this article

Properties
Methods

The atomic-result-children-template component determines the format of the child results, depending on the conditions that are defined for each template. A template element must be the child of an atomic-result-children-template, and an atomic-result-children must be the parent of each atomic-result-children-template.

Note: Any <script> tags defined inside of a <template> element will not be executed when results are being rendered.

Properties

Property Attribute Description Type Default

Property	Attribute	Description	Type	Default
`conditions`		A function that must return true on results for the result template to apply. For example, a template with the following condition only applies to results whose `title` contains `singapore`: `[(result) => /singapore/i.test(result.title)]`	`ResultTemplateCondition[]`	`[]`
`mustMatch`	`must-match`	The field and values that define which result items the condition must be applied to. For example, a template with the following attribute only applies to result items whose `filetype` is `lithiummessage` or `YouTubePlaylist`: `must-match-filetype="lithiummessage,YouTubePlaylist"`	`Record<string, string[]>`	`{}`
`mustNotMatch`	`must-not-match`	The field and values that define which result items the condition must not be applied to. For example, a template with the following attribute only applies to result items whose `filetype` is not `lithiummessage`: `must-not-match-filetype="lithiummessage"	`Record<string, string[]>`	`{}`

conditions

A function that must return true on results for the result template to apply.

For example, a template with the following condition only applies to results whose title contains singapore: [(result) => /singapore/i.test(result.title)]

ResultTemplateCondition[]

[]

mustMatch

must-match

The field and values that define which result items the condition must be applied to. For example, a template with the following attribute only applies to result items whose filetype is lithiummessage or YouTubePlaylist: must-match-filetype="lithiummessage,YouTubePlaylist"

Record<string, string[]>

{}

mustNotMatch

must-not-match

The field and values that define which result items the condition must not be applied to. For example, a template with the following attribute only applies to result items whose filetype is not lithiummessage: `must-not-match-filetype="lithiummessage"

Record<string, string[]>

{}