Skip to content

[Feat]: #1585 Add Event Handlers for more Table Column Types #1742

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.

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

Merged
merged 1 commit into from
Jun 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import { ButtonStyle } from "comps/controls/styleControlConstants";
import { Button100 } from "comps/comps/buttonComp/buttonCompConstants";
import styled from "styled-components";
import { ButtonType } from "antd/es/button";
import { clickEvent, eventHandlerControl } from "comps/controls/eventHandlerControl";

const StyledButton = styled(Button100)`
display: flex;
Expand All @@ -28,18 +29,21 @@ const StyledIconWrapper = styled(IconWrapper)`
margin: 0;
`;

const DropdownEventOptions = [clickEvent] as const;

const childrenMap = {
buttonType: dropdownControl(ButtonTypeOptions, "primary"),
label: withDefault(StringControl, 'Menu'),
prefixIcon: IconControl,
suffixIcon: IconControl,
options: DropdownOptionControl,
onEvent: eventHandlerControl(DropdownEventOptions),
};

const getBaseValue: ColumnTypeViewFn<typeof childrenMap, string, string> = (props) => props.label;

// Memoized dropdown menu component
const DropdownMenu = React.memo(({ items, options }: { items: any[]; options: any[] }) => {
const DropdownMenu = React.memo(({ items, options, onEvent }: { items: any[]; options: any[]; onEvent?: (eventName: string) => void }) => {
const mountedRef = useRef(true);

// Cleanup on unmount
Expand All @@ -54,7 +58,9 @@ const DropdownMenu = React.memo(({ items, options }: { items: any[]; options: an
const item = items.find((o) => o.key === key);
const itemIndex = options.findIndex(option => option.label === item?.label);
item && options[itemIndex]?.onEvent("click");
}, [items, options]);
// Also trigger the dropdown's main event handler
onEvent?.("click");
}, [items, options, onEvent]);

const handleMouseDown = useCallback((e: React.MouseEvent) => {
e.stopPropagation();
Expand All @@ -78,6 +84,7 @@ const DropdownView = React.memo((props: {
prefixIcon: ReactNode;
suffixIcon: ReactNode;
options: any[];
onEvent?: (eventName: string) => void;
}) => {
const mountedRef = useRef(true);

Expand Down Expand Up @@ -120,8 +127,8 @@ const DropdownView = React.memo((props: {
const buttonStyle = useStyle(ButtonStyle);

const menu = useMemo(() => (
<DropdownMenu items={items} options={props.options} />
), [items, props.options]);
<DropdownMenu items={items} options={props.options} onEvent={props.onEvent} />
), [items, props.options, props.onEvent]);

return (
<Dropdown
Expand Down Expand Up @@ -183,6 +190,7 @@ export const ColumnDropdownComp = (function () {
{children.options.propertyView({
title: trans("optionsControl.optionList"),
})}
{children.onEvent.propertyView()}
</>
);
})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,15 @@ import { disabledPropertyView } from "comps/utils/propertyUtils";
import styled, { css } from "styled-components";
import { styleControl } from "comps/controls/styleControl";
import { TableColumnLinkStyle } from "comps/controls/styleControlConstants";
import { clickEvent, eventHandlerControl } from "comps/controls/eventHandlerControl";

export const ColumnValueTooltip = trans("table.columnValueTooltip");

const LinkEventOptions = [clickEvent] as const;

const childrenMap = {
text: StringControl,
onClick: ActionSelectorControlInContext,
onEvent: eventHandlerControl(LinkEventOptions),
disabled: BoolCodeControl,
style: styleControl(TableColumnLinkStyle),
};
Expand All @@ -34,12 +37,12 @@ const StyledLink = styled.a<{ $disabled: boolean }>`
`;

// Memoized link component
export const ColumnLink = React.memo(({ disabled, label, onClick }: { disabled: boolean; label: string; onClick?: () => void }) => {
export const ColumnLink = React.memo(({ disabled, label, onEvent }: { disabled: boolean; label: string; onEvent?: (eventName: string) => void }) => {
const handleClick = useCallback(() => {
if (!disabled && onClick) {
onClick();
if (!disabled && onEvent) {
onEvent("click");
}
}, [disabled, onClick]);
}, [disabled, onEvent]);

return (
<StyledLink
Expand Down Expand Up @@ -106,7 +109,7 @@ export const LinkComp = (function () {
childrenMap,
(props, dispatch) => {
const value = props.changeValue ?? getBaseValue(props, dispatch);
return <ColumnLink disabled={props.disabled} label={value} onClick={props.onClick} />;
return <ColumnLink disabled={props.disabled} label={value} onEvent={props.onEvent} />;
},
(nodeValue) => nodeValue.text.value,
getBaseValue
Expand All @@ -125,10 +128,7 @@ export const LinkComp = (function () {
tooltip: ColumnValueTooltip,
})}
{disabledPropertyView(children)}
{children.onClick.propertyView({
label: trans("table.action"),
placement: "table",
})}
{children.onEvent.propertyView()}
</>
))
.setStylePropertyViewFn((children) => (
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { trans } from "i18n";
import styled from "styled-components";
import { ColumnLink } from "comps/comps/tableComp/column/columnTypeComps/columnLinkComp";
import { LightActiveTextColor, PrimaryColor } from "constants/style";
import { clickEvent, eventHandlerControl } from "comps/controls/eventHandlerControl";

const MenuLinkWrapper = styled.div`
> a {
Expand Down Expand Up @@ -37,33 +38,16 @@ const MenuWrapper = styled.div`
}
`;

// Memoized menu item component
const MenuItem = React.memo(({ option, index }: { option: any; index: number }) => {
const handleClick = useCallback(() => {
if (!option.disabled && option.onClick) {
option.onClick();
}
}, [option.disabled, option.onClick]);

return (
<MenuLinkWrapper>
<ColumnLink
disabled={option.disabled}
label={option.label}
onClick={handleClick}
/>
</MenuLinkWrapper>
);
});

MenuItem.displayName = 'MenuItem';
const LinksEventOptions = [clickEvent] as const;

// Update OptionItem to include event handlers
const OptionItem = new MultiCompBuilder(
{
label: StringControl,
onClick: ActionSelectorControlInContext,
hidden: BoolCodeControl,
disabled: BoolCodeControl,
onEvent: eventHandlerControl(LinksEventOptions),
},
(props) => {
return props;
Expand All @@ -79,11 +63,38 @@ const OptionItem = new MultiCompBuilder(
})}
{hiddenPropertyView(children)}
{disabledPropertyView(children)}
{children.onEvent.propertyView()}
</>
);
})
.build();

