[map-layers] migrate map layers to itwinui 3 #1136

hl662 · 2025-01-07T19:21:06Z

For map-layers package:

Updated @itwin/itwinui-react to 3.16.0 - tests have been updated to no longer use .iui-xxxx class selectors, instead using [role="xxx"]. Also used data-testid where possible.
Updated eslint to 9.18.0, and relevant peerDeps of the pkg to latest.
Updated eslint config file to be ESM, addressed lint errors and warnings, including removing rule-disables that are outdated.
event.Keycode is deprecated, replaced usage with event.key in MapManagerSettings.
Removed usage of deprecated SpecialKey enums from appui-abstract, used string literals instead.

hl662 · 2025-01-16T15:11:09Z

@mdastous-bentley I did a visual check against the test-viewer in this repo, everything looks fine and is interactable to me, can you double check as well?

aruniverse · 2025-01-16T16:28:25Z

change/@itwin-map-layers-ccc19b28-3b8c-4963-aa0f-a5d8a10efa3a.json

@@ -0,0 +1,7 @@
+{
+  "type": "patch",


updating peers will technically be a major ver bump,
might be able to get away with minor here but that might piss off some,
if we do a major ver bump, id want to make sure we are going to the latest versions of 4.x and react to all deprecations

I changed this to minor, could be keen on doing major, after running the linter I've reacted to the deprecations in appui, no other deprecations were found (aside from event.Keycode)

id ant to update core and all other peer deps to the latest as well if we do a major bump

we could split that into multiple prs, just need to hold off on publishing map-layers pkg until we are ready, or we do pre-releases

I switched the changefile type to major and bumped all core pkgs and other peerDeps to the latest, minus appui-react and imodel-components-react (which would require bumping up to their 5.x vers). Do we want to bump those 2? Should we also update the peerDeps to the latest as well?

i would look at what that change means, im not sure how big of an update it will be for those pkgs

it's quite big... some of the components used from `imodel-components-react' are marked deprecated. On top of that, these 2 packages drop support for react 17, so we have to bump up to react 18, and respectively update peer deps of React. We'll have to use new components, edit the test cases and update type definitions for some of the react hooks in the package. Probably a larger amount of effort than what this PR is about

there are only 3 imports from imodel-components-react
i imagine the colorswatch components are deprecated in favor of itwinui v3 components which we should be using

also now that im looking i see there was a mixup on what latest meant, i meant the latest 4.x, not latest version of appui which is 5.0, my apologies, shouldve been more clear

instead of going directly to a major, we should publish a pre-release to make sure everything works, and can also look updating other peer dep majors to include in the full major release

…disable rules, use eslint 9

… new unnecessary no internal disable rule

eringram · 2025-01-16T22:35:54Z

Code changes look fine to me and I also did a quick test of the widget in the test viewer. (I did have trouble adding a new map layer, but ran into the same problem on master so I'm probably doing it wrong and it's unrelated to these changes). @mdastous-bentley would be able to better confirm

aruniverse · 2025-01-16T22:44:14Z

packages/itwin/map-layers/eslint.config.mjs

+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import iTwinPlugin from "@itwin/eslint-plugin";
+import reactPlugin from "eslint-plugin-react";


shouldnt we use the itwin ui eslint plugin config?
https://github.com/iTwin/eslint-plugin/blob/main/dist/configs/ui.js

aruniverse · 2025-01-16T22:45:44Z

packages/itwin/map-layers/src/ui/widget/AttachLayerPopupButton.tsx

@@ -389,6 +388,7 @@ function AttachLayerPanel({ isOverlay, onLayerAttached, onHandleOutsideClick }:
          await MapLayerPreferences.deleteByName(source, iTwinId, iModelId);
          const msg = MapLayersUI.localization.getLocalizedString("mapLayers:CustomAttach.RemoveLayerDefSuccess", { layerName });
          IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, msg));
+        // eslint-disable-next-line unused-imports/no-unused-vars


you could just delete err

catch { blah }

aruniverse · 2025-01-16T22:50:57Z

packages/itwin/map-layers/src/ui/FeatureInfoUiItemsProvider.tsx

