Skip to content
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

Authoring-react keybindings #4196

Merged
merged 11 commits into from
Feb 7, 2023
Merged

Authoring-react keybindings #4196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
418ba70
Started woking on hotKeys functionality
dzonidoo Jan 30, 2023
759f64e
code style improvements
tomaskikutis Jan 30, 2023
a2baf20
apply save and close key bindings
tomaskikutis Jan 30, 2023
5700f96
Co-authored-by: Tomas Kikutis <[email protected]>
dzonidoo Feb 1, 2023
3713c6a
fix lint
dzonidoo Feb 1, 2023
3fba203
Changed getAction interface to be synchronous and added keybindings f…
dzonidoo Feb 1, 2023
ea8ec29
Finished keybindings basic functionality.
dzonidoo Feb 2, 2023
ecebafa
FIxed issue with dupicated code, and improve conditions for locking i…
dzonidoo Feb 3, 2023
0587e92
Naming Impovement
dzonidoo Feb 7, 2023
d3bf13d
FIxed Interface
dzonidoo Feb 7, 2023
4d790ed
Added return type for getKeyBindigsFromActions function
dzonidoo Feb 7, 2023
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
21 changes: 20 additions & 1 deletion scripts/apps/authoring-react/authoring-angular-integration.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,13 @@ function getInlineToolbarActions(options: IExposedFromAuthoring<IArticle>): IAut
/>
),
availableOffline: true,
keyBindings: {
'ctrl+shift+s': () => {
if (hasUnsavedChanges()) {
save();
}
},
},
};

const closeButton: ITopBarWidget<IArticle> = {
Expand All @@ -72,6 +79,11 @@ function getInlineToolbarActions(options: IExposedFromAuthoring<IArticle>): IAut
/>
),
availableOffline: true,
keyBindings: {
'ctrl+shift+e': () => {
initiateClosing();
},
},
};

const minimizeButton: ITopBarWidget<IArticle> = {
Expand Down Expand Up @@ -146,7 +158,6 @@ function getInlineToolbarActions(options: IExposedFromAuthoring<IArticle>): IAut
actions.push(getManageHighlights());
}


// eslint-disable-next-line no-case-declarations
const manageDesksButton: ITopBarWidget<IArticle> = ({
group: 'start',
Expand Down Expand Up @@ -196,8 +207,16 @@ function getInlineToolbarActions(options: IExposedFromAuthoring<IArticle>): IAut
unlock={() => {
stealLock();
}}
isLockedInOtherSession={(article) => sdApi.article.isLockedInOtherSession(article)}
/>
),
keyBindings: {
'ctrl+shift+u': () => {
if (sdApi.article.isLockedInOtherSession(item)) {
stealLock();
}
},
},
availableOffline: false,
});

Expand Down
83 changes: 46 additions & 37 deletions scripts/apps/authoring-react/authoring-integration-wrapper.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,25 +47,23 @@ import {CompareArticleVersionsModal} from './toolbar/compare-article-versions';
import {httpRequestJsonLocal} from 'core/helpers/network';
import {getArticleAdapter} from './article-adapter';
import {ui} from 'core/ui-utils';
import TranslateModal from './toolbar/translate-modal';
import {MarkForDesksModal} from './toolbar/mark-for-desks/mark-for-desks-modal';

function getAuthoringActionsFromExtensions(
item: IArticle,
contentProfile: IContentProfileV2,
fieldsData: Map<string, unknown>,
): Promise<Array<IAuthoringAction>> {
): Array<IAuthoringAction> {
const actionGetters
: Array<IExtensionActivationResult['contributions']['getAuthoringActions']>
= flatMap(
Object.values(extensions),
(extension) => extension.activationResult.contributions?.getAuthoringActions ?? [],
);

return Promise.all(actionGetters.map((getPromise) => getPromise(item, contentProfile, fieldsData)))
.then((res) => {
return flatMap(res);
});
return flatMap(
actionGetters.map((getPromise) => getPromise(item, contentProfile, fieldsData)),
);
}

const defaultToolbarItems: Array<React.ComponentType<{article: IArticle}>> = [CreatedModifiedInfo];
Expand Down Expand Up @@ -183,18 +181,27 @@ const getExportModal = (
});

const getHighlightsAction = (getItem: () => IArticle): IAuthoringAction => {
const showHighlightsModal = () => {
showModal(({closeModal}) => {
return (
<HighlightsModal
article={getItem()}
closeModal={closeModal}
/>
);
});
};

return {
label: gettext('Highlights'),
onTrigger: () => (
showModal(({closeModal}) => {
return (
<HighlightsModal
article={getItem()}
closeModal={closeModal}
/>
);
})
showHighlightsModal()
),
keyBindings: {
'ctrl+shift+h': () => {
showHighlightsModal();
},
},
};
};

Expand All @@ -212,7 +219,6 @@ const getSaveAsTemplate = (getItem: () => IArticle): IAuthoringAction => ({
),
});


const getTranslateModal = (getItem: () => IArticle): IAuthoringAction => ({
label: gettext('Translate'),
onTrigger: () => {
Expand Down Expand Up @@ -375,28 +381,28 @@ export class AuthoringIntegrationWrapper extends React.PureComponent<IPropsWrapp
fieldsAdapter,
storageAdapter,
}) => {
return Promise.all([
getAuthoringActionsFromExtensions(item, contentProfile, fieldsData),
getArticleActionsFromExtensions(item),
]).then((res) => {
const [authoringActionsFromExtensions, articleActionsFromExtensions] = res;

return [
getSaveAsTemplate(getLatestItem),
getCompareVersionsModal(
getLatestItem,
authoringStorage,
fieldsAdapter,
storageAdapter,
),
getHighlightsAction(getLatestItem),
getMarkedForDesksModal(getLatestItem),
getExportModal(getLatestItem, handleUnsavedChanges, hasUnsavedChanges),
getTranslateModal(getLatestItem),
...authoringActionsFromExtensions,
...articleActionsFromExtensions,
];
});
const authoringActionsFromExtensions = getAuthoringActionsFromExtensions(
item,
contentProfile,
fieldsData,
);
const articleActionsFromExtensions = getArticleActionsFromExtensions(item);

return [
getSaveAsTemplate(getLatestItem),
getCompareVersionsModal(
getLatestItem,
authoringStorage,
fieldsAdapter,
storageAdapter,
),
getHighlightsAction(getLatestItem),
getMarkedForDesksModal(getLatestItem),
getExportModal(getLatestItem, handleUnsavedChanges, hasUnsavedChanges),
getTranslateModal(getLatestItem),
...authoringActionsFromExtensions,
...articleActionsFromExtensions,
];
}}
getInlineToolbarActions={this.props.getInlineToolbarActions}
getAuthoringTopBarWidgets={
Expand Down Expand Up @@ -473,6 +479,9 @@ export class AuthoringIntegrationWrapper extends React.PureComponent<IPropsWrapp
getSidebar={this.state.isSidebarCollapsed ? null : getSidebar}
topBar2Widgets={topbar2WidgetsReady}
validateBeforeSaving={false}
getSideWidgetNameAtIndex={(article, index) => {
return getWidgetsFromExtensions(article)[index].label;
}}
/>
);
}}
Expand Down
Loading