Bard Fieldtype

Bard is more than just a content editor, and more flexible than a block-based editor It is designed to provide a delightful and powerful writing experience with unparalleled flexibility on your front-end.

bard.jpg Fieldtype UI
Behold! The 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 }}

With Sets

Use tag pair syntax with if/else conditions to style each set accordingly.

{{ bard_field }}

  {{ if type == "text" }}

    <div class="text">
      {{ text }}
    </div>

  {{ elseif type == "image" }}

    <figure>
      <img src="{{ image }}" alt="{{ caption }}" />
      <figcaption>{{ caption }}</figcaption>
    </figure>

  {{ /if }}

{{ /bard_field }}

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
|-- image.antlers.html
|-- poll.antlers.html
|-- text.antlers.html
`-- video.antlers.html

Extending Bard

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

Config Options

allow_source boolean

Controls whether the "show source code" button is available to your editors. Default: true.

sets array

An array containing sets of fields. If you don't provide any sets, Bard will act like a basic text/WYSIWYG editor and you won't see the "Add Set" button.

buttons array

An array of buttons you want available in the toolbar. You can choose from h1, h2, h3, h4, h5, h6, bold, italic, underline, strikethrough, unorderedlist, orderedlist, removeformat, quote, anchor, image, table, code (inline), and codeblock.

These are the defaults: Bard Buttons

target_blank boolean

Automatically add target="_blank" on links by default. You'll be able to override this per-link. Default: false.

link_noopener boolean

Set rel="noopener" on all created links. Default: false.

link_noreferrer boolean

Set rel="noreferrer" on all created links. Default: false.

fullscreen boolean

Enable the option to toggle into fullscreen mode. Default: true.

container string

An asset container ID. When specified, the fieldtype will allow the user to add a link to an asset from the specified container.

toolbar_mode string

Choose which style of toolbar you prefer, fixed or floating. Default: fixed.

reading_time boolean

Show estimated reading time at the bottom of the field. Default: false.

save_html boolean

Save HTML instead of structured data. This simplifies – but limits – control of your template markup. Default: false.

always_show_set_button boolean

Always show the "Add Set" button. Default: false.

Betterify this page on Github!