@@ -70,7 +68,6 @@ export const getMapFeatureInfoToolItemDef = (): ToolItemDef =>
  });

 export class FeatureInfoUiItemsProvider implements UiItemsProvider {
-  // eslint-disable-line deprecation/deprecation


i dont get how this resolved the deprecation

aruniverse · 2025-01-16T22:51:28Z

packages/itwin/map-layers/src/ui/widget/TransparencyPopupButton.tsx

@@ -23,7 +22,7 @@ export interface TransparencyPopupButtonProps {
 }

 /** @alpha */
-// eslint-disable-next-line @typescript-eslint/naming-convention
+// eslint-disable-next-line @typescript-eslint/unbound-method


what is unbound?

aruniverse · 2025-01-16T22:52:36Z

packages/itwin/map-layers/src/ui/widget/SubLayersTree.tsx

@@ -114,7 +111,7 @@ export function SubLayersTree(props: SubLayersTreeProps) {
  // it selects/deselects node when checkbox is checked/unchecked and vice versa.
  // `useDisposable` takes care of disposing old event handler when new is created in case 'nodeLoader' has changed
  // `React.useCallback` is used to avoid creating new callback that creates handler on each render
-  const eventHandler = useDisposable(
+  const eventHandler = useOptionalDisposable(


was this due to deprecation?

aruniverse · 2025-01-16T22:55:41Z

packages/itwin/map-layers/src/ui/widget/MapLayerDroppable.tsx

@@ -249,7 +242,6 @@ export function MapLayerDroppable(props: MapLayerDroppableProps) {
            activeViewport={props.activeViewport}
            mapLayerSettings={activeLayer}
            onMenuItemSelection={props.onMenuItemSelected}
-            disabled={props.disabled}


why the change?

aruniverse · 2025-01-16T22:56:25Z

packages/itwin/map-layers/src/ui/widget/MapLayerActionButtons.tsx

@@ -1,10 +1,10 @@
+import * as React from "react";


this is a little gross with the imports above the copyright, you could just nuke all the copyrights or turn off your formatter

aruniverse · 2025-01-16T22:58:39Z

packages/itwin/map-layers/package.json

@@ -105,18 +101,18 @@
    "source-map-support": "^0.5.6",
    "ts-node": "^10.9.1",
    "typemoq": "^2.1.0",
-    "typescript": "~4.6.0"
+    "typescript": "~5.0.0"
  },
  "peerDependencies": {
    "@itwin/appui-abstract": "^4.0.0",


maybe you should update the core peers to the latest?

…d TODO to remove enzyme and etc

hl662 and others added 7 commits January 7, 2025 14:20

migrate map layers to itwinui 3, fix build errors

855e436

Merge branch 'master' into nam/map-layer-ui3

705d27b

update missing documentation, update deps

8f944c5

one test done...

ae8ca29

just mapManagerSettings tests left

ef0dfed

Merge remote-tracking branch 'origin/master' into nam/map-layer-ui3

f91c7fb

fix the remaining test

cc2f4ec

hl662 changed the title ~~migrate map layers to itwinui 3~~ [map-layers] migrate map layers to itwinui 3 Jan 16, 2025

hl662 marked this pull request as ready for review January 16, 2025 15:10

hl662 requested review from mdastous-bentley, eringram and a team as code owners January 16, 2025 15:10

Empty commit

2fb5767

aruniverse reviewed Jan 16, 2025

View reviewed changes

hl662 added 3 commits January 16, 2025 12:32

replace deprecated event.Keycode

fa304dd

update itwin eslint to 5.x, related deps to latest, removed unneeded …

4a9536a

…disable rules, use eslint 9

update changefile to use minor

1435cb4

hl662 self-assigned this Jan 16, 2025

update changefile to be major, bump itwin core pkgs to latest, remove…

626d893

… new unnecessary no internal disable rule

aruniverse reviewed Jan 16, 2025

View reviewed changes

aruniverse mentioned this pull request Jan 17, 2025

Remove appui-layout-react dep from map-layers and measure-tools #845

Closed

address imodel components react deprecations, bump up to react 18, ad…

60f39c7

…d TODO to remove enzyme and etc

hl662 marked this pull request as draft January 17, 2025 20:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[map-layers] migrate map layers to itwinui 3 #1136

[map-layers] migrate map layers to itwinui 3 #1136

hl662 commented Jan 7, 2025 •

edited

Loading

hl662 commented Jan 16, 2025

aruniverse Jan 16, 2025

hl662 Jan 16, 2025 •

edited

Loading

aruniverse Jan 16, 2025

aruniverse Jan 16, 2025

hl662 Jan 16, 2025 •

edited

Loading

aruniverse Jan 16, 2025

hl662 Jan 16, 2025

aruniverse Jan 16, 2025

aruniverse Jan 16, 2025

aruniverse Jan 17, 2025

eringram commented Jan 16, 2025

aruniverse Jan 16, 2025

aruniverse Jan 16, 2025

aruniverse Jan 16, 2025

aruniverse Jan 16, 2025

aruniverse Jan 16, 2025

aruniverse Jan 16, 2025

aruniverse Jan 16, 2025

aruniverse Jan 16, 2025

[map-layers] migrate map layers to itwinui 3 #1136

Are you sure you want to change the base?

[map-layers] migrate map layers to itwinui 3 #1136

Conversation

hl662 commented Jan 7, 2025 • edited Loading

hl662 commented Jan 16, 2025

Choose a reason for hiding this comment

hl662 Jan 16, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hl662 Jan 16, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eringram commented Jan 16, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hl662 commented Jan 7, 2025 •

edited

Loading

hl662 Jan 16, 2025 •

edited

Loading

hl662 Jan 16, 2025 •

edited

Loading