Skip to content

Latest commit

 

History

History
62 lines (47 loc) · 4.27 KB

v4-migration.md

File metadata and controls

62 lines (47 loc) · 4.27 KB
Raw

v4 Upgrade Guide

Follow the sections below for upgrading from v3 to v4.

Prerequisites

Moving to v4 of this library requires you to be coming from v3. If you are are upgrading from v2, first follow the upgrade guide for v3 and then come back here to continue with the v4 upgrade.

Removed Components

Component Reason Replacement
GraphicLoch Internal component No
GraphicWrangler Internal component No
HeaderMenuButton Internal component HeaderMenuItem
HeaderMenuItem Internal component HeaderMenuItem
HeaderMenuLink Internal component HeaderMenuItem
HeaderMenuUser Internal component HeaderMenuItem
LeftSideNav Uneeded for consumers No, it can be removed from use in-app
LoadingAnimation Addons Alternative Loading
NoDisplay Addons Alternative Error404
OptionsGrid Addons Alternative CheckboxList
Sidenav Carbon Alternative Carbon Sidenav

UIShell

The following is a minimal implementation of the UIShell. The navigation and user values continue to be the response from the IBM Services Essentials platform.

<UIShell config={navigation} skipToContentProps={{ href: "#content" }} user={user} />

There have been several updates to the props for UIShell. We have TypeScript types that you can inspect to see what the props are for the UIShell but the following have been changed:

Added props

Prop Purpose
profileMenuItems Display custom HeaderMenuItems in the profile menu
supportMenuItems Display custom HeaderMenuItems in the support menu

Removed props

Prop Replacement
appName productName
companyName platformName
isFlowApp No
onMenuClick leftPanel prop
onTutorialClick Provide custom button HeaderMenuItem via supportMenuItems prop
renderFlowDocs Provide custom link HeaderMenuItem via profileMenuItems prop
renderLogo None, there is no built in logo anymore
renderRequests None, unused and driven via user response

Renamed props

  • baseLaunchEnvUrl -> baseEnvUrl
  • baseServiceUrl -> baseServicesUrl
  • headerConfig -> config
  • renderGdprRedirect -> renderPrivacyRedirect
  • renderRightPanel -> rightPanel
  • renderSidenav -> leftPanel