Skip to content

Latest commit

 

History

History
161 lines (122 loc) · 7.54 KB

v2.md

File metadata and controls

161 lines (122 loc) · 7.54 KB
Raw

Carbon for IBM Products: v2 migration guide

This document will review in detail the changes in Carbon for IBM Products v1 to v2. Because Carbon for IBM Products v2 uses Carbon v11, which utilizes Sass modules, there is a requirement for teams to use the Dart Sass package (sass), as opposed to node-sass. This introduces some new sass concepts such as @use vs @import and namespaces. For Carbon v11 migration guidance, see their migration guide.

v1 and v2 will both receive weekly releases occurring every Tuesday morning.

List of component changes

Component Changes
AboutModal View changes here
APIKeyModal No API changes.
ActionBar View changes here
Cascade No API changes.
CreateModal No API changes.
CreateFullPage No API changes.
CreateFullPageStep No API changes.
CreateSidePanel No API changes.
CreateTearsheetNarrow No API changes.
CreateTearsheet No API changes.
CreateTearsheetStep No API changes.
DataSpreadsheet No API changes.
Datagrid View changes here
EditInPlace View changes here
EditSidePanel View changes here
EditTearsheet No API changes.
EditTearsheetNarrow No API changes.
EditFullPage No API changes.
EditUpdateCards No API changes.
EmptyState View changes here
ExportModal No API changes.
ExpressiveCard View changes here
HTTPError403 No API changes. New version here
HTTPError404 No API changes. New version here
HTTPErrorOther No API changes. New version here
ImportModal No API changes.
InlineEdit View changes here
ModifiedTabs This component is deprecated in v2
MultiAddSelect No API changes.
NotificationsPanel No API changes.
OptionsTile No API changes.
PageHeader No API changes.
ProductiveCard View changes here
RemoveModal No API changes.
Saving No API changes.
SidePanel View changes here
SingleAddSelect No API changes.
StatusIcon View changes here
TagSet View changes here
Tearsheet No API changes.
TearsheetNarrow No API changes.
Toolbar No API changes.
ToolbarButton View changes here
ToolbarGroup No API changes.
UserProfileImage View changes here
WebTerminal No API changes.
WebTerminalContentWrapper No API changes.
WebTerminalProvider No API changes.

AboutModal

  • additionalInfo prop has changed from PropTypes.array to PropTypes.node.
  • New version prop has been added.
  • Carbon Modal now requires an aria label, thus modalAriaLabel is required.
  • legalText prop is removed, this content should be included in the content prop

ActionBar

  • iconDescription has changed to label
  • Each action from the actions prop is required to include a label property.

Datagrid

  • useInlineEdit has been renamed to useEditableCell
  • The following hooks are feature flagged until further review:
    • useInfiniteScroll
    • useEditableCell
    • useExpandedRow
    • useNestedRows
    • useActionsColumn
    • useFiltering
    • useCustomizeColumns

EditInPlace

  • Renamed from InlineEdit v1 and v2 properties removed

EditSidePanel

  • The max size option, from the size prop, has been renamed to 2xl to further align with Carbon naming conventions.

EmptyState

  • New illustrationPosition prop: 'top', 'right', 'bottom', 'left'

ExpressiveCard

  • pictogram can now be either a function or object.

FullPageError

  • HTTPError403,HTTPError404, HTTPErrorOther are deprecated and will be removed in the next major version. Please migrate to FullPageError, view docs.

  • errorCodeLabel --> label

  • links prop is removed; links can be passed as children instead

  • New kind prop: '404', '403', 'custom'

IconButtonBar

  • The IconButtonBar is removed in V2 as the existing ActionBar is a viable replacement.

InlineEdit

  • Renamed to EditInPlace v1 and v2 properties removed.

ProductiveCard

  • New overflowAriaLabel prop is required if items are passed to overflowActions.

SidePanel

  • The max size option, from the size prop, has been renamed to 2xl to further align with Carbon naming conventions.

StatusIcon

  • The xlg size option, from the size prop, has been renamed to xl to further align with Carbon naming conventions.

TagSet

  • overflowDirection has been removed. Instead, use overflowAlign which includes new options that are passed to the Carbon tooltip component. To see the available options for the Tooltip's align prop, view here.

ToolbarButton

  • iconDescription and renderIcon are now both required props.

UserProfileImage

  • The xlg size option, from the size prop, has been renamed to xl to further align with Carbon naming conventions.