Skip to content

allow for custom heading config options (models) #459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brandonkelly merged 2 commits into from
Aug 18, 2025
Merged

allow for custom heading config options (models) #459

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68277e6
allow for custom heading config options (models)
i-just Aug 18, 2025
424a539
Release note
brandonkelly Aug 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Release Notes for CKEditor for Craft CMS

## Unreleased

- Fixed a bug where heading levels specified via `heading.options` were being ignored if their corresponding checkbox wasn’t checked. ([#456](https://github.com/craftcms/ckeditor/issues/456))

## 3.14.0 - 2025-08-12

- Fixed a bug where the CKEditor toolbar overflow menu could be cut off within Live Preview. ([#417](https://github.com/craftcms/ckeditor/issues/417))
Expand Down
13 changes: 9 additions & 4 deletions src/Field.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -481,11 +481,16 @@ protected function inputHtml(mixed $value, ElementInterface $element = null): st
// see https://github.com/craftcms/ckeditor/issues/431
const baseHeadings = $baseConfigJs?.heading?.options;
const configOptionHeadings = $configOptionsJs?.heading?.options;
const nativeHeadingModels = ['paragraph', 'heading1', 'heading2', 'heading3', 'heading4', 'heading5', 'heading6'];
if (baseHeadings && configOptionHeadings && baseHeadings != configOptionHeadings) {
// use baseHeadings as our base as those options account for selection from the "Heading Levels"
let headings = baseHeadings.map(function(baseHeadingItem) {
// if there's an option in the configOptionHeadings that matches the same model, then use its config
let match = configOptionHeadings.filter(configOptionHeadingItem => configOptionHeadingItem.model === baseHeadingItem.model);
// use configOptionHeadings as our base as those options can have custom settings
let headings = configOptionHeadings.map(function(configOptionHeadingItem) {
// if there's an option in the baseHeadings that matches the same model, then use its config
let match = baseHeadings.filter(baseHeadingItem => baseHeadingItem.model === configOptionHeadingItem.model);
// if there isn't, check if this option is fully custom (not a native heading model) - if so, allow it
if (match.length == 0 && !nativeHeadingModels.includes(configOptionHeadingItem.model)) {
match[0] = configOptionHeadingItem;
}
return match.length > 0 ? match[0] : null;
});

Expand Down