Definition Item
Description
The Definition Item component is an atomic text element designed to display a term and its corresponding definition. It's structured as a description list (<dl>) with a term (<dt>) and a definition (<dd>). The component is nestable and supports markdown formatting for the definition text.
Installation
bash
sabaccui add definitionItem
Usage
Here's an example of how to use the Definition Item component in a Storyblok block:
Preview
Schema
| Field | Type | Description | Default |
|---|---|---|---|
term | text | The term or concept being defined. This field is required and translatable. | None |
definition | markdown | The explanation or definition of the term. This field supports markdown formatting and is translatable. | None |
Related Components
Notes
- The component uses a two-column grid layout on medium and larger screens.
- The term is displayed in the right column with gray, semibold text.
- The definition is rendered using a Markdown component, allowing for rich text formatting.
- The component is editable within the Storyblok interface.
Best Practices:
- Keep terms concise and clear.
- Use markdown formatting in the definition to enhance readability and highlight important points.
- Ensure that the term and definition are semantically related and provide value to the user.
- Consider the responsive layout when writing definitions, as they may appear differently on smaller screens.