Migrating to Enact 5.0

Overview

This document lists changes between Enact versions 4.5 and 5.0 likely to affect most apps. If you are coming from Enact 3.x, please migrate to 4.0 and then consult this guide.

General Changes

React and React DOM

Enact 5.0 updates the react and react-dom dependencies to 19.x. Developers should ensure their code does not rely on features that are no longer available in these versions. React 19 introduces Actions, new API use, ref as a prop, Context as a provider and some deprecated APIs.

Actions

Actions in React 19 are new features designed to handle asynchronous transitions automatically, such as submitting a form or fetching data.

For example, you can use useTransition to handle the pending state for you:

function Button() {
  const [isPending, startTransition] = useTransition();

  const handleClick = () => {
    startTransition(async () => {
      await new Promise(() => {
        setTimeout(resolve, 3000);
      });
      console.log('Async job done');
    });
  };

  return (
    <button onClick={handleClick} disabled={isPending}>
      {isPending ? 'Loading' : 'Click Me'}
    </button>
  );
}

The async transition will immediately set the isPending state to true, make the async request(s), and then switch isPending to false after any transitions. This allows you to keep the current UI responsive and interactive while the data is changing.

Please take a look at the new hooks for Actions, such as useActionState or useOptimistic, too.

use

The use API can be used in a component to read the value of a Promise or context When used with a Promise, React will suspend until the promise resolves. When use is used to read context, use can be called inside loops or conditional statements unlike useContext.

const CounterContext = createContext(0);

function MyCounter() {
  const count = use(CounterContext);

  return <div>Count: {count}</div>;
}

ref as a prop

In React 19, you can now access ref as a prop for function components:

function MyComponent({ref}) {
  return <button ref={ref}>Button</button>;
}
// Usage
<MyComponent ref={ref} />;

Function components no longer need forwardRef to expose a DOM node to a parent component. forwardRef will be deprecated and removed in future versions.

Context as a provider

<Context> can now be rendered as a provider. Note that <Context.Provider> will be deprecated in future versions.

const CounterContext = createContext(0);

function App({children}) {
  return <CounterContext value={5}>{children}</CounterContext>;
}

Removed deprecated React APIs and React DOM APIs

• propTypes and defaultProps for functions: These are removed. Using propType will be silently ignored. Use ES6 default parameters instead of defaultProps. Class components will continue to support defaultProps.
• ReactDOM.findDOMNode: This API is removed. Replace it with DOM refs.
• react-dom/test-utils: Import act from react instead of react-dom/test-utils.

For more details, please refer to React 19 Upgrade Guide and React v19 from React Blog.

cli

@enact/cli must be upgraded to version 7.0.0 or newer, as shown below.

npm install -g @enact/cli@next

@enact/cli updates the eslint to 9.x, jest to 29.x, and react, react-dom to 19.x. Developers should ensure their code does not rely on features that are no longer available in these versions.

As @enact/cli updates the minimum version of Node to 20.10.0, please check your development environment before installing @enact/cli.

As we update to eslint 9, some of the lint rules could be changed. If you run into unknown lint warnings or errors, don’t be afraid, and please proceed to fix them. They are likely to be the rules from eslint-plugin-react, so refer to the console message and look up which rule is related.

webOS TV

Enact 5.0 no longer supports the 2025 TV platform or earlier versions.

Sandstone

General

We’ve changed the default theme for webOS TV from sandstone to limestone. If you would like to migrate your existing sandstone app, please follow the steps below.

1. Update your package.json

  ...
  "enact": {
    "theme": "limestone"
  },
  ...
  "dependenceis": {
    "@enact/core": "^5.0.0",
    "@enact/i18n": "^5.0.0",
    "@enact/limestone": "enactjs/limestone#1.0.0",
    "@enact/spotlight": "^5.0.0",
    "@enact/ui": "^5.0.0",
    ...
  }

2. Update the paths for importing components and any sand prefix to lime

  // sandstone
  import Button from `@enact/sandstone/Button`

  // limestone
  import Button from `@enact/limestone/Button`

3. Delete your npm-shrinkwrap.json file and install the dependencies

