atomic-smart-snippet

This is for:

Developer

In this article

The atomic-smart-snippet component displays the excerpt of a document that would be most likely to answer a particular query.

Properties

Property Attribute Description Type Default

Property	Attribute	Description	Type	Default
`headingLevel`	`heading-level`	The heading level to use for the question at the top of the snippet, from 1 to 5. We recommend setting this property in order to improve accessibility.	`number`	`0`

headingLevel

heading-level

The heading level to use for the question at the top of the snippet, from 1 to 5.

We recommend setting this property in order to improve accessibility.

number

0

Part Description

Part	Description
`answer`	The found document excerpt.
`footer`	The footer underneath the answer.
`question`	The header displaying the question that is answered by the found document excerpt.
`smart-snippet`	The wrapper of the entire smart snippet.
`source-title`	The title of the document the excerpt is from.
`source-url`	The URL to the document the excerpt is from.

answer

The found document excerpt.

footer

The footer underneath the answer.

question

The header displaying the question that is answered by the found document excerpt.

smart-snippet

The wrapper of the entire smart snippet.

source-title

The title of the document the excerpt is from.

source-url

The URL to the document the excerpt is from.