Skip to content

[REF] components: introduce owl plugin for model #8845

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

Open
pro-odoo wants to merge 1 commit into
base: master
Choose a base branch
from
+3,412 −2,903
Open

[REF] components: introduce owl plugin for model #8845

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
75 changes: 40 additions & 35 deletions src/actions/action.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { isMacOS } from "../components/helpers/dom_helpers";
import { Model } from "../model";
import { Color } from "../types/misc";
import { SpreadsheetChildEnv } from "../types/spreadsheet_env";

Expand All @@ -13,8 +14,8 @@ export interface ActionSpec {
/**
* String or a function to compute the name
*/
name: string | ((env: SpreadsheetChildEnv) => string);
description?: string | ((env: SpreadsheetChildEnv) => string);
name: string | ((model: Model, env: SpreadsheetChildEnv) => string);
description?: string | ((model: Model, env: SpreadsheetChildEnv) => string);
shortcut?: string;
/**
* which represents its position inside the
Expand All @@ -28,24 +29,24 @@ export interface ActionSpec {
/**
* Can be defined to compute the visibility of the item
*/
isVisible?: (env: SpreadsheetChildEnv) => boolean;
isVisible?: (model: Model, env: SpreadsheetChildEnv) => boolean;
/**
* Can be defined to compute if the user can click on the action
*/
isEnabled?: (env: SpreadsheetChildEnv) => boolean;
isEnabled?: (model: Model, env: SpreadsheetChildEnv) => boolean;
/**
* Can be defined to compute if the action is active
*/
isActive?: (env: SpreadsheetChildEnv) => boolean;
isActive?: (model: Model, env: SpreadsheetChildEnv) => boolean;
/**
* Can be defined to display an icon
*/
icon?: string | ((env: SpreadsheetChildEnv) => string);
icon?: string | ((model: Model, env: SpreadsheetChildEnv) => string);
iconColor?: Color;
/**
* Can be defined to display another icon on the right of the item.
*/
secondaryIcon?: string | ((env: SpreadsheetChildEnv) => string);
secondaryIcon?: string | ((model: Model, env: SpreadsheetChildEnv) => string);
/**
* is the action allowed when running spreadsheet in readonly mode
*/
Expand All @@ -59,7 +60,7 @@ export interface ActionSpec {
* Execute the action. The action can return a result.
* The result will be carried by a `menu-clicked` event to the menu parent component.
*/
execute?: (env: SpreadsheetChildEnv, isMiddleClick?: boolean) => unknown;
execute?: (model: Model, env: SpreadsheetChildEnv, isMiddleClick?: boolean) => unknown;
/**
* subitems associated to this item
* NB: an action without an execute function or children is not displayed !
Expand All @@ -71,30 +72,30 @@ export interface ActionSpec {
*/
separator?: boolean;
textColor?: Color;
onStartHover?: (env: SpreadsheetChildEnv) => void;
onStopHover?: (env: SpreadsheetChildEnv) => void;
onStartHover?: (model: Model, env: SpreadsheetChildEnv) => void;
onStopHover?: (model: Model, env: SpreadsheetChildEnv) => void;
}

export interface Action {
name: (env: SpreadsheetChildEnv) => string;
description: (env: SpreadsheetChildEnv) => string;
name: (model: Model, env: SpreadsheetChildEnv) => string;
description: (model: Model, env: SpreadsheetChildEnv) => string;
shortcut: string;
sequence: number;
id: string;
isVisible: (env: SpreadsheetChildEnv) => boolean;
isEnabled: (env: SpreadsheetChildEnv) => boolean;
isActive?: (env: SpreadsheetChildEnv) => boolean;
icon: (env: SpreadsheetChildEnv) => string;
isVisible: (model: Model, env: SpreadsheetChildEnv) => boolean;
isEnabled: (model: Model, env: SpreadsheetChildEnv) => boolean;
isActive?: (model: Model, env: SpreadsheetChildEnv) => boolean;
icon: (model: Model, env: SpreadsheetChildEnv) => string;
iconColor?: Color;
secondaryIcon: (env: SpreadsheetChildEnv) => string;
secondaryIcon: (model: Model, env: SpreadsheetChildEnv) => string;
isReadonlyAllowed: boolean;
isEnabledOnLockedSheet: boolean;
execute?: (env: SpreadsheetChildEnv, isMiddleClick?: boolean) => unknown;
children: (env: SpreadsheetChildEnv) => Action[];
execute?: (model: Model, env: SpreadsheetChildEnv, isMiddleClick?: boolean) => unknown;
children: (model: Model, env: SpreadsheetChildEnv) => Action[];
separator: boolean;
textColor?: Color;
onStartHover?: (env: SpreadsheetChildEnv) => void;
onStopHover?: (env: SpreadsheetChildEnv) => void;
onStartHover?: (model: Model, env: SpreadsheetChildEnv) => void;
onStopHover?: (model: Model, env: SpreadsheetChildEnv) => void;
}

export interface ComputedAction
Expand All @@ -105,7 +106,7 @@ export interface ComputedAction
secondaryIcon: string;
}