$ rm -rf npm-shrinkwrap.json
$ npm install
$ npm shrinkwrap

Limestone now uses the Enova design-tokens system to style its components, importing semantic tokens from @enovaui/webos-tokens in the Enova design-tokens repository. This enables consistent and customizable styling across all components.

With the removal of the ReactDOM.findDOMNode API, ContextualPopupDecorator and Dropdown have been changed to include a sibling DOM node by using @enact/core/internal/WithRef to access DOM nodes.

Tips

Due to introducing @enact/core/internal/WithRef HoC, one of your apps can face unexpected issues. We have found 2 sample cases that you should know in advance.

ContextualPopupDecorator

Make sure your component wrapped with ContextualPopupDecorator passes the rest props to the inner component to get the proper ref, as shown below.

const SampleButton = kind({
  render: (props) => {
    const {icon, ...rest} = props;

    return (
      <Icon
        {...rest} // Ensure the inner component receives the `rest` props
        //...
      >{icon}</Icon>
    );
  }
});

const ContextualSampleButton = ContextualPopupDecorator(SampleButton);

Panels

Make sure the root element of your Panel component inside Panels is not a <> (fragment). It will result in incorrect panel transition animations.

const SamplePanels = kind({
  render: (props) => {
    return (
      <Panels>
        <Panel>
          <> {/* This should be changed to <div> */}
            <ComponentA />
            <ComponentB />
          </>
        </Panel>
      </Panels>
    );
  }
});

Changes of Limestone from Sandstone

Alert

The prop overlayPosition is added to set the position of the alert when the type is overlay.

Button

The prop bordered and centered are added.

Card

The new component Card is added.

Chip

The new component Chip is added.

Chips

The new component Chips is added.

ContextualMenuDecorator

offset prop now accepts a large value.

ContextualPopupDecorator

offset prop now accepts a large value.

Heading

The default value of the size prop is tiny.

Icon

New icons are added.

ImageItem

The prop wideImage is added. The props children and label accept a Node type value.

Input

The prop buttons is added.

KeyGuide

The image-based keyGuide is added.

Switch

The Switch icon is now drawn using CSS instead of an icon font.

TabLayout

Tabs in horizontal TabLayout now support scrolling. The prop primaryIndex is added to focus primary tab when pressing back key from other tabs or initial rendering.

VideoPlayer

The prop includeTimeHour is added to conditionally show hour for current and total time

WizardPanels

The subtitle of WizardPanels now supports a marquee effect.

Style

Various styling changes have been made to support new UI/UX designs for the webOS TV platform.

Colors

The table below shows which less variables in sandstone match which variable or value in limestone.

Changed

Added

• @lime-alert-full-bg-color
• @lime-button-fill-container-disabled-focused-color, @lime-button-fill-icon-color, @lime-button-fill-icon-selected-color, @lime-button-fill-label-focused-color, @lime-button-outline-container-color, @lime-button-outline-container-focused-color, @lime-button-outline-container-selected-color, @lime-button-outline-border-selected-color, @lime-button-outline-label-color, @lime-button-outline-label-focused-color, @lime-button-outline-label-selected-color, @lime-button-transparent-container-focused-color, @lime-button-transparent-container-selected-color, @lime-button-transparent-label-focused-color, @lime-button-transparent-icon-color, @lime-button-transparent-icon-focused-color, @lime-button-transparent-icon-selected-color, @lime-button-transparent-label-selected-color.
• @lime-checkboxitem-item-container-selected-color.
• @lime-contextualpopup-border-color.
• @lime-datetime-label-color.
• @lime-heading-label-tiny-color.
• @lime-formcheckboxitem-label-sub-focused-color.
• @lime-iconitem-inner-icon-color, @lime-iconitem-inner-container-color, @lime-iconitem-outer-label-main-color.
• @lime-input-button-popup-transparent-label-color, @lime-input-button-popup-transparent-icon-color, @lime-input-fullscreen-dot-color, @lime-input-header-popup-label-main-color, @lime-input-header-popup-label-sub-color, @lime-input-inputfield-popup-container-color, @lime-input-inputfield-popup-label-inactive-color, @lime-input-overlay-dot-color.
• @lime-inputfield-container-color, @lime-inputfield-container-disabled-focused-color, @lime-inputfield-cursor-color, @lime-inputfield-label-success-color.
• @lime-imageitem-full-image-border-color,@lime-imageitem-label-main-focused-color, @lime-imageitem-label-main-selected-color,@lime-imageitem-label-sub-focused-color, @lime-imageitem-label-sub-selected-color.
• @lime-item-label-main-selected-color, @lime-item-label-sub-selected-color, @lime-item-container-selected-color, @lime-item-container-disabled-focused-color.
• @lime-keyguide-icon-color.
• @lime-mediaoverlay-inner-border-focused.
• @lime-overlay-shadow.
• @lime-pageviews-bg-color, @lime-pageviews-indicator-icon-active, @lime-pageviews-indicator-icon-inactive.
• @lime-picker-icon-color, @lime-picker-icon-focused-color.
• @lime-progressbutton-track-active-color, @lime-progressbutton-track-focused-color.
• @lime-steps-indicator-icon-inactive-color, @lime-steps-step-icon-success-color, @lime-steps-step-label-active-color, @lime-steps-step-label-inactive-color.
• @lime-switchitem-item-selected-container-color.
• @lime-tablayout-tab-button-selected-color, @lime-tablayout-tab-container-selected-color, @lime-tablayout-tab-group-container-color.
• @lime-virtuallist-container-color.