// Memoized menu item component
const MenuItem = React.memo(({ option, index }: { option: any; index: number }) => {
const handleClick = useCallback(() => {
if (!option.disabled) {
if (option.onClick) {
option.onClick();
}
if (option.onEvent) {
option.onEvent("click");
}
}
}, [option.disabled, option.onClick, option.onEvent]);

return (
<MenuLinkWrapper>
<ColumnLink
disabled={option.disabled}
label={option.label}
onEvent={handleClick}
/>
</MenuLinkWrapper>
);
});

MenuItem.displayName = 'MenuItem';

// Memoized menu component
const LinksMenu = React.memo(({ options }: { options: any[] }) => {
const mountedRef = useRef(true);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
import React, { useState, useRef, useEffect, useCallback, useMemo } from "react";

import { SelectUIView } from "comps/comps/selectInputComp/selectCompConstants";
import { SelectOptionControl } from "comps/controls/optionsControl";
import { StringControl } from "comps/controls/codeControl";
import { StringControl, BoolCodeControl } from "comps/controls/codeControl";
import { IconControl } from "comps/controls/iconControl";
import { MultiCompBuilder } from "comps/generators";
import { optionsControl } from "comps/controls/optionsControl";
import { disabledPropertyView, hiddenPropertyView } from "comps/utils/propertyUtils";

import { trans } from "i18n";
import { ColumnTypeCompBuilder, ColumnTypeViewFn } from "../columnTypeCompBuilder";
import { ColumnValueTooltip } from "../simpleColumnTypeComps";
import { styled } from "styled-components";
import { clickEvent, eventHandlerControl } from "comps/controls/eventHandlerControl";

const Wrapper = styled.div`
display: inline-flex;
Expand Down Expand Up @@ -75,9 +79,43 @@ const Wrapper = styled.div`
}
`;

const SelectOptionEventOptions = [clickEvent] as const;

// Create a new option type with event handlers for each option
const SelectOptionWithEvents = new MultiCompBuilder(
{
value: StringControl,
label: StringControl,
prefixIcon: IconControl,
disabled: BoolCodeControl,
hidden: BoolCodeControl,
onEvent: eventHandlerControl(SelectOptionEventOptions),
},
(props) => props
)
.setPropertyViewFn((children) => (
<>
{children.label.propertyView({ label: trans("label") })}
{children.value.propertyView({ label: trans("value") })}
{children.prefixIcon.propertyView({ label: trans("button.prefixIcon") })}
{disabledPropertyView(children)}
{hiddenPropertyView(children)}
{children.onEvent.propertyView()}
</>
))
.build();

const SelectOptionWithEventsControl = optionsControl(SelectOptionWithEvents, {
initOptions: [
{ label: trans("optionsControl.optionI", { i: 1 }), value: "1" },
{ label: trans("optionsControl.optionI", { i: 2 }), value: "2" },
],
uniqField: "value",
});

const childrenMap = {
text: StringControl,
options: SelectOptionControl,
options: SelectOptionWithEventsControl,
};

const getBaseValue: ColumnTypeViewFn<typeof childrenMap, string, string> = (props) => props.text;
Expand Down Expand Up @@ -106,7 +144,13 @@ const SelectEdit = React.memo((props: SelectEditProps) => {
if (!mountedRef.current) return;
props.onChange(val);
setCurrentValue(val);
}, [props.onChange]);

// Trigger the specific option's event handler
const selectedOption = props.options.find(option => option.value === val);
if (selectedOption && selectedOption.onEvent) {
selectedOption.onEvent("click");
}
}, [props.onChange, props.options]);

const handleEvent = useCallback(async (eventName: string) => {
if (!mountedRef.current) return [] as unknown[];
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import React, { useCallback, useEffect, useMemo } from "react";
import { CSSProperties } from "react";
import { RecordConstructorToComp } from "lowcoder-core";
import { ToViewReturn } from "@lowcoder-ee/comps/generators/multi";
import { clickEvent, eventHandlerControl } from "comps/controls/eventHandlerControl";

export const ColumnValueTooltip = trans("table.columnValueTooltip");

Expand All @@ -31,10 +32,12 @@ export const ButtonTypeOptions = [
},
] as const;

const ButtonEventOptions = [clickEvent] as const;

const childrenMap = {
text: StringControl,
buttonType: dropdownControl(ButtonTypeOptions, "primary"),
onClick: ActionSelectorControlInContext,
onEvent: eventHandlerControl(ButtonEventOptions),
loading: BoolCodeControl,
disabled: BoolCodeControl,
prefixIcon: IconControl,
Expand All @@ -49,8 +52,8 @@ const ButtonStyled = React.memo(({ props }: { props: ToViewReturn<RecordConstruc
const iconOnly = !hasText && (hasPrefixIcon || hasSuffixIcon);

const handleClick = useCallback((e: React.MouseEvent) => {
props.onClick?.();
}, [props.onClick]);
props.onEvent("click");
}, [props.onEvent]);

const buttonStyle = useMemo(() => ({
margin: 0,
Expand Down Expand Up @@ -100,10 +103,7 @@ export const ButtonComp = (function () {
})}
{loadingPropertyView(children)}
{disabledPropertyView(children)}
{children.onClick.propertyView({
label: trans("table.action"),
placement: "table",
})}
{children.onEvent.propertyView()}
</>
))
.build();
Expand Down
Loading