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

Added tableCellSelectionBackgroundColor option #2640

Merged
merged 4 commits into from
May 17, 2024
Merged

Added tableCellSelectionBackgroundColor option #2640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
604fbd0
Added tableCellSelectionBackgroundColor option
vhuseinova-msft May 16, 2024
5c72efe
Fixed a test
vhuseinova-msft May 16, 2024
582f812
Tests fix
vhuseinova-msft May 17, 2024
55e598f
Tests fix
vhuseinova-msft May 17, 2024
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
7 changes: 5 additions & 2 deletions packages/roosterjs-content-model-core/lib/coreApi/setDOMSelection/setDOMSelection.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const HIDE_SELECTION_CSS_KEY = '_DOMSelectionHideSelection';
const IMAGE_ID = 'image';
const TABLE_ID = 'table';
const DEFAULT_SELECTION_BORDER_COLOR = '#DB626C';
const TABLE_CSS_RULE = 'background-color:#C6C6C6!important;';
const DEFAULT_TABLE_CELL_SELECTION_BACKGROUND_COLOR = '#C6C6C6';
const CARET_CSS_RULE = 'caret-color: transparent';
const TRANSPARENT_SELECTION_CSS_RULE = 'background-color: transparent !important;';
const SELECTION_SELECTOR = '*::selection';
Expand Down Expand Up @@ -115,7 +115,10 @@ export const setDOMSelection: SetDOMSelection = (core, selection, skipSelectionC
core.api.setEditorStyle(
core,
DOM_SELECTION_CSS_KEY,
TABLE_CSS_RULE,
`background-color:${
core.selection.tableCellSelectionBackgroundColor ||
DEFAULT_TABLE_CELL_SELECTION_BACKGROUND_COLOR
}!important;`,
tableSelectors
);
core.api.setEditorStyle(core, HIDE_CURSOR_CSS_KEY, CARET_CSS_RULE);
Expand Down
1 change: 1 addition & 0 deletions packages/roosterjs-content-model-core/lib/corePlugin/selection/SelectionPlugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ class SelectionPlugin implements PluginWithState<SelectionPluginState> {
selection: null,
tableSelection: null,
imageSelectionBorderColor: options.imageSelectionBorderColor,
tableCellSelectionBackgroundColor: options.tableCellSelectionBackgroundColor,
};
}