export type ActionBuilder = (env: SpreadsheetChildEnv) => ActionSpec[];
export type ActionBuilder = (model: Model, env: SpreadsheetChildEnv) => ActionSpec[];
type ActionChildren = (ActionSpec | ActionBuilder)[];

export function createActions(menuItems: ActionSpec[]): Action[] {
Expand Down Expand Up @@ -134,17 +135,17 @@ export function createAction(item: ActionSpec): Action {
isEnabled: isEnabled,
isActive: item.isActive,
execute: item.execute
? (env, isMiddleClick) => {
if (isEnabled(env)) {
return item.execute!(env, isMiddleClick);
? (model, env, isMiddleClick) => {
if (isEnabled(model, env)) {
return item.execute!(model, env, isMiddleClick);
}
return undefined;
}
: undefined,
children: children
? (env) => {
? (model, env) => {
return children
.map((child) => (typeof child === "function" ? child(env) : child))
.map((child) => (typeof child === "function" ? child(model, env) : child))
.flat()
.map(createAction)
.sort((a, b) => a.sequence - b.sequence);
Expand All @@ -166,13 +167,17 @@ export function createAction(item: ActionSpec): Action {
}

export function getMenuItemsAndSeparators(
model: Model,
env: SpreadsheetChildEnv,
actions: Action[]
): MenuItemOrSeparator[] {
const menuItemsAndSeparators: MenuItemOrSeparator[] = [];
for (let i = 0; i < actions.length; i++) {
const menuItem = actions[i];
if (menuItem.isVisible(env) && (!isRootMenu(menuItem) || hasVisibleChildren(env, menuItem))) {
if (
menuItem.isVisible(model, env) &&
(!isRootMenu(menuItem) || hasVisibleChildren(model, env, menuItem))
) {
menuItemsAndSeparators.push(menuItem);
}
if (
Expand All @@ -196,17 +201,17 @@ export function isRootMenu(menu: Action) {
return !menu.execute;
}

export function hasVisibleChildren(env: SpreadsheetChildEnv, menu: Action) {
return menu.children(env).some((child) => child.isVisible(env));
export function hasVisibleChildren(model: Model, env: SpreadsheetChildEnv, menu: Action) {
return menu.children(model, env).some((child) => child.isVisible(model, env));
}

export function isMenuItemEnabled(env: SpreadsheetChildEnv, menu: Action): boolean {
const children = menu.children?.(env);
export function isMenuItemEnabled(model: Model, env: SpreadsheetChildEnv, menu: Action): boolean {
const children = menu.children?.(model, env);
if (children.length) {
return children.some((child) => isMenuItemEnabled(env, child));
return children.some((child) => isMenuItemEnabled(model, env, child));
} else {
if (menu.isEnabled(env)) {
return env.model.getters.isReadonly() ? menu.isReadonlyAllowed : true;
if (menu.isEnabled(model, env)) {
return model.getters.isReadonly() ? menu.isReadonlyAllowed : true;
}
return false;
}
Expand Down
42 changes: 21 additions & 21 deletions src/actions/data_actions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ export const sortRange: ActionSpec = {

export const sortAscending: ActionSpec = {
name: _t("Ascending (A ⟶ Z)"),
execute: (env) => {
const { anchor, zones } = env.model.getters.getSelection();
const sheetId = env.model.getters.getActiveSheetId();
interactiveSortSelection(env, sheetId, anchor.cell, zones[0], "asc");
execute: (model, env) => {
const { anchor, zones } = model.getters.getSelection();
const sheetId = model.getters.getActiveSheetId();
interactiveSortSelection(model, env, sheetId, anchor.cell, zones[0], "asc");
},
icon: "o-spreadsheet-Icon.SORT_ASCENDING",
};
Expand All @@ -27,28 +27,28 @@ export const dataCleanup: ActionSpec = {

export const removeDuplicates: ActionSpec = {
name: _t("Remove duplicates"),
execute: (env) => {
if (getZoneArea(env.model.getters.getSelectedZone()) === 1) {
env.model.selection.selectTableAroundSelection();
execute: (model, env) => {
if (getZoneArea(model.getters.getSelectedZone()) === 1) {
model.selection.selectTableAroundSelection();
}
env.openSidePanel("RemoveDuplicates", {});
},
isEnabled: (env) => !env.isSmall,
isEnabled: (model, env) => !env.isSmall,
};

export const trimWhitespace: ActionSpec = {
name: _t("Trim whitespace"),
execute: (env) => {
env.model.dispatch("TRIM_WHITESPACE");
execute: (model) => {
model.dispatch("TRIM_WHITESPACE");
},
};

export const sortDescending: ActionSpec = {
name: _t("Descending (Z ⟶ A)"),
execute: (env) => {
const { anchor, zones } = env.model.getters.getSelection();
const sheetId = env.model.getters.getActiveSheetId();
interactiveSortSelection(env, sheetId, anchor.cell, zones[0], "desc");
execute: (model, env) => {
const { anchor, zones } = model.getters.getSelection();
const sheetId = model.getters.getActiveSheetId();
interactiveSortSelection(model, env, sheetId, anchor.cell, zones[0], "desc");
},
icon: "o-spreadsheet-Icon.SORT_DESCENDING",
};
Expand All @@ -65,14 +65,14 @@ export const createRemoveFilterTool: ActionSpec = {
export const splitToColumns: ActionSpec = {
name: _t("Split text to columns"),
sequence: 1,
execute: (env) => env.openSidePanel("SplitToColumns", {}),
isEnabled: (env) => !env.isSmall && env.model.getters.isSingleColSelected(),
execute: (model, env) => env.openSidePanel("SplitToColumns", {}),
isEnabled: (model, env) => !env.isSmall && model.getters.isSingleColSelected(),
icon: "o-spreadsheet-Icon.SPLIT_TEXT",
};

export const columnStatistics: ActionSpec = {
name: _t("Column statistics"),
execute: (env) => env.openSidePanel("ColumnStats", {}),
execute: (model, env) => env.openSidePanel("ColumnStats", {}),
icon: "o-spreadsheet-Icon.COLUMN_STATS",
};

Expand All @@ -82,8 +82,8 @@ export const reinsertDynamicPivotMenu: ActionSpec = {
sequence: 60,
icon: "o-spreadsheet-Icon.INSERT_PIVOT",
children: [ACTIONS.REINSERT_DYNAMIC_PIVOT_CHILDREN],
isVisible: (env) =>
env.model.getters.getPivotIds().some((id) => env.model.getters.getPivot(id).isValid()),
isVisible: (model) =>
model.getters.getPivotIds().some((id) => model.getters.getPivot(id).isValid()),
};

export const reinsertStaticPivotMenu: ActionSpec = {
Expand All @@ -92,6 +92,6 @@ export const reinsertStaticPivotMenu: ActionSpec = {
sequence: 70,
icon: "o-spreadsheet-Icon.INSERT_PIVOT",
children: [ACTIONS.REINSERT_STATIC_PIVOT_CHILDREN],
isVisible: (env) =>
env.model.getters.getPivotIds().some((id) => env.model.getters.getPivot(id).isValid()),
isVisible: (model) =>
model.getters.getPivotIds().some((id) => model.getters.getPivot(id).isValid()),
};
Loading