Key Features

New group display mode for Quick Form widget (#63)

Added support for grouping properties by language, for multilingual form properties.

{
    "type": "charcoal/admin/widget/quick-form",
    "form_ident": "quick-edit",
    "group_display_mode": "lang"
}

Improve language switcher

With the aforementioned new feature, new interfaces have been introduced to assist with controlling the form's language switcher:

• HasLanguageSwitcherInterface — Classes that implement this interface are in charge of displaying or hiding the switcher as well as deciding of that state.
• LanguageSwitcherAwareInterface — Classes that implement this interface can be used to determine if the language switcher should be displayed or hidden.

Improved reloading in widget.js

Added methods:

• Widget#is_reloading() with internal property to track when a widget is reloading itself.
• Widget#try_reload() to call Widget#reload() if the widget is not already busy reloading itself.

Improved error handling in form.js

Added properties attempts and max_attempts (defaults to 5) to track if the form is busy or blocked/broken and try to warn user with feedback.

Improved language switching in form.js

Deprecated custom event switch_language.charcoal in favour of new custom events:

• beforelanguageswitch.charcoal.form triggered before language switch and allow for cancelling of action via event.preventDefault().
• languageswitch.charcoal.form triggered after language switch (supersedes switch_language.charcoal).

Refactored internals of attachment.js

⚠️ [BC] This MAY break any JS component that extends or customizes Widget_Attachment.

🩹 Fixed saving issues introduced in 0.30.0

Repurposed dirty property to track any changes to the blocks:

• When the sortable positions of blocks have changed.
• When a block is added.

Added busy property and methods to track when the widget is processing changes:

• When blocks are being attached (joined) to a content model or parent block.
• When a block is being dettached.

Replaced switch_language.charcoal event listener with listeners on new events for switching language:

• beforelanguageswitch to check if widget is busy (and cancel the switch) and to check if widget is dirty (and save changes).
• languageswitch (reload the widget).

What's new in 0.30.4?

Complete commits list: https://github.com/locomotivemtl/charcoal-admin/compare/0.30.3...0.30.4

Updated

• NPM
  • bootstrap-table v1.12.1 → v1.19.1
  • echarts v5.3.2 → v5.3.3
  • eslint v6.8.0 → v8.6.0
  • jsoneditor v9.7.4 → v9.9.0
  • tinymce v5.10.4 → v5.10.5

Added

• [PHP] Added interface Charcoal\Admin\Ui\FormGroupInterface, which extends Charcoal\Ui\FormGroupInterface, to declare groupProperties() method.
• [PHP] Added methods hasL10nGroupProperties() and isL10nModelProperty() to decouple property check from iteration of form properties (hasL10nFormProperties()) on ObjectFormWidget.
• [PHP] Added Sorter utility class to centralize sorting by priority comparator functions to minimize duplicate code.
• [SCSS] Merged styles from abandoned selectize-bootstrap-4 (papakay/selectize-bootstrap-4-style).

Changed

• [PHP] Improved ObjectFormWidget#hasL10nFormProperties() to iterate group properties (instead of the form's properties) on the record model or blank model (instead of just the blank model).
• [JS] Improved event namespacing in JS components by ensuring EVENT_NAMESPACE property is available as an instance member and a static member.
• [JS] Improved handling of XHR requests in attachment.js to track failures.
• [JS] Improved internals of feedback.js, assertion and validation of levels, display modes, and messages.
• [JS] Improved widget.js with access to the XHR object that handles "widget/load" request to the dialog object to allow others to extend Promise.
• [JS] Improved validate/save in component_manager.js, by passing scope to help with validating and saving data.
• [JS] Improved error messages in component_manager.js.
• Updated ESLint rules to allow coercive equality for null.

Removed

• Abandoned NPM dependency papakay/selectize-bootstrap-4-style, merged styles into Admin.

Fixed

• [JS] Disabled will_save constraint in attachment.js to revert to initial behaviour of always saving no matter the context.
  • The reason for this is that the attachment widget is often integrated as adjacent to the form widget instead of being nested.
• [JS] Fixed Charcoal.Admin.resolveSimpleJsonXhr() in charcoal.js.
  • Since Promises are chainable (in this scenario, jQuery's Deferred object), we now ensure we chain the success, failure, and complete callbacks.
• By merging styles from and removing dependency the abandoned selectize-bootstrap-4:
  • [SCSS] Skip duplicate inclusion of all of Bootstrap v4.
  • [NPM] Misuse of NPM dependencies which installed Gulp (which we don't use) and constrained ESLint to v6 (where grunt-eslint requires v8).

Complete commits list: https://github.com/locomotivemtl/charcoal-admin/compare/0.30.2...0.30.3

Summary

• Improved performance of exporter y using LazyCollectionLoader to prevent memory errors when fetching a large collection.
• Deactivated time limit for exporter controller since large collections will probably take more than the default 30 seconds to export.

Complete commits list: https://github.com/locomotivemtl/charcoal-admin/compare/0.30.1...0.30.2

Summary

Added module assets collection to support JavaScript ES6–ES11.

Key Features

Use name in ACL Role for admin users

⚠️ [BC] This MAY break Adminland or ACL Roles dashboards if Roles do not have a name value.

Use the ACL Role's name property, instead of its ident, for Admin users.

What's new in 0.30.1?

Complete commits list: https://github.com/locomotivemtl/charcoal-admin/compare/0.30.0...0.30.1

Changed

• Cleaned-up ACF Role class and metadata.

Removed

• Removed AclRole#key() method since unchanged from base class in locomotivemtl/charcoal-user.

Fixed

• Fixed JSON syntax in config/admin.config.default.json.

Key Features

Improved component management

Previously, when reloading a widget often the new HTML contained a new widget registration call which would duplicate its occurrence in the Component Manager.

Now, the Component Manager will check if a component was already registered with a given ID and type before adding it to its internal lists.

These changes should reduce the number of duplicate and obsolete components in the Manager.

Also, when a widget is reloading, it will now call its destroy() method before injecting the new HTML.

Improved form/property/widget validation and submission

⚠️ [BC] This MAY break any JS component that extends Widget_Form or Widget_Quick_Form.

Previously, Widget_Form#submit_form() and Widget_Quick_Form#submit_form() would call Manager#prepare_submit() which called the Component#validate() and Component#save() methods (if defined) on every registered property input or widget. Unfortunately, any return type from those component methods were ignored preventing a component from stopping form submission and by extension dispatching feedback.

Now, the form submission can be aborted by a component.

The Manager#prepare_submit() (via the new method Manager#prepare_components()) will bail early on the first Component#validate() or Component#save() that returns false, otherwise form submission will proceed.

The Manager#prepare_components() method will also call methods Component#will_validate() and Component#will_save() (if defined), providing the parent component that called it (if provided), to determine if the component should validate or save. This is useful to avoid validating and saving components outside of the form (or other container-type components).

Any feedback added during these steps will be displayed during the form's request_complete() method.

Custom events for form validation and submission

⚠️ [BC] This MAY break any JS event listeners on elements of Widget_Form or Widget_Quick_Form.

⚠️ [BC] This WILL break saving of Widget_Attachment if declared adjacent to Widget_Form as opposed to nested.

🩹 Fixed saving issues in 0.30.4

Added custom events triggered when form validation fails, form submission fails, succeeds, or completes.

Example of events for Widget_Form:

$($0).on('failed.charcoal.form', (event) => console.log(event));
// → Event {
//     subtype: 'validation'
//     component: Widget_Form
//   }
// 
//   Event {
//     subtype: 'submission'
//     component: Widget_Form
//     response: {…}
//   }
$($0).on('success.charcoal.form', (event) => console.log(event));
// → Event {
//     subtype: 'submission'
//     component: Widget_Form
//     response: {…}
//   }
$($0).on('complete.charcoal.form', (event) => console.log(event));
// → Event {
//     subtype: 'submission'
//     component: Widget_Form
//     response: {…}
//   }

Example of equivalent events for Widget_Quick_Form:

// Widget_Quick_Form
$($0).on('failed.charcoal.quickform', (event) => console.log(event));
$($0).on('success.charcoal.quickform', (event) => console.log(event));
$($0).on('complete.charcoal.quickform', (event) => console.log(event));

Predefined form validation messages

Added generic form validation messages (localized in English and French) based on browser's default messages for Constraint validation API.

Useful for providing informative predefined messages when creating validation constraints in PHP or JS.

Example in JS using formWidgetL10n object:

formWidgetL10n.validation.badInput;

formWidgetL10n.validation.patternMismatchWithFormat.replace('{{ format }}', 'H0H 0H0');

Example in PHP using the Translator service:

$translator->trans('form.validation.bad_input');

$translator->trans('form.validation.pattern_mismatch_with_format', [
    '{{ format }}' => 'H0H 0H0'
]);

Improved form sidebar appearance

Added support for position sticky (enabled by default) to improve scrolling of sidebar. Useful if the sidebar is taller than the screen.

BC Breaks

If you were previously calling or overriding the submit_form() method on Widget_Form or Widget_Quick_Form:

1. Replace submit_form() with request_submit().
2. The two methods no longer receive the form element, use the Widget_Form#$form and Widget_Quick_Form#$form properties respectively.
3. The new method should trigger a custom failed event if Manager#prepare_submit() returns false.

The Widget_Form#submit_form() method has been repurposed to only handle the making of XHR request. In its place, the submit event listener will (and developers should) call Widget_Form#request_submit() which will handle validation and then call submit_form().

If you were previously calling or overriding the enable_form() and disable_form() methods on Widget_Form or Widget_Quick_Form:

1. The methods no longer receive the form element, use the Widget_Form#$form and Widget_Quick_Form#$form properties respectively.

If you were previously calling or overriding the request_done(), request_success(), request_failed(), and request_complete() methods on Widget_Form or Widget_Quick_Form:

1. These methods no longer receive $form or $trigger parameters, use the Widget_Form#$form and Widget_Quick_Form#$form properties respectively and $form.find('[type="submit"]').
2. The latter three methods should trigger their respective custom events.

If you were previously using the .charcoal.bs.dialog and .charcoal.form.quick events from Widget_Quick_Form:

1. Rename those events to .charcoal.quickform.

What's new in 0.30.0?

Complete commits list: https://github.com/locomotivemtl/charcoal-admin/compare/0.29.1...0.30.0

Added

• [JS] Added method Manager#has_component() to check if a raw component or component instance is registered.
• [JS] Added method Manager#destroy_component() to destroy component and remove a component from manager.
• [JS] Added method Manager#create_component() to decouple component instantiation.
• [JS] Added dialog as second parameter to Widget#dialog() callback parameter to be able to interact with dialog.
• [JS] Added return of dialog in Widget#confirm() instead of void.
• [JS] Added option with_data to Widget_Attachment's XHR call to load the QuickFormWidget to ensure its widget data is included and used in the dialog.
• [JS] Added EVENT_NAMESPACE to Widget_Form and Widget_Quick_Form, similar to Property_Input_File and its derivatives.
• [JS] Added method Widget_Form#add_actions_for_confirmation to decouple adding feedback actions for needs_confirmation response setting.
• [JS] Added support for customizing the needs confirmation label "Continue" with confirmation_label.
• [JS] Added method Widget_Form#add_action_for_next_url to decouple adding feedback action to continue to next_url response setting.
• [JS] Added support for customizing the next URL label "Continue" with next_url_label.
• [JS] Added support for absolute URIs for next_url.
• [JS] Added support for custom save_action and update_action URIs on Widget_Form.

Changed

• [JS] Reduced duplicate code (such as "conditional groups") and shared missing parity (such as "needs confirmation") between Widget_Form and Widget_Quick_Form.
• [JS] Improved error messages to include component ID, if available, in Manager.

Removed

• [JS] Replaced variable arr in favour of Array.prototype in Component Manager.

Fixed

• [JS] Destruction of Widget_Quick_Form when dialog is closed in Widget_Attachment and Widget_Relation to avoid polluting Component Manager with obsolete components.
• [JS] Close only the current dialog instead of all dialogs in Widget_Form and Property_Input_Selectize_Tags.
• [CSS] Fixed page scrolling when Bootstrap modal is open.

Key Features

Split Selectize property input views

Moved form control markup and JS component registration from property input view (selectize.ms and selectize/tags.ms) to a separate partial views (selectize/control.ms, selectize/tags/control.ms, and selectize/js.ms), like for TinyMCE property input.

This will allow for easier customization of a Selectize input view (such as altering the JS registration but not the form control).

What's new in 0.29.1?

Complete commits list: https://github.com/locomotivemtl/charcoal-admin/compare/0.29.0...0.29.1

Updated

• Composer
  • studio-42/elfinder v2.1.60 → v2.1.61
• NPM
  • echarts v5.3.0 → v5.3.2
  • jsoneditor v9.7.2 → v9.7.4
  • tempusdominus-bootstrap-4 v5.39.0 → v5.39.2
  • tempusdominus-core v5.19.0 → v5.19.3
  • tinymce v5.10.3 → v5.10.4

Fixed

• [JS] Escape of single-quote characters in Widget_Search.

Key Features

Improved model property validation feedback

The model property's label will be prepended, if missing, to the validator result message to provide context as to which data is invalid when saving changes.

What's new in 0.29.0?

Complete commits list: https://github.com/locomotivemtl/charcoal-admin/compare/0.28.2...0.29.0

Added

• Method FeedbackContainerTrait::addFeedbackFromValidatable()
• Method FeedbackContainerTrait::addFeedbackFromValidator()
• Method FeedbackContainerTrait::addFeedbackFromValidatorResult()
• Method AbstractSaveAction::isValidatable()
• Method AbstractSaveAction::addFeedbackFromModel() (replaces addFeedbackFromValidation())
• Method AbstractSaveAction::addFeedbackFromModelValidatorResult()

Removed

• Method AbstractSaveAction::addFeedbackFromValidation()

Key Features

Improved volume localizations for elFinder

Added support for custom localization of directory and volume names.

Currently, directories will not be localized but volumes (roots) will be localized based your project's filesystem connection labels (filesystem.connections.<ident>.label) or filesystem connection identifiers (translation key: filesystem.volume.<ident>).

On its own, elFinder can localize a directory or volume using its basename (translation keys: folder_<basename> and volume_<basename>). This can be problematic with volumes that share the same basename (for example an "uploads" directory in your project's base path and one in your project's public path).

To enable custom localizations, you need to add an event listener for all elFinder commands to intercept the results:

{
    "elfinder": {
        "connector": {
            "roots": {/* … */},
            "bind": {
                "*": [
                    ":translateDirectoriesOnAnyCommand"
                ]
            }
        }
    }
}

Afterwards, you can either add translations to your localization files:

// messages.en.csv
"filesystem.volume.remote";"External"

// messages.fr.csv
"filesystem.volume.remote";"Externe"

Or add a label to your filesystem connection.

{
    "filesystem": {
        "connections": {
            "remote": {
                "label":  {
                    "en": "External",
                    "fr": "Externe"
                },
                "public": false,
                "type": "sftp",
                "port": 22,
                "privateKey": "…",
                "root": "…",
                "timeout": 3600
            }
        }
    }
}

The default filesystem connections, public and private, are already localized in English and French.

What's new in 0.28.2?

Complete commits list: https://github.com/locomotivemtl/charcoal-admin/compare/0.28.1...0.28.2

Updated

• NPM:
  • clipboard v2.0.8 → v2.0.10
  • echarts v5.2.2 → v5.3.0
  • jsoneditor v9.6.0 → v9.7.2
  • postcss v8.4.5 → v8.4.7
  • tinymce v5.10.2 → v5.10.3
  • tinymce-i18n v20.12.25 → v22.2.11

Added

• Support for disabling an elFinder localization (using null via application config admin.elfinder.translations.<id>).
• View partial 'inc.page-header-inner.ms, split from inc.page-header.ms to allow for customizing the page header wrapper.
• CSS class modifier .-small@to-large to collapsing the fixed height of the page header wrapper.

Removed

• Obsolete elFinder option disable_theme.
• Obsolete property factory from ElfinderConnectorAction controller.

Changed

• Replaced Charcoal English localization messages with keys for elFinder, media library, and file manager strings.
• Renamed English and French localizations of volume_uploads from "Public" to "Storage" to avoid confusion with default file system volumes ("Public" and "Private").
• Decoupled sanitization from sanitizeOnUploadPreSave() method into dedicated sanitizeFileName() method to improve customizability.

Complete commits list: https://github.com/locomotivemtl/charcoal-admin/compare/0.28.0...0.28.1

Summary:

• Improve object save/update action controllers:
  • Prefixed getter methods with get (authorIdent, saveData, and updateData).
  • Added methods SaveAction::filterSaveData() and UpdateAction::filterUpdateData() to allow for subclasses of these controllers to parse/filter data before its merged into the target model.
  • Exclude widget_id and next_url from being merged into target models. These values are defined by the form widget for handling the widget in case of reloads.
• Fixed labelling typos in file input properties.
• Fixed focusin event conflict between TinyMCE and Bootstrap Dialog.

Key Features

Requirements

Require Node v14.17.

Dynamic template for form groups partial

Adds support for swapping out the partial used for rendering the form's collection of groups. Useful to avoid overriding the form widget partial.

Usage:

"forms": {
    "default": {
        "groups_template": "app/admin/template/form/my-groups-wrapper",
        "groups": {…}
    }
}

{{# obj.showNotice }}
    {{> app/admin/template/form/my-custom-notice }}
{{/ obj.showNotice }}

{{> charcoal/admin/template/form/groups-wrapper }}

Dynamic template for form tabs partial

Adds support for swapping out the partial used for rendering the form's tabs. Useful to avoid overriding the form widget partial.

The form widgets use form/nav-tabs.ms, by default. The quick form widgets use form/nav-pills.ms, by default.

Usage:

"forms": {
    "default": {
        "tabs_template": "app/admin/template/form/my-custom-tabs",
        "groups": {…}
    }
}

What's new in 0.28.0?

Complete commits list: https://github.com/locomotivemtl/charcoal-admin/compare/0.27.2...0.28.0

Updated

• CDN:
  • Foundation Emails v2.2.1 → v2.3.1
  • RequireJS v2.3.5 → v2.3.6
• Composer:
  • studio-42/elfinder v2.1.59 → v2.1.60
• NPM:
  • Dev dependencies
  • Bootstrap v4.6.0 → v4.6.1
  • eCharts v5.1.2 → v5.2.2
  • JSON Editor v9.5.1 → v9.6.0
  • TinyMCE v5.8.2 → v5.10.2

Added

• Add support for minified Admin JS assets; if debug mode is disabled, use minified JS.
• Add support for novalidate option to disable browser form validation [1c4c4ff].
• Migrate nav-pills partial from locomotivemtl/charcoal-cms v0.10.0.

Changed

• Use minimified assets for JSON Editor.
• Change eCharts enqueue type from Mustache helper to Assetic helper.
• Relative path to elFinder Moono theme to take advantage of RequireJS' require.toUrl() method to correctly process relative path as an absolute URI.
• Clean-up form-based mustache views.

Fixed

• Fix line-breaks in compiled assets.

Key Feature

Refactor ReadonlyInput

Property value is now rendered as input value instead of display value, by default, to more closely match the fact that the class is a property input.

Added

• Input option render_type (defaults to input) to decide if value is rendered using inputVal() or displayVal().
• Input option show_as_code_block (defaults to false) to render value as <pre> code block.
• Input option maybe_input_is_serialized (defaults to false) to attempt to parse value as a JSON string to pretty print the value.

Changed

• Replaced hasInputVal() with hasPropertyVal().

What's new in 0.27.2?

Complete commits list: https://github.com/locomotivemtl/charcoal-admin/compare/0.27.1...0.27.2

Added

• Methods getDisplayOption() to AbstractPropetyDisplay and getInputOption() to AbstractPropetyInput for retrieving a single option.
• Methods hasInputPrefix() and hasInputSuffix() to AbstractPropertyInput.

Changed

• Updated commonL10n localizations.
• Improved variable names in Widget\LoadAction.
• Improved check of non-scalar values in AbstractProperty:hasPropertyVal() method.
• Improved return value of inputPrefix(), inputSuffix(), and placeholder() on AbstractPropertyInput.
• Improved resolution of value in setPlaceholder() on AbstractPropertyInput.

Fixed

• Fixed display_escape and input_escape setters on property display and property input.
• Added current language code and locale to FormGroupWidget to fix an edge case where a widget relied on the template controller for the locale and the widget is reloaded via Widget\LoadAction which does not have a controller context.

Complete commits list: https://github.com/locomotivemtl/charcoal-admin/compare/0.27.0...0.27.1

Updated:

• locomotivemtl/charcoal-app ~0.8 → ~0.9

Key Features

Refactor Property Display + Property Input

Added base class AbstractProperty and PropertyInterface shared by AbstractPropertyDisplay and AbstractPropertyInput to reduce duplication of code and add missing common features.

Added get-prefixed methods and changed non-prefixed getters to aliases of the former.

Escape Property Values

Added support to escape display and input values. The feature is disabled (false), by default. If the feature is enabled (true), the default function is htmlspecialchars(). The escape option is a function name or expression and optional parameters.

• For display properties, the option is display_escape.
• For input properties, the option is input_escape.

Useful for escaping special characters such as "<" and ">" in email addresses ("[email protected]").

"email_address": {
    "type": "email",
    "input_type": "charcoal/admin/property/input/readonly",
    "display_escape": true
}

$input->setEscape('htmlentities');

$input->setEscape(function ($value) {
    return htmlentities($value, ENT_QUOTES, 'UTF-8');
});

$input->setEscape([
    'function'   => 'htmlentities',
    'parameters' => [ ENT_QUOTES | ENT_IGNORE, 'UTF-8' ],
]);

What's new in 0.27.0?

Complete commits list: https://github.com/locomotivemtl/charcoal-admin/compare/0.26.2...0.27.0

Added

• Method hasMessage to MessageDispay.
• Escaping of message in MessageDisplay where HTML is expected.
• Escaping of value in ReadonlyInput property where HTML is expected.

Fixed:

• Undefined variable $val in hasPropertyVal() of AbstractPropertyInput.

Key Feature

Message Property Display

New display property allows one to use a property as a placeholder for displaying text, such as a heading or advanced instruction (see example below).

{
    "heading": {
        "type": "string",
        "storable": false,
        "output_type": "display",
        "display_type": "charcoal/admin/property/display/message",
        "message": {
            "en": "<h3 class=\"pb-2 mb-n2 border-bottom\">My Heading</h3>"
        },
        "show_label": false
    }
}

What's new in 0.26.2?

Complete commits list: https://github.com/locomotivemtl/charcoal-admin/compare/0.26.1...0.26.2

Summary

• Added MessageDisplay property display.
• Added view service to AbstractPropertyDisplay for parity with AbstractPropertyInput.
• Changed nav tab tooltip to use tab_title instead of title.
• Fixed ObjectFormWidget::hasL10nFormProperties(); use prototype model instead of existing model to allow for use with new models.

Key Feature

Force form to reload page (#52)

Added an optional form widget property (force_page_reload) that when true will force a page reload after submitting the form.

Example:

"admin.edit": {
    "widgets": {
        "form": {
            "type": "charcoal/admin/widget/object-form",
            "obj_type": "app/model/foobar",
            "form_ident": "default",
            "force_page_reload": true
        }
    }
}

What's new in 0.26.1?

Complete commits list: https://github.com/locomotivemtl/charcoal-admin/compare/0.26.0...0.26.1

Key Features

Requirements

• Require PHP ^7.3 or ^8.0.
• Require Node 14.15 via .nvmrc. This will improve the reliability of installed packages and mitigate accidental major changes to the lock file.

JSON Editor

⚠️ [BC] This WILL break any custom assets or views referencing the previous path.

Moved distribution from assets/dist/scripts/vendors/jsoneditor to assets/dist/jsoneditor.

TinyMCE

⚠️ [BC]

• This MAY break any third-party plugins that do not support TinyMCE v5.
• This WILL break any custom assets or views referencing the previous path.
• This WILL break any custom assets or views referencing obsolete themes.

Migrated from v4 to v5.

Changed:

• Moved core distribution from assets/dist/scripts/vendors/tinymce to assets/dist/tinymce.
• Moved custom plugins from assets/src/scripts/charcoal/admin/tinymce to assets/src/scripts/tinymce.

Removed:

• Mobile theme; replaced with Silver theme.
• Modern theme; replaced with Silver theme.
• Modern Inline theme; replaced with Silver Inline.
• Inlite theme; replaced with Quick Toolbar (quickbars) plugin.

TableWidget object action styles

Changed pairing of Bootstrap .btn-* styles for row actions. Defaults to "seamless" instead of "dark" when parsing row actions.

What's new in 0.26.0?

Complete commits list: https://github.com/locomotivemtl/charcoal-admin/compare/0.25.1...0.26.0

Updated:

• Composer:
  • barryvdh/elfinder-flysystem-driver v0.2 → v0.3
  • phpunit/phpunit v7.5 → v9.0
  • seld/jsonlint v1.7 → v1.8
  • squizlabs/php_codesniffer v3.3 → v3.5
  • tedivm/stash v0.14 → v0.16
• NPM:
  • Dev dependencies
  • Bootstrap v4.5.3 → v4.6.0
  • eCharts v4.9.0 → v5.1.2
  • elFinder v2.1.57 → v2.1.59
  • jQuery v3.5.1 → v3.6.0
  • jQuery UI Bundle v1.12.1 → v1.12.1-migrate
  • JSON Editor v9.1.2 → v9.5.1
  • Tempusdominus Bootstrap 4 v5.1.0 → v5.39.0
  • Tempusdominus Core v5.0.3 → v5.19.0
  • TinyMCE v4.9.11 → v5.8.2
  • TinyMCE i18n v19.9.17 → v20.12.25

Added:

• Support to TableWidget for improved end-user customizations to list and object actions.
• Polyfill for assertArraySubset(), deprecated in PHPUnit v8, and removed in PHPUnit v9.

Changed:

• Improved rendering of actions, action button style, and spacing around empty table notice.
• Cleaned up custom Charcoal plugin for TinyMCE.
• Cleaned-up unit test classes.

Removed:

• JS console log in Login page template.
• PHP error log in Logout action controller.

Complete commits list: https://github.com/locomotivemtl/charcoal-admin/compare/0.25.0...0.25.1

Summary:

• Added support for parsing Translation structures SelectizeInput.
• Added bootstrap-select localizations to distribution assets.
• Added localization of SelectizeInput placeholder.
• Fixed directory permissions of Admin assets in CopyAssetsScript.
• Fixed constraint of mcaskill/php-html-build-attributes.

Key Features

Requirements

• PHP ^7.3
• locomotivemtl/charcoal-object ~8.0

BC Breaks

Assetic collections must be scoped. This container allows adding more files to some collections without overwriting others:

"assets": {
    "collections": {
        "tabulator": {
            "files": [
                "assets/admin/scripts/property/input/tabulator.js"
            ]
        },
        "utils": {
            "files": [
                "assets/admin/scripts/utils.js"
            ]
        },
        "js": {
        }
    }
}

"assets": {
    "collections": {
        "js": {
            "tabulator": {
                "files": [
                    "assets/admin/scripts/property/input/tabulator.js"
                ]
            },
            "utils": {
                "files": [
                    "assets/admin/scripts/utils.js"
                ]
            }
        }
    }
}

What's new in 0.25.0?

Complete commits list: 0.24.6...0.25.0

Added:

• Scoping to assets manager collections (see example below).
• Support for passing a form_data array to SelectizeInput to prefill data in the quick form the same way passing form_data as a URI query parameter would prefil a page form.
• Methods to ReadonlyInput and PropertyInput to improve checking if value is empty or not.

Fixed:

• Merging issues in Assetic collections.
• Bad reference to master in HierarchichalObjectProperty.

Complete commits list: 0.24.5...0.24.6

Updated:

• Vulnerable packages (manually edited the lock file)
• autoprefixer v9.8.6 → v10.0.2
• grunt-postcss v0.9.0 → @lodder/grunt-postcss v3.0.0
• Bootstrap v4.5.2 → v4.5.3
• eCharts v4.8.0 → v4.9.0
• JSON Editor v9.0.4 → v9.1.2
• moment.js v2.27.0 → v2.29.1

Added:

• Video input property

Changed:

• Compile Admin assets

Fixed:

• Audio input property

Complete commits list: 0.24.4...0.24.5

Summary:

• Fixed sortability of tables when paginating
• Fixed table pagination when searching
• Added random identifier generator
• Fixex handling of collection config

Complete commits list: 0.24.1.1...0.24.2

Summary:

• Fixed a mustache syntax error in JsonEditorInput
• Update elFinder to v2.1.57

Complete commits list: 0.23.10.1...0.24.0

This release includes many small but important changes and corrections to Charcoal's JS framework.

Search Widget (PHP)

• Added support for disabling or customizing the SearchWidget in the CollectionTemplate.

  "dashboards": {
      "admin.collection": {
          "search": false,
          "widgets": {…},
          "layout": {…}
      }
  }
  

  "dashboards": {
      "admin.collection": {
          "search": {
              "type": "charcoal/admin/widget/app/my-search-widget",
              "collection_ident": "app/model/list",
              "properties": […]
          },
          "widgets": {…},
          "layout": {…}
      }
  }
  

Search Form (JS)

• Refactor Widget_Search to add support for passing the search input to widgets.
  • The search_query attribute is assigned to widgets that provide a set_search_query() method in the same way that the presence of set_filters() will receive the search input as a query filter object.
  • The search_query attribute can be used by server-side widgets as an alternative to the complex query filter object.

Component Options

• Fixed conflicting usage of opts and data properties.
  • this.opts is a core method of Component that holds the constructor options; MUST not be replaced (as was the case previously)
  • this.data is a local object property that holds the data subset of the constructor options (opts.data)

Notifications

• Appropriated suppress_feedback property from Widget_Form.
  • Moved property to Widget._suppress_feedback.
  • Added method Widget.suppress_feedback() to be used from now on.

  if (!this.suppress_feedback()) {
      Charcoal.Admin.feedback().dispatch();
  }
  
  this.suppress_feedback(false);
  

• Added support for overriding the default display mode for all feedback such as success and notice messages that, by default, are dispatched using toast notifications.

  var alerts = [ { level: 'notice', message: '…' } ];
  Charcoal.Admin.feedback(alerts).setDisplay('dialog').dispatch();
  

  var alerts = [ { level: 'warning', message: '…' } ];
  Charcoal.Admin.feedback(alerts).setDisplay('toast').dispatch();
  

AJAX

• Added support for error handling and feedback in XHR request to (re)load a widget:
  • Widget.prototype.reload()
• Added support for error handling and feedback in XHR request to delete an object:
  • Widget_Form.prototype.delete_object()

  protected function preDelete()
  {
      $this->logger->warning(sprintf(
          'Can not delete Section (#%s): Section is immutable.',
          $this->id()
      ));
      throw new Exception(
          $this->translator()->translate('section.delete.immutable')
      );
  }
  

• Added support to parse any message as feedback in success callback of XHR helper function:
  • Charcoal.Admin.resolveSimpleJsonXhr()
• Fixed error handling in XHR helper functions:
  • Charcoal.Admin.parseJqXhrResponse()
  • Charcoal.Admin.resolveSimpleJsonXhr()

Complete commits list: 0.23.4...0.23.5

Summary:

• Fixed form group widget bugs
• Fixed typo on <th> tag in TableWidget header
• [e8521cf] Fixed missing imports in ObjectRevisionsFormGroup

Complete commits list: 0.23.3...0.23.4

Summary:

• [#41] Added support to ElfinderConnectorAction for fetching allowed MIME types from Model Property config

Complete commits list: 0.23.2...0.23.3

Summary:

• Updated beneroch-gmap to v0.3.1
• Fixed concatenation of beneroch-gmap script
• Fixed elFinder URL improperly bound on AudioWidget
• Compiled Admin assets

Complete commits list: 0.23.1...0.23.2

Summary:

• Replaced zendframework/zend-permissions-acl with laminas/laminas-permissions-acl

Complete commits list: 0.23.0...0.23.1

Summary:

• Fixed missing parent constructor calls in JavaScript property widgets which prevented them from being stored correctly in the component manager
• Compiled Admin assets

Complete commits list: 0.22.3.1...0.23.0

Summary:

• Remove form_group_ prefixes on form group widgets

Complete commits list: 0.22.2...0.22.3

Requires:

• locomotivemtl/charcoal-object v0.7.2+

Summary:

• Fixed Object Revisions interface on widget, form group, and action controller
• Fixed Selectize action controller
• Fixed Selectize input property when data source is missing

Complete commits list: 0.22.1...0.22.2

Summary:

• Updated NPM dependencies
• Updated elFinder to v2.1.53
• Updated TinyMCE to v4.9.8
• Updated eCharts to v4.6.0
• Updated JSON Editor to v8.6.1
• Replaced JSHint/JSCS with ESLint
• Removed Yarn Lockfile in favour of NPM Lockfile
• Compiled Admin assets