Expand Down
22 changes: 20 additions & 2 deletions packages/roosterjs-content-model-core/test/coreApi/setDOMSelection/setDOMSelectionTest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -530,7 +530,8 @@ describe('setDOMSelection', () => {
firstRow: number,
lastColumn: number,
lastRow: number,
result: string[]
result: string[],
selectionColor?: string
) {
const mockedSelection = {
type: 'table',
Expand All @@ -546,6 +547,10 @@ describe('setDOMSelection', () => {
selectNode: selectNodeSpy,
collapse: collapseSpy,
};
const defaultSelectionColor = '#C6C6C6';
if (selectionColor) {
core.selection.tableCellSelectionBackgroundColor = selectionColor;
}

createRangeSpy.and.returnValue(mockedRange);

Expand All @@ -557,6 +562,7 @@ describe('setDOMSelection', () => {
expect(core.selection).toEqual({
skipReselectOnFocus: undefined,
selection: mockedSelection,
...(selectionColor ? { tableCellSelectionBackgroundColor: selectionColor } : {}),
} as any);
expect(triggerEventSpy).toHaveBeenCalledWith(
core,
Expand All @@ -578,7 +584,7 @@ describe('setDOMSelection', () => {
expect(setEditorStyleSpy).toHaveBeenCalledWith(
core,
'_DOMSelection',
'background-color:#C6C6C6!important;',
`background-color:${selectionColor ?? defaultSelectionColor}!important;`,
result
);
expect(setEditorStyleSpy).toHaveBeenCalledWith(
Expand Down Expand Up @@ -774,6 +780,18 @@ describe('setDOMSelection', () => {
'#table_0 *',
]);
});

it('Select All with custom selection color', () => {
runTest(
buildTable(true /* tbody */, false, false),
0,
0,
1,
1,
['#table_0', '#table_0 *'],
'red'
);
});
});
});

Expand Down
34 changes: 34 additions & 0 deletions packages/roosterjs-content-model-core/test/corePlugin/selection/SelectionPluginTest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ describe('SelectionPlugin', () => {
expect(state).toEqual({
selection: null,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
tableSelection: null,
});
expect(attachDomEvent).toHaveBeenCalled();
Expand All @@ -48,6 +49,7 @@ describe('SelectionPlugin', () => {
it('init with different options', () => {
const plugin = createSelectionPlugin({
imageSelectionBorderColor: 'red',
tableCellSelectionBackgroundColor: 'blue',
});
const state = plugin.getState();
const addEventListenerSpy = jasmine.createSpy('addEventListener');
Expand All @@ -69,6 +71,7 @@ describe('SelectionPlugin', () => {
expect(state).toEqual({
selection: null,
imageSelectionBorderColor: 'red',
tableCellSelectionBackgroundColor: 'blue',
tableSelection: null,
});

Expand Down Expand Up @@ -135,6 +138,7 @@ describe('SelectionPlugin handle onFocus and onBlur event', () => {
expect(plugin.getState()).toEqual({
selection: mockedRange,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
skipReselectOnFocus: false,
tableSelection: null,
});
Expand All @@ -151,6 +155,7 @@ describe('SelectionPlugin handle onFocus and onBlur event', () => {
expect(plugin.getState()).toEqual({
selection: mockedRange,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
skipReselectOnFocus: true,
tableSelection: null,
});
Expand Down Expand Up @@ -768,6 +773,7 @@ describe('SelectionPlugin handle table selection', () => {
selection: null,
tableSelection: mockedTableSelection,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});

plugin.onPluginEvent!({
Expand All @@ -781,6 +787,7 @@ describe('SelectionPlugin handle table selection', () => {
selection: null,
tableSelection: null,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});
expect(mouseDispatcher).toBeUndefined();
});
Expand Down Expand Up @@ -814,6 +821,7 @@ describe('SelectionPlugin handle table selection', () => {
selection: null,
tableSelection: null,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});

plugin.onPluginEvent!({
Expand All @@ -834,6 +842,7 @@ describe('SelectionPlugin handle table selection', () => {
},
mouseDisposer: mouseMoveDisposer,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});
expect(mouseDispatcher).toBeDefined();
});
Expand Down Expand Up @@ -867,6 +876,7 @@ describe('SelectionPlugin handle table selection', () => {
selection: null,
tableSelection: null,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});

plugin.onPluginEvent!({
Expand All @@ -881,6 +891,7 @@ describe('SelectionPlugin handle table selection', () => {
selection: null,
tableSelection: null,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});
expect(mouseDispatcher).toBeUndefined();
});
Expand Down Expand Up @@ -919,6 +930,7 @@ describe('SelectionPlugin handle table selection', () => {
},
mouseDisposer: mouseMoveDisposer,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});
expect(mouseDispatcher).toBeDefined();
expect(preventDefaultSpy).toHaveBeenCalled();
Expand Down Expand Up @@ -1259,6 +1271,7 @@ describe('SelectionPlugin handle table selection', () => {
selection: null,
tableSelection: null,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});
expect(setDOMSelectionSpy).not.toHaveBeenCalled();
expect(announceSpy).not.toHaveBeenCalled();
Expand Down Expand Up @@ -1300,6 +1313,7 @@ describe('SelectionPlugin handle table selection', () => {
selection: null,
tableSelection: null,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});
expect(setDOMSelectionSpy).toHaveBeenCalledTimes(0);
expect(announceSpy).not.toHaveBeenCalled();
Expand Down Expand Up @@ -1356,6 +1370,7 @@ describe('SelectionPlugin handle table selection', () => {
selection: null,
tableSelection: null,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});
expect(setDOMSelectionSpy).toHaveBeenCalledTimes(1);
expect(setDOMSelectionSpy).toHaveBeenCalledWith({
Expand Down Expand Up @@ -1419,6 +1434,7 @@ describe('SelectionPlugin handle table selection', () => {
selection: null,
tableSelection: null,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});
expect(setDOMSelectionSpy).toHaveBeenCalledTimes(1);
expect(setDOMSelectionSpy).toHaveBeenCalledWith({
Expand Down Expand Up @@ -1481,6 +1497,7 @@ describe('SelectionPlugin handle table selection', () => {
selection: null,
tableSelection: null,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});
expect(setDOMSelectionSpy).toHaveBeenCalledTimes(1);
expect(setDOMSelectionSpy).toHaveBeenCalledWith({
Expand Down Expand Up @@ -1544,6 +1561,7 @@ describe('SelectionPlugin handle table selection', () => {
selection: null,
tableSelection: null,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});
expect(setDOMSelectionSpy).toHaveBeenCalledTimes(1);
expect(setDOMSelectionSpy).toHaveBeenCalledWith({
Expand Down Expand Up @@ -1606,6 +1624,7 @@ describe('SelectionPlugin handle table selection', () => {
selection: null,
tableSelection: null,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});
expect(setDOMSelectionSpy).toHaveBeenCalledTimes(1);
expect(setDOMSelectionSpy).toHaveBeenCalledWith({
Expand Down Expand Up @@ -1668,6 +1687,7 @@ describe('SelectionPlugin handle table selection', () => {
selection: null,
tableSelection: null,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});
expect(setDOMSelectionSpy).toHaveBeenCalledTimes(1);
expect(setDOMSelectionSpy).toHaveBeenCalledWith({
Expand Down Expand Up @@ -1733,6 +1753,7 @@ describe('SelectionPlugin handle table selection', () => {
startNode: td4,
},
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});
expect(setDOMSelectionSpy).toHaveBeenCalledTimes(1);
expect(setDOMSelectionSpy).toHaveBeenCalledWith({
Expand Down Expand Up @@ -1798,6 +1819,7 @@ describe('SelectionPlugin handle table selection', () => {
startNode: td2,
},
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});
expect(setDOMSelectionSpy).toHaveBeenCalledTimes(1);
expect(setDOMSelectionSpy).toHaveBeenCalledWith({
Expand Down Expand Up @@ -1862,6 +1884,7 @@ describe('SelectionPlugin handle table selection', () => {
startNode: td2,
},
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});
expect(setDOMSelectionSpy).toHaveBeenCalledTimes(0);
expect(announceSpy).not.toHaveBeenCalled();
Expand Down Expand Up @@ -1906,6 +1929,7 @@ describe('SelectionPlugin handle table selection', () => {
startNode: td2,
},
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});
expect(setDOMSelectionSpy).not.toHaveBeenCalled();
expect(preventDefaultSpy).not.toHaveBeenCalled();
Expand Down Expand Up @@ -1959,6 +1983,7 @@ describe('SelectionPlugin handle table selection', () => {
selection: null,
tableSelection: null,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});
expect(setDOMSelectionSpy).toHaveBeenCalledTimes(1);
expect(setDOMSelectionSpy).toHaveBeenCalledWith(null);
Expand Down Expand Up @@ -2008,6 +2033,7 @@ describe('SelectionPlugin handle table selection', () => {
startNode: td2,
},
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});
expect(setDOMSelectionSpy).toHaveBeenCalledTimes(1);
expect(setDOMSelectionSpy).toHaveBeenCalledWith({
Expand Down Expand Up @@ -2064,6 +2090,7 @@ describe('SelectionPlugin handle table selection', () => {
startNode: td3,
},
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
});
expect(setDOMSelectionSpy).toHaveBeenCalledTimes(1);
expect(setDOMSelectionSpy).toHaveBeenCalledWith({
Expand Down Expand Up @@ -2133,6 +2160,7 @@ describe('SelectionPlugin on Safari', () => {
expect(state).toEqual({
selection: null,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
tableSelection: null,
});
expect(attachDomEvent).toHaveBeenCalled();
Expand Down Expand Up @@ -2168,6 +2196,7 @@ describe('SelectionPlugin on Safari', () => {
expect(state).toEqual({
selection: mockedOldSelection,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
tableSelection: null,
});
expect(getDOMSelectionSpy).toHaveBeenCalledTimes(1);
Expand Down Expand Up @@ -2199,6 +2228,7 @@ describe('SelectionPlugin on Safari', () => {
expect(state).toEqual({
selection: mockedNewSelection,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
tableSelection: null,
});
expect(getDOMSelectionSpy).toHaveBeenCalledTimes(1);
Expand Down Expand Up @@ -2227,6 +2257,7 @@ describe('SelectionPlugin on Safari', () => {
expect(state).toEqual({
selection: mockedOldSelection,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
tableSelection: null,
});
expect(getDOMSelectionSpy).toHaveBeenCalledTimes(1);
Expand Down Expand Up @@ -2255,6 +2286,7 @@ describe('SelectionPlugin on Safari', () => {
expect(state).toEqual({
selection: mockedOldSelection,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
tableSelection: null,
});
expect(getDOMSelectionSpy).toHaveBeenCalledTimes(1);
Expand Down Expand Up @@ -2283,6 +2315,7 @@ describe('SelectionPlugin on Safari', () => {
expect(state).toEqual({
selection: mockedOldSelection,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
tableSelection: null,
});
expect(getDOMSelectionSpy).toHaveBeenCalledTimes(0);
Expand Down Expand Up @@ -2311,6 +2344,7 @@ describe('SelectionPlugin on Safari', () => {
expect(state).toEqual({
selection: mockedOldSelection,
imageSelectionBorderColor: undefined,
tableCellSelectionBackgroundColor: undefined,
tableSelection: null,
});
expect(getDOMSelectionSpy).toHaveBeenCalledTimes(0);
Expand Down
5 changes: 5 additions & 0 deletions packages/roosterjs-content-model-types/lib/editor/EditorOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,11 @@ export interface EditorOptions {
*/
imageSelectionBorderColor?: string;

/**
* Background color of a selected table cell. Default color: '#C6C6C6'
*/
tableCellSelectionBackgroundColor?: string;

/**
* Initial Content Model
*/
Expand Down
5 changes: 5 additions & 0 deletions packages/roosterjs-content-model-types/lib/pluginState/SelectionPluginState.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,9 @@ export interface SelectionPluginState {
* Color of the border of a selectedImage. Default color: '#DB626C'
*/
imageSelectionBorderColor?: string;

/**
* Background color of a selected table cell. Default color: '#C6C6C6'
*/
tableCellSelectionBackgroundColor?: string;
}