Bard Fieldtype

Overview

Bard is our recommended fieldtype for creating long form content from the control panel. It's highly configurable, intuitive, user-friendly, and writes impeccable HTML (thanks to ProseMirror).

Bard also has the ability to manage "sets" of fields inline with your text. These sets can contain any number of other fields of any fieldtype, and can be collapsed and neatly rearranged in your content.

Working With Sets

You can use any fieldtypes inside your Bard sets. Make sure to compare the experience with the other meta-fields: Grid and Replicator. You can even use Grids and Replicators inside your Bard sets. Just remember that because you can doesn't mean you should. Your UI experience can vary greatly.

Data Structure

Bard stores your data as a ProseMirror document. You should never need to interact with this data directly, thanks to augmentation.

Templating

Without Sets

If you are using Bard just as a rich text editor and have no need for sets you would use a single tag to render the content.

{{ bard_field }}

{!! $bard_field !!}

With Sets

When working with sets, you should use the tag pair syntax and if/else conditions on the type variable to style each set accordingly. Note: any content that is entered not in a set (i.e. your normal rich-text content) needs to be rendered using the "text" type. See the first condition using "text."

{{ bard_field }}
 
  {{ if type == "text" }}
    <div class="text">
      {{ text }}
    </div>
 
  {{ elseif type == "poll" }}
    <figure class="poll">
      <figcaption>{{ question }}</figcaption>
      <ul>
        {{ options }}
          <li>{{ text }}</li>
        {{ /options }}
      </ul>
    </figure>
 
  {{ elseif type == "hero_image" }}
    <div class="heroimage">
      <img src="{{ hero_image }}" alt="{{ caption }}" />
    </div>
  {{ /if }}
 
{{ /bard_field }}

@foreach ($bard_field_with_sets as $set)
    @if ($set->type === 'text')
    <div class="text">
        {!! $set->text !!}
    </div>
    @elseif ($set->type === 'poll')
    <figure class="poll">
        <figcaption>{{ $set->question }}</figcaption>
        <ul>
            @foreach ($set->options as $option)
                <li>{{ $option->text }}</li>
            @endforeach
        </ul>
    </figure>
    @elseif ($set->type === 'hero_image' && $hero_image = $set->hero_image)
        <div class="heroimage">
            <img src="{{ $hero_image }}" alt="{{ $hero_image->caption }}" />
        </div>
    @endif
@endforeach

An alternative approach (for those who like DRY or small templates) is to create multiple "set" partials and pass the data to them dynamically, moving the markup into corresponding partials bearing the set's name.

{{ bard_field }}
  {{ partial src="sets/{type}" }}
{{ /bard_field }}

resources/views/partials/sets/
   gallery.antlers.html
   hero_image.antlers.html
   poll.antlers.html
   text.antlers.html
   video.antlers.html

@foreach ($bard_field_with_sets as $set)
    @include('fieldtypes.bard.sets.'.$set->type, [...$set])
@endforeach

resources/views/partials/sets/
   gallery.blade.php
   hero_image.blade.php
   poll.blade.php
   text.blade.php
   video.blade.php

Extending Bard

Bard uses TipTap (which in turn is built on top of ProseMirror) as the foundation for our quintessential block-based editor.

Learn how to extend Bard

Custom set icons

You can change the icons available in the set picker by setting an icons directory in a service provider.

For example, you can drop this into your AppServiceProvider's boot method:

use Statamic\Fieldtypes\Sets;
 
public function boot()
{
    Sets::setIconsDirectory(folder: 'light');
}

Alternatively, if you want to use a different base directory altogether, you can do this:

Sets::setIconsDirectory(directory: resource_path('custom-icons'));

Options

\Statamic\Fieldtypes\Bard::setDefaultButtons(['h2', 'h3', 'bold', 'italic']);