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

Allow skipping marking hasNewContent in formatContentModel #2933

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+164 −7
Open

Allow skipping marking hasNewContent in formatContentModel #2933

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 7 additions & 2 deletions packages/roosterjs-content-model-core/lib/coreApi/formatContentModel/formatContentModel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,10 @@ export const formatContentModel: FormatContentModel = (

if (changed) {
const isNested = core.undo.isNested;
const shouldAddSnapshot = !skipUndoSnapshot && !isNested;
const shouldAddSnapshot =
(!skipUndoSnapshot || skipUndoSnapshot == 'DoNotSkip') && !isNested;
const shouldMarkNewContent =
(skipUndoSnapshot === true || skipUndoSnapshot == 'MarkNewContent') && !isNested;
let selection: DOMSelection | undefined;

if (shouldAddSnapshot) {
Expand Down Expand Up @@ -94,7 +97,9 @@ export const formatContentModel: FormatContentModel = (

if (shouldAddSnapshot) {
core.api.addUndoSnapshot(core, false /*canUndoByBackspace*/, entityStates);
} else {
}

if (shouldMarkNewContent) {
core.undo.snapshotsManager.hasNewContent = true;
}
} finally {
Expand Down
155 changes: 151 additions & 4 deletions ...es/roosterjs-content-model-core/test/coreApi/formatContentModel/formatContentModelTest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ describe('formatContentModel', () => {
expect(announce).not.toHaveBeenCalled();
});

it('Skip undo snapshot', () => {
it('Skip undo snapshot = true', () => {
const callback = jasmine.createSpy('callback').and.callFake((model, context) => {
context.skipUndoSnapshot = true;
return true;
Expand Down Expand Up @@ -157,6 +157,155 @@ describe('formatContentModel', () => {
true
);
expect(announce).not.toHaveBeenCalled();
expect(core.undo.snapshotsManager.hasNewContent).toBeTrue();
});

it('Skip undo snapshot = false', () => {
const callback = jasmine.createSpy('callback').and.callFake((model, context) => {
context.skipUndoSnapshot = false;
return true;
});

formatContentModel(core, callback, { apiName });

expect(callback).toHaveBeenCalledWith(mockedModel, {
newEntities: [],
deletedEntities: [],
rawEvent: undefined,
skipUndoSnapshot: false,
newImages: [],
});
expect(createContentModel).toHaveBeenCalledTimes(1);
expect(addUndoSnapshot).toHaveBeenCalledTimes(2);
expect(setContentModel).toHaveBeenCalledTimes(1);
expect(setContentModel).toHaveBeenCalledWith(core, mockedModel, undefined, undefined);
expect(triggerEvent).toHaveBeenCalledTimes(1);
expect(triggerEvent).toHaveBeenCalledWith(
core,
{
eventType: 'contentChanged',
contentModel: mockedModel,
selection: mockedSelection,
source: ChangeSource.Format,
data: undefined,
formatApiName: apiName,
changedEntities: [],
},
true
);
expect(announce).not.toHaveBeenCalled();
expect(core.undo.snapshotsManager.hasNewContent).toBeFalsy();
});

it('Skip undo snapshot = DoNotSkip', () => {
const callback = jasmine.createSpy('callback').and.callFake((model, context) => {
context.skipUndoSnapshot = 'DoNotSkip';
return true;
});

formatContentModel(core, callback, { apiName });

expect(callback).toHaveBeenCalledWith(mockedModel, {
newEntities: [],
deletedEntities: [],
rawEvent: undefined,
skipUndoSnapshot: 'DoNotSkip',
newImages: [],
});
expect(createContentModel).toHaveBeenCalledTimes(1);
expect(addUndoSnapshot).toHaveBeenCalledTimes(2);
expect(setContentModel).toHaveBeenCalledTimes(1);
expect(setContentModel).toHaveBeenCalledWith(core, mockedModel, undefined, undefined);
expect(triggerEvent).toHaveBeenCalledTimes(1);
expect(triggerEvent).toHaveBeenCalledWith(
core,
{
eventType: 'contentChanged',
contentModel: mockedModel,
selection: mockedSelection,
source: ChangeSource.Format,
data: undefined,
formatApiName: apiName,
changedEntities: [],
},
true
);
expect(announce).not.toHaveBeenCalled();
expect(core.undo.snapshotsManager.hasNewContent).toBeFalsy();
});

it('Skip undo snapshot = MarkNewContent', () => {
const callback = jasmine.createSpy('callback').and.callFake((model, context) => {
context.skipUndoSnapshot = 'MarkNewContent';
return true;
});

formatContentModel(core, callback, { apiName });

expect(callback).toHaveBeenCalledWith(mockedModel, {
newEntities: [],
deletedEntities: [],
rawEvent: undefined,
skipUndoSnapshot: 'MarkNewContent',
newImages: [],
});
expect(createContentModel).toHaveBeenCalledTimes(1);
expect(addUndoSnapshot).toHaveBeenCalledTimes(0);
expect(setContentModel).toHaveBeenCalledTimes(1);
expect(setContentModel).toHaveBeenCalledWith(core, mockedModel, undefined, undefined);
expect(triggerEvent).toHaveBeenCalledTimes(1);
expect(triggerEvent).toHaveBeenCalledWith(
core,
{
eventType: 'contentChanged',
contentModel: mockedModel,
selection: mockedSelection,
source: ChangeSource.Format,
data: undefined,
formatApiName: apiName,
changedEntities: [],
},
true
);
expect(announce).not.toHaveBeenCalled();
expect(core.undo.snapshotsManager.hasNewContent).toBeTruthy();
});

it('Skip undo snapshot = SkipAll', () => {
const callback = jasmine.createSpy('callback').and.callFake((model, context) => {
context.skipUndoSnapshot = 'SkipAll';
return true;
});

formatContentModel(core, callback, { apiName });

expect(callback).toHaveBeenCalledWith(mockedModel, {
newEntities: [],
deletedEntities: [],
rawEvent: undefined,
skipUndoSnapshot: 'SkipAll',
newImages: [],
});
expect(createContentModel).toHaveBeenCalledTimes(1);
expect(addUndoSnapshot).toHaveBeenCalledTimes(0);
expect(setContentModel).toHaveBeenCalledTimes(1);
expect(setContentModel).toHaveBeenCalledWith(core, mockedModel, undefined, undefined);
expect(triggerEvent).toHaveBeenCalledTimes(1);
expect(triggerEvent).toHaveBeenCalledWith(
core,
{
eventType: 'contentChanged',
contentModel: mockedModel,
selection: mockedSelection,
source: ChangeSource.Format,
data: undefined,
formatApiName: apiName,
changedEntities: [],
},
true
);
expect(announce).not.toHaveBeenCalled();
expect(core.undo.snapshotsManager.hasNewContent).toBeFalsy();
});

it('Customize change source', () => {
Expand Down Expand Up @@ -1028,9 +1177,7 @@ describe('formatContentModel', () => {
expect(setContentModel).toHaveBeenCalledWith(core, mockedModel, undefined, undefined);
expect(core.undo).toEqual({
isNested: true,
snapshotsManager: {
hasNewContent: true,
},
snapshotsManager: {},
} as any);
});
});
Expand Down
7 changes: 6 additions & 1 deletion packages/roosterjs-content-model-types/lib/parameter/FormatContentModelContext.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,13 @@ export interface FormatContentModelContext {
* @optional
* When pass true, skip adding undo snapshot when write Content Model back to DOM.
* Need to be set by the formatter function
* Default value is false, which means add undo snapshot
* When set to true, it will skip adding undo snapshot but mark "hasNewContent" so that next undo snapshot will be added, this is same with "MarkNewContent"
* When set to 'DoNotSkip', it will add undo snapshot (default behavior)
* When set to 'MarkNewContent', it will skip adding undo snapshot but mark "hasNewContent" so that next undo snapshot will be added
* When set to 'SkipAll', it will skip adding undo snapshot and not mark "hasNewContent", as if no change is made
*/
skipUndoSnapshot?: boolean;
skipUndoSnapshot?: boolean | 'DoNotSkip' | 'MarkNewContent' | 'SkipAll';
Copy link
Preview

Copilot AI Jan 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comment for the skipUndoSnapshot parameter is unclear. It should be clarified that true is equivalent to 'MarkNewContent'.

Copilot is powered by AI, so mistakes are possible. Review output carefully before use.

Positive Feedback
Negative Feedback

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

Please select one or more of the options

/**
* @optional
Expand Down
Loading