Skip to content

Commit

Permalink
Merge pull request #193 from creative-commoners/pulls/4/versioned-but…
Browse files Browse the repository at this point in the history
…ton-state

ENH Set Published button dirty state when Link is an unpublished state
  • Loading branch information
sabina-talipova authored Jan 31, 2024
2 parents ee002f4 + 5155f17 commit 03ffff8
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 3 deletions.
2 changes: 1 addition & 1 deletion client/dist/js/bundle.js

Large diffs are not rendered by default.

46 changes: 44 additions & 2 deletions client/src/components/LinkField/LinkField.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ const section = 'SilverStripe\\LinkField\\Controllers\\LinkFieldController';
const LinkField = ({
value = null,
onChange,
onNonPublishedVersionedState,
types = {},
actions,
isMulti = false,
Expand Down Expand Up @@ -136,7 +137,7 @@ const LinkField = ({
/**
* Update the component when the 'Delete' button in the LinkPicker is clicked
*/
const onDelete = (linkID, deleteType) => {
const handleDelete = (linkID, deleteType) => {
const versionState = data[linkID]?.versionState || '';
const isVersioned = ['draft', 'modified', 'published'].includes(versionState);
const deleteText = isVersioned
Expand Down Expand Up @@ -172,6 +173,46 @@ const LinkField = ({
onChange(isMulti ? Object.keys(newData) : 0);
};

/**
* Update the edit form "Publish" button state to be dirty when an link has an
* unpublished version state
*
* We do not update the state of the "Save" button because LinkField exclusively updates
* via AJAX so that there's no need to save the page to update a Link DataObject
*
* This is fairly hackish code that directly manipulates the DOM, however there's no
* clean way to do this since the publish button is not a react component, and the existing
* jQuery change tracker does not allow independently updating only the publish button
*/
const handleUnpublishedVersionedState = () => {
const cssSelector = [
// CMS page edit form publish button
'.cms-edit-form button[data-text-alternate]#Form_EditForm_action_publish',
// GridField managed DataObject edit form publish button
'.cms-edit-form button[data-text-alternate]#Form_ItemEditForm_action_doPublish'
].join(',');
const publishButton = document.querySelector(cssSelector);
if (!publishButton) {
return;
}
const dataBtnAlternateRemove = publishButton.getAttribute('data-btn-alternate-remove') || '';
dataBtnAlternateRemove.split(' ').forEach((className) => {
if (className) {
publishButton.classList.remove(className);
}
});
const dataBtnAlternateAdd = publishButton.getAttribute('data-btn-alternate-add') || '';
dataBtnAlternateAdd.split(' ').forEach((className) => {
if (className) {
publishButton.classList.add(className);
}
});
const dataTextAlternate = publishButton.getAttribute('data-text-alternate');
if (dataTextAlternate) {
publishButton.innerHTML = dataTextAlternate;
}
}

/**
* Render all of the links currently in the field data
*/
Expand All @@ -194,8 +235,9 @@ const LinkField = ({
versionState={data[linkID]?.versionState}
typeTitle={type.title || ''}
typeIcon={type.icon}
onDelete={onDelete}
onDelete={handleDelete}
onClick={() => { setEditingID(linkID); }}
onUnpublishedVersionedState={handleUnpublishedVersionedState}
canDelete={data[linkID]?.canDelete ? true : false}
isMulti={isMulti}
isFirst={i === 0}
Expand Down
5 changes: 5 additions & 0 deletions client/src/components/LinkPicker/LinkPickerTitle.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ const LinkPickerTitle = ({
typeIcon,
onDelete,
onClick,
onUnpublishedVersionedState,
canDelete,
isMulti,
isFirst,
Expand Down Expand Up @@ -78,6 +79,9 @@ const LinkPickerTitle = ({
const deleteText = ['unversioned', 'unsaved'].includes(versionState)
? i18n._t('LinkField.DELETE', 'Delete')
: i18n._t('LinkField.ARCHIVE', 'Archive');
if (['draft', 'modified'].includes(versionState)) {
onUnpublishedVersionedState();
}
return <div
className={className}
ref={setNodeRef}
Expand Down Expand Up @@ -129,6 +133,7 @@ LinkPickerTitle.propTypes = {
typeIcon: PropTypes.string.isRequired,
onDelete: PropTypes.func.isRequired,
onClick: PropTypes.func.isRequired,
onUnpublishedVersionedState: PropTypes.func.isRequired,
canDelete: PropTypes.bool.isRequired,
isMulti: PropTypes.bool.isRequired,
isFirst: PropTypes.bool.isRequired,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ function makeProps(obj = {}) {
disabled: false,
onDelete: () => {},
onClick: () => {},
onUnpublishedVersionedState: () => {},
isMulti: false,
isFirst: false,
isLast: false,
Expand Down

0 comments on commit 03ffff8

Please sign in to comment.