Text

Class: Code16\Sharp\Show\Fields\SharpShowTextField

Configuration

setLabel

Set the field label.

collapseToWordCount

Collapse the text if too long, and add a "show more" link. Use it for long texts (even markdown formatted) in sections with only one field.

doNotCollapse

Reset the collapse configuration.

setHtml

By default, the text is escaped. If you want to display HTML, set this to true.

setSanitizeHtml

HTML sanitization is enabled by default for text fields (to prevent XSS attacks when displaying the show). To disable it, call -⁠>setSanitizeHtml(false).

allowEmbeds

This method expects an array of embeds that could be inserted in the content, declared as full class names. An embed class must extend Code16\Sharp\Form\Fields\Embeds\SharpFormEditorEmbed.

The documentation on how to write an Embed class is available here.

Transformer

For markdown-formatted texts, be sure to use the built-in MarkdownAttributeTransformer:

function find($id): array
{
    return $this
        ->setCustomTransformer(
            'description', 
            new MarkdownAttributeTransformer()
        )
        ->transform([...]);
}