• English
  • ProComponents API Changes Summary (2.0 → 3.0)

    Quick Reference

    Removed APIs

    ComponentOld APINew APIDescription
    ProTablecolumnsStateMapcolumnsState.valueColumn state management
    ProTablehideInSearchsearch: falseHide from search
    ProTablefixHeaderscroll: { y: 400 }Fix table header
    ProTabletiptooltipTooltip information
    ProCardTabPanetabs.itemsTab configuration
    ProLayoutrightContentRenderactionsRender + avatarPropsRight content rendering
    Layout TokenmarginInlinePageContainerContentpaddingInlinePageContainerContentPage container inline padding
    Layout TokenmarginBlockPageContainerContentpaddingBlockPageContainerContentPage container block padding
    ProFormFieldplainvariantField display variant

    Version Requirements Changes

    • antd: >= 4.20.0 → >= 6.0.0
    • React: >= 16.9.0 → >= 18.0.0

    Package Version Changes

    v3 only publishes the single @ant-design/pro-components package. The standalone packages on npm remain on v2 and must not be mixed with antd 6.

    Migration Checklist

    Table Component

    • columnsStateMap → columnsState.value
    • hideInSearch → search: false
    • fixHeader → scroll: { y: 400 }
    • tip → tooltip

    Card Component

    • TabPane → tabs.items
    • StatisticsCardProps → StatisticCardProps

    Layout Component

    • rightContentRender → actionsRender + avatarProps
    • Layout token property renaming

    ProFormField / Field Component

    • plain → Removed, use variant instead (e.g. variant: 'borderless' or variant: 'outlined')

    Compatibility

    • Remove antd@4 compatibility code
    • Update antd version to 6.0.0+

    Common Migration Commands

    # Search for deprecated APIs
    grep -r "columnsStateMap" src/
    grep -r "hideInSearch" src/
    grep -r "fixHeader" src/
    grep -r "tip" src/
    grep -r "TabPane" src/
    grep -r "rightContentRender" src/
    grep -r "plain" src/
    
    # Update dependencies
    npm install antd@^6.0.0
    npm install @ant-design/pro-components@beta

    Rollback Plan

    npm install @ant-design/pro-components@^2.8.10
    npm install antd@^4.24.0

    For detailed migration guide, please refer to: migration-guide.en-US.md