Upgrade from v2 to v3

• Type Names
• Breaking Changes
  • Defaults configuration field (Medium Impact)
  • Non-rendered toggle attribute values (Low Impact)
  • Bard Paragraph Style config format removed (Low Impact)
• Deprecated
  • Legacy configuration formats

Bard Texstyle 3 contains a couple of medium/low impact breaking changes. This is also a housekeeping release, with the goal of making the configuration simpler, more consistent with Statamic conventions, and add flexibility for future features. The old configuration formats will still work but support may be removed in the future so it would be best to update your config as soon as you can (see below).

#Type Names

Texstyle has always used Tiptap's extension names as type names. In Tiptap 1 these were snake case, but in Tiptap 2 they were changed to camel case. This left Texstyle using camel case even though snake case would be more consistent with Statamic conventions.

Texstyle 3 introduces new features that require type names that diverge from Tiptap's extension names. For this reason and to correct the inconsistency with Statamic conventions the preferred casing of type names is now snake case. Additionally, unordered_list is preferred over bulletList.

In order to minimise the impact of this change and make Texstyle as easy to use as possible Tiptap's camel case extension names will continue to work as aliases wherever possible.

#Breaking Changes

#Defaults configuration field (Medium Impact)

The defaults configuration field bts_default_classes has been renamed to bts_defaults. If you were using this option you can either update the relevant fields through the blueprint editor, or do a find and replace accross your yaml files.

#Non-rendered toggle attribute values (Low Impact)

The default non-rendered toggle attribute values are now true/false instead of true/null.

#Bard Paragraph Style config format removed (Low Impact)

Support for the Bard Paragraph Style configuration format has been removed. Please follow the migration guide.

#Deprecated

#Legacy configuration formats

The following changes have been made to the Bard Texstyle config. The old configuration formats will still work but support may be removed in the future so it would be best to update your config as soon as you can.

The heading style level option has been removed in favour of specifying one of six heading types in the type option instead:

'title' => [
    'type' => 'heading',
    'level' => 1,
    // ...
],
'title' => [
    'type' => 'heading',
    'level' => 1,
    // ...
],

'title' => [
    'type' => 'heading_1',
    // ...
],
'title' => [
    'type' => 'heading_1',
    // ...
],

The default_classes option has been renamed to defaults, heading types are no longer nested inside a single heading key, and each class is now an array with a class option:

'heading' => [
    1 => 'head-1',
],
'paragraph' => 'para',
'heading' => [
    1 => 'head-1',
],
'paragraph' => 'para',

'heading_1' => [
    'class' => 'head-1',
],
'paragraph' => [
    'class' => 'para',
],
'heading_1' => [
    'class' => 'head-1',
],
'paragraph' => [
    'class' => 'para',
],