Removed

• @sand-alert-overlay-focus-text-color, @sand-alert-overlay-disabled-selected-color, @sand-alert-overlay-disabled-selected-bg-color, @sand-alert-overlay-disabled-selected-focus-color, @sand-alert-overlay-disabled-selected-focus-bg-color, @sand-alert-overlay-progress-color-rgb, @sand-alert-overlay-progress-bg-color-rgb, @sand-alert-overlay-progress-bg-color-alpha, @sand-alert-overlay-checkbox-color, @sand-alert-overlay-checkbox-disabled-selected-text-color, @sand-alert-overlay-formcheckboxitem-focus-text-color, @sand-alert-overlay-item-disabled-focus-bg-color.
• @sand-dropdown-title-color,
• @sand-fixedpopuppanels-scrimtransparent-bg-color.
• @sand-item-focus-background.
• @sand-picker-joined-text-color, @sand-picker-joined-incrementer-color, @sand-picker-joined-focus-incrementer-color, @sand-picker-joined-focus-disabled-indicator-bg-color, @sand-picker-joined-focus-disabled-indicator-opacity, @sand-picker-joined-focus-disabled-indicator-active-opacity.
• @sand-popuptablayout-shadow, @sand-popuptablayout-scrimtransparent-bg-color.
• @sand-radioitem-disabled-selected-color, @sand-radioitem-disabled-selected-bg-color, @sand-radioitem-disabled-selected-border-color, @sand-radioitem-focus-disabled-selected-color, @sand-radioitem-focus-disabled-selected-bg-color, @sand-radioitem-focus-disabled-selected-border-color.
• @sand-slider-active-bar-bg-color, @sand-slider-disabled-focus-knob-bg-color, @lime-slider-disabled-knob-bg-color, @sand-slider-focus-bar-bg-color, @sand-slider-focus-load-bg-color, @sand-slider-focus-knob-bg-color, @sand-slider-active-fill-bg-color.
• @sand-spinner-text-shadow-color.
• @sand-tablayout-tab-horizontal-border-color, @sand-tablayout-tab-horizontal-selected-border-color.
• @sand-video-feedback-mini-text-color, @sand-video-player-title-text-shadow.

ui

General

ReactDOM.findDOMNode API is removed. Placeholder.PlaceholderControllerDecorator and ViewManager is changed to have sibling DOM node by using @enact/core/internal/WithRef to access DOM nodes.

ViewManager

As ReactDOM.findDOMNode API is removed from ViewManager, transition needs index of the node to animate. Each panel must be wrapped with <div> instead of <> to map properly to the transition group.

spotlight

spotlight/Spottable is changed to have sibling DOM node by using @enact/core/internal/WithRef to access DOM nodes instead of using ReactDOM.findDOMNode.