Skip to content

Fix/eui migrate class to function components #9618

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
toffku wants to merge 3 commits into
base: main
Choose a base branch
from
+120 −115
Open

Fix/eui migrate class to function components #9618

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e784d43
fix: Migrate EuiFormControlLayoutIcons from class to function
toffku Apr 27, 2026
a650c0b
Merge branch 'fix/eui-migrate-class-to-function-components' of https:…
toffku Apr 27, 2026
05956ba
Merge branch 'main' into fix/eui-migrate-class-to-function-components
weronikaolejniczak Apr 28, 2026
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
235 changes: 120 additions & 115 deletions packages/eui/src/components/form/form_control_layout/form_control_layout_icons.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
* Side Public License, v 1.
*/

import React, { Component } from 'react';
import React from 'react';

import { RenderWithEuiStylesMemoizer } from '../../../services';
import { DistributiveOmit } from '../../common';
Expand Down Expand Up @@ -53,130 +53,135 @@ export interface EuiFormControlLayoutIconsProps {
isDisabled?: boolean;
}

export class EuiFormControlLayoutIcons extends Component<EuiFormControlLayoutIconsProps> {
render() {
const {
side = 'left',
iconsPosition = 'absolute',
compressed,
isDisabled,
} = this.props;

const customIcon = this.renderCustomIcon();
const loadingSpinner = this.renderLoadingSpinner();
const clearButton = this.renderClearButton();
const invalidIcon = this.renderInvalidIcon();
const dropdownIcon = this.renderDropdownIcon();

return (
<RenderWithEuiStylesMemoizer>
{(stylesMemoizer) => {
const styles = stylesMemoizer(euiFormControlLayoutIconsStyles);
const cssStyles = [
styles.euiFormControlLayoutIcons,
compressed ? styles.compressed : styles.uncompressed,
...(iconsPosition === 'absolute'
? [
styles.position.absolute.absolute,
compressed
? styles.position.absolute.compressed[side]
: styles.position.absolute.uncompressed[side],
]
: [
styles.position.static.static,
compressed
? styles.position.static.compressed
: styles.position.static.uncompressed,
]),
isDisabled && styles.disabled,
];
return (
<div css={cssStyles} className="euiFormControlLayoutIcons">
{clearButton}
{loadingSpinner}
{invalidIcon}
{customIcon}
{dropdownIcon}
</div>
);
}}
</RenderWithEuiStylesMemoizer>
);
}
export const EuiFormControlLayoutIcons = ({
side = 'left',
iconsPosition = 'absolute',
compressed,
isDisabled,
icon,
clear,
isLoading,
isInvalid,
isDropdown,
}: EuiFormControlLayoutIconsProps) => {
const customIcon = renderCustomIcon(icon, isDisabled);
const loadingSpinner = renderLoadingSpinner(isLoading);
const clearButton = renderClearButton(clear, isDisabled);
const invalidIcon = renderInvalidIcon(isInvalid);
const dropdownIcon = renderDropdownIcon(isDropdown, isDisabled);

return (
<RenderWithEuiStylesMemoizer>
{(stylesMemoizer) => {
const styles = stylesMemoizer(euiFormControlLayoutIconsStyles);
const cssStyles = [
styles.euiFormControlLayoutIcons,
compressed ? styles.compressed : styles.uncompressed,
...(iconsPosition === 'absolute'
? [
styles.position.absolute.absolute,
compressed
? styles.position.absolute.compressed[side]
: styles.position.absolute.uncompressed[side],
]
: [
styles.position.static.static,
compressed
? styles.position.static.compressed
: styles.position.static.uncompressed,
]),
isDisabled && styles.disabled,
];
return (
<div css={cssStyles} className="euiFormControlLayoutIcons">
{clearButton}
{loadingSpinner}
{invalidIcon}
{customIcon}
{dropdownIcon}
</div>
);
}}
</RenderWithEuiStylesMemoizer>
);
};

renderCustomIcon() {
const { icon, isDisabled } = this.props;

if (!icon) {
return null;
}

// Normalize the icon to an object if it's a string.
const iconProps: IconShape = isIconShape(icon)
? icon
: {
type: icon,
};
const { ref: iconRef, side, ...iconRest } = iconProps;

return (
<EuiFormControlLayoutCustomIcon
size="m"
disabled={isDisabled}
iconRef={iconRef}
{...iconRest}
/>
);
const renderCustomIcon = (
icon: EuiFormControlLayoutIconsProps['icon'],
isDisabled: EuiFormControlLayoutIconsProps['isDisabled']
) => {
if (!icon) {
return null;
}

renderDropdownIcon() {
const { isDropdown, isDisabled } = this.props;

if (!isDropdown) {
return null;
}
// Normalize the icon to an object if it's a string.
const iconProps: IconShape = isIconShape(icon)
? icon
: {
type: icon,
};
const { ref: iconRef, side, ...iconRest } = iconProps;

return (
<EuiFormControlLayoutCustomIcon
size="m"
disabled={isDisabled}
iconRef={iconRef}
{...iconRest}
/>
);
};
Comment on lines +109 to +133
Copy link
Copy Markdown
Contributor

@weronikaolejniczak weronikaolejniczak May 7, 2026

Choose a reason for hiding this comment

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

@toffku It's absolutely okay for the purposes of the class to function migration to simply raise these render functions to module level and call it a day. But a more idiomatic approach here would be to make them into components.

E.g.

Suggested change
const renderCustomIcon = (
icon: EuiFormControlLayoutIconsProps['icon'],
isDisabled: EuiFormControlLayoutIconsProps['isDisabled']
) => {
if (!icon) {
return null;
}
renderDropdownIcon() {
const { isDropdown, isDisabled } = this.props;
if (!isDropdown) {
return null;
}
// Normalize the icon to an object if it's a string.
const iconProps: IconShape = isIconShape(icon)
? icon
: {
type: icon,
};
const { ref: iconRef, side, ...iconRest } = iconProps;
return (
<EuiFormControlLayoutCustomIcon
size="m"
disabled={isDisabled}
iconRef={iconRef}
{...iconRest}
/>
);
};
const CustomIcon = ({ icon, isDisabled }: {
icon: EuiFormControlLayoutIconsProps['icon'],
isDisabled: EuiFormControlLayoutIconsProps['isDisabled']
}) => {
if (!icon) return null;
// Normalize the icon to an object if it's a string.
const iconProps: IconShape = isIconShape(icon)
? icon
: { type: icon };
const { ref: iconRef, side, ...iconRest } = iconProps;
return (
<EuiFormControlLayoutCustomIcon
size="m"
disabled={isDisabled}
iconRef={iconRef}
{...iconRest}
/>
);
};

and then in EuiFormControlLayoutIcons render: <CustomIcon icon={icon} isDisabled={isDisabled} />


return (
<EuiFormControlLayoutCustomIcon
size="m"
disabled={isDisabled}
type="chevronSingleDown"
/>
);
const renderDropdownIcon = (
isDropdown: EuiFormControlLayoutIconsProps['isDropdown'],
isDisabled: EuiFormControlLayoutIconsProps['isDisabled']
) => {
if (!isDropdown) {
return null;
}

renderLoadingSpinner() {
const { isLoading } = this.props;

if (!isLoading) {
return null;
}
return (
<EuiFormControlLayoutCustomIcon
size="m"
disabled={isDisabled}
type="chevronSingleDown"
/>
);
};

return <EuiLoadingSpinner size="m" />;
const renderLoadingSpinner = (
isLoading: EuiFormControlLayoutIconsProps['isLoading']
) => {
if (!isLoading) {
return null;
}

renderClearButton() {
const { clear, isDisabled } = this.props;
if (!clear) {
return null;
}

return (
<EuiFormControlLayoutClearButton
size="m"
disabled={isDisabled}
{...clear}
/>
);
}
return <EuiLoadingSpinner size="m" />;
};

renderInvalidIcon() {
const { isInvalid } = this.props;
const renderClearButton = (
clear: EuiFormControlLayoutIconsProps['clear'],
isDisabled: EuiFormControlLayoutIconsProps['isDisabled']
) => {
if (!clear) {
return null;
}

if (!isInvalid) {
return null;
}
return (
<EuiFormControlLayoutClearButton
size="m"
disabled={isDisabled}
{...clear}
/>
);
};

return <EuiIcon size="m" color="danger" type="warning" />;
const renderInvalidIcon = (
isInvalid: EuiFormControlLayoutIconsProps['isInvalid']
) => {
if (!isInvalid) {
return null;
}
}

return <EuiIcon size="m" color="danger" type="warning" />;
};