@coinbase/cds-mcp-server 9.0.0-rc.2 → 9.0.0-rc.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +52 -0
- package/mcp-docs/mobile/components/DateInput.txt +3 -1
- package/mcp-docs/mobile/components/DatePicker.txt +3 -1
- package/mcp-docs/mobile/components/HeroSquare.txt +33 -4
- package/mcp-docs/mobile/components/IconButton.txt +10 -0
- package/mcp-docs/mobile/components/PageFooter.txt +23 -0
- package/mcp-docs/mobile/components/PeriodSelector.txt +2 -1
- package/mcp-docs/mobile/components/Pictogram.txt +28 -3
- package/mcp-docs/mobile/components/SearchInput.txt +3 -1
- package/mcp-docs/mobile/components/SegmentedTabs.txt +29 -1
- package/mcp-docs/mobile/components/SelectOption.txt +77 -0
- package/mcp-docs/mobile/components/SpotIcon.txt +28 -3
- package/mcp-docs/mobile/components/SpotRectangle.txt +28 -3
- package/mcp-docs/mobile/components/SpotSquare.txt +28 -3
- package/mcp-docs/mobile/components/TabbedChipsAlpha.txt +2 -1
- package/mcp-docs/mobile/components/Tabs.txt +38 -22
- package/mcp-docs/mobile/components/TextInput.txt +3 -1
- package/mcp-docs/mobile/guides/_v9MobileInstallCommands.txt +9 -0
- package/mcp-docs/mobile/guides/_v9MobilePeerDependencies.txt +15 -0
- package/mcp-docs/mobile/guides/_v9WebInstallCommands.txt +9 -0
- package/mcp-docs/mobile/guides/_v9WebPeerDependencies.txt +5 -0
- package/mcp-docs/mobile/guides/v9-migration-guide.txt +348 -0
- package/mcp-docs/mobile/routes.txt +5 -0
- package/mcp-docs/web/components/CellMedia.txt +1 -1
- package/mcp-docs/web/components/DateInput.txt +3 -0
- package/mcp-docs/web/components/DatePicker.txt +3 -0
- package/mcp-docs/web/components/FullscreenAlert.txt +1 -1
- package/mcp-docs/web/components/HeroSquare.txt +46 -5
- package/mcp-docs/web/components/IconButton.txt +9 -112
- package/mcp-docs/web/components/PageFooter.txt +23 -0
- package/mcp-docs/web/components/PeriodSelector.txt +2 -1
- package/mcp-docs/web/components/Pictogram.txt +39 -4
- package/mcp-docs/web/components/SearchInput.txt +3 -0
- package/mcp-docs/web/components/SegmentedTabs.txt +29 -1
- package/mcp-docs/web/components/SpotIcon.txt +39 -4
- package/mcp-docs/web/components/SpotRectangle.txt +39 -4
- package/mcp-docs/web/components/SpotSquare.txt +39 -4
- package/mcp-docs/web/components/TabbedChipsAlpha.txt +2 -1
- package/mcp-docs/web/components/Tabs.txt +38 -22
- package/mcp-docs/web/components/TextInput.txt +3 -0
- package/mcp-docs/web/guides/_v9MobileInstallCommands.txt +9 -0
- package/mcp-docs/web/guides/_v9MobilePeerDependencies.txt +15 -0
- package/mcp-docs/web/guides/_v9WebInstallCommands.txt +9 -0
- package/mcp-docs/web/guides/_v9WebPeerDependencies.txt +5 -0
- package/mcp-docs/web/guides/v9-migration-guide.txt +348 -0
- package/mcp-docs/web/routes.txt +5 -0
- package/package.json +1 -1
|
@@ -12,13 +12,13 @@ import { SpotSquare } from '@coinbase/cds-web/illustratations/SpotSquare'
|
|
|
12
12
|
|
|
13
13
|
## Examples
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
#### Basic example
|
|
16
16
|
|
|
17
17
|
```jsx live
|
|
18
18
|
<SpotSquare name="yieldCenterUSDC" />
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
#### `scaleMultiplier` prop
|
|
22
22
|
|
|
23
23
|
If no predefined dimensions fit your use case, you can use the `scaleMultiplier` prop to scale the illustration.
|
|
24
24
|
|
|
@@ -28,7 +28,7 @@ Use `scaleMultiplier` sparingly and with caution. We have predefined dimensions
|
|
|
28
28
|
<SpotSquare name="yieldCenterUSDC" scaleMultiplier={1.5} />
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
#### Scaling with dimension
|
|
32
32
|
|
|
33
33
|
If `dimension` and `scaleMultiplier` are both provided the component will scale based on the provided dimension.
|
|
34
34
|
|
|
@@ -36,14 +36,49 @@ If `dimension` and `scaleMultiplier` are both provided the component will scale
|
|
|
36
36
|
<SpotSquare name="yieldCenterUSDC" dimension="120x120" scaleMultiplier={1.5} />
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
+
### Theming
|
|
40
|
+
|
|
41
|
+
Use the `applyTheme` prop to enable dynamic theming. When set, the illustration is inlined into the page and colored by the active `ThemeProvider`'s illustration palette.
|
|
42
|
+
|
|
43
|
+
```jsx live
|
|
44
|
+
<SpotSquare applyTheme name="yieldCenterUSDC" />
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
To apply a custom brand palette, set `lightIllustrationColor` and `darkIllustrationColor` on your theme:
|
|
48
|
+
|
|
49
|
+
```jsx live
|
|
50
|
+
function ThemedSpotSquare() {
|
|
51
|
+
const customTheme = {
|
|
52
|
+
...defaultTheme,
|
|
53
|
+
lightIllustrationColor: {
|
|
54
|
+
...defaultTheme.lightIllustrationColor,
|
|
55
|
+
primary: 'rgb(220, 38, 38)',
|
|
56
|
+
accent1: 'rgb(124, 58, 237)',
|
|
57
|
+
},
|
|
58
|
+
darkIllustrationColor: {
|
|
59
|
+
...defaultTheme.darkIllustrationColor,
|
|
60
|
+
primary: 'rgb(248, 113, 113)',
|
|
61
|
+
accent1: 'rgb(167, 139, 250)',
|
|
62
|
+
},
|
|
63
|
+
};
|
|
64
|
+
|
|
65
|
+
return (
|
|
66
|
+
<ThemeProvider activeColorScheme="light" theme={customTheme}>
|
|
67
|
+
<SpotSquare applyTheme name="yieldCenterUSDC" />
|
|
68
|
+
</ThemeProvider>
|
|
69
|
+
);
|
|
70
|
+
}
|
|
71
|
+
```
|
|
72
|
+
|
|
39
73
|
## Props
|
|
40
74
|
|
|
41
75
|
| Prop | Type | Required | Default | Description |
|
|
42
76
|
| --- | --- | --- | --- | --- |
|
|
43
77
|
| `name` | `baseQuickBuy \| blockchain \| bridging \| coinbaseOneLogo \| earn \| nft \| options \| pieChartWithArrow \| priceAlerts \| refresh \| securityShield \| staking \| addCard \| baseCreatorCoin \| bonusFivePercent \| bonusTwoPercent \| cardBlocked \| cardDeclined \| coinbaseOneEarn \| coinbaseUnlockOffers \| ethStaking \| ethStakingRewards \| futures \| globalTransactions \| idError \| inrTrade \| instoAuthenticatorProgress \| lightningNetworkSend \| outage \| pieChartWithArrowBlue \| startToday \| wrapEth \| phoneNumber \| accessToAdvancedCharts \| addPhoneNumber \| advancedTrading \| advancedTradingChartsIndicatorsCandles \| advancedTradingUi \| appTrackingTransparency \| automaticPayments \| backedByUsDollar \| basedInUsa \| bigBtc \| borrowWallet \| browserExtension \| coinbaseCardLock \| coinbaseCardPocket \| coinbaseFees \| coinbaseOneDiscountedAmount \| coinbaseOneRewards \| coinbaseOneSavingFunds \| coinbaseOneTokenRewards \| coinbaseOneZeroPortal \| coinFifty \| collectingNfts \| commerceAccounting \| commerceInvoices \| completeAQuiz \| congratulationsOnEarningCrypto \| contactsListWarning \| crossBorderPayments \| cryptoAndMore \| cryptoApps \| cryptoAssets \| cryptoEconomy \| cryptoForBeginners \| cryptoPortfolio \| cryptoWallet \| decentralization \| decentralizedWebWeb3 \| defiDecentralizedBorrowingLending \| defiDecentralizedTradingExchange \| defiEarn \| defiHow \| defiRisk \| didDecentralizedIdentity \| digitalCollectibles \| documentCertified \| documentSuccess \| earnInterest \| earnToLearn \| encryptedEverything \| estimatedAmount \| focusLimitOrders \| freeBtc \| gainsAndLosses \| gasFeesNetworkFees \| getStartedInMinutes \| hardwareWallets \| holdCrypto \| holdingCrypto \| instoEthStakingRewards \| instoPrimeStaking \| instoStaking \| insuranceProtection \| invest \| layeredNetworks \| layerThree \| linkingYourWalletToYourCoinbaseAccount \| mining \| moneyDecentralized \| multicoinSupport \| multiPlatformMobileAppBrowserExtension \| multipleAccountsWalletsForOneUser \| noFees \| notificationsAlt \| onTheList \| openEmail \| optInPushNotificationsEmail \| p2pPayments \| performance \| portfolioPerformance \| poweredByEthereum \| predictionsMarkets \| primeDeFi \| primeEarn \| primeStaking \| quickAndSimple \| readyToTrade \| retailUSDCRewards \| secureAndTrusted \| secureGlobalTransactions \| secureStorage \| selfCustody \| semiCustodial \| sendCryptoFaster \| shareOnSocialMedia \| sidechain \| stableValue \| stayInControlSelfHostedWalletsStorage \| stressTestedColdStorage \| switchAdvancedToSimpleTrading \| taxesDetails \| tradeImmediately \| trendingHotAssets \| verifyEmail \| verifyInfo \| walletNotifications \| walletSecurity \| watchVideos \| eth2SendSell \| ethStakeOrWrap \| ethStakeOrWrapTwo \| linkCoinbaseWallet \| addEth \| addMultipleCrypto \| addPasswordProtection \| announcementAdvancedTrading \| assetForward \| assetRefresh \| baseCautionMedium \| baseChartMedium \| baseCheckMedium \| baseCheckTrophyMedium \| baseCoinCryptoMedium \| baseCoinNetworkMedium \| baseConnectMedium \| baseDecentralizationMedium \| baseDiamondMedium \| baseEmptyMedium \| baseErrorButterflyMedium \| baseErrorMedium \| baseIdMedium \| baseLoadingMedium \| baseLocationMedium \| baseMintNftMedium \| baseNetworkMedium \| baseNftMedium \| basePaycoinMedium \| basePeopleMedium \| basePiechartMedium \| baseRewardChest \| baseRewardClam \| baseRewardPlate \| baseRewardPodium \| baseRewardSun \| baseRewardTrophyEmblem \| baseRewardTrophyStars \| baseSecurityMedium \| baseSendMedium \| baseSwitch \| baseTargetMedium \| baseUsdcMedium \| boostedCard \| borrowLimitsAddressed \| bullishCase \| cardAnnouncement \| cardAutoReload \| cardShipped \| cbEthWrappingUnavailable \| checkVerifacation \| coinbaseCardSparkle \| coinbaseLock \| coinbaseOneBoostedCard \| coinbaseOneBoostedCardCB1 \| coinbaseOneConcierge \| coinbaseOneStakeOrWrap \| coinbaseOneStaking \| coinbaseOneStarToken \| coinbaseOneUSDC \| coinbaseOneZero \| confirmAddress \| confirmEmail \| confirmIDCard \| confirmSocialSecurity \| cryptoEconomyArrows \| dappWallet \| darkModeIntroduction \| defiEarnAnnouncement \| defiNfts \| directDepositExcitement \| earnInterestOnCryptocurrency \| fileYourCryptoTaxesCheckOther \| fileYourCryptoTaxesOther \| frameEmpty \| giftBoxCrypto \| gifting \| goldSilverFutures \| guideBullCase \| guideCryptoBeginner \| guideFiveThings \| guideNftDefi \| guideStartInvesting \| instantUnstaking \| instoDappWallet \| instoEthStaking \| instoPixDeposits \| instoSecurityKey \| instoSideChainSide \| instoUbiKey \| instoWaiting \| interestForYou \| miniGift \| moneyRewards \| nftTag \| noPortfolio \| nuxChecklist \| nuxEarnCrypto \| nuxEarnYield \| nuxPopularAssets \| nuxRecurringBuys \| offersEmpty \| phoneNotifications \| pixBankDeposits \| pixDeposits \| recommendInvestments \| referralsPeople \| refreshMobileApp \| rewardExpiring \| saveTheDate \| sparkleToken \| starToken \| swapEth \| switchReward \| taxDocuments \| transferringCrypto \| unsupportedAsset \| waitlistSignup \| walletApp \| walletQuestsChest \| walletQuestsTrophy \| yieldCenter \| yieldCenterUSDC` | Yes | `-` | Name of illustration as defined in Figma |
|
|
44
78
|
| `alt` | `string` | No | `"" will identify the image as decorative` | Alt tag to apply to the img |
|
|
79
|
+
| `applyTheme` | `boolean` | No | `-` | Apply the theme to the illustration |
|
|
45
80
|
| `dimension` | `96x96` | No | `-` | HeroSquare Default: 240x240 SpotSquare Default: 96x96 Pictogram Default: 48x48 SpotRectangle Default: 240x120 |
|
|
46
|
-
| `fallback` | `ReactElement<unknown, string \| JSXElementConstructor<any>> \| null` | No | `null` | Fallback element to render if unable to find an illustration with the matching name |
|
|
81
|
+
| `fallback` | `ReactElement<unknown, string \| JSXElementConstructor<any>> \| null` | No | `null` | Fallback element to render if unable to find an illustration with the matching name, or while the themed SVG is loading when applyTheme is set. |
|
|
47
82
|
| `scaleMultiplier` | `number` | No | `-` | Multiply the width & height while maintaining aspect ratio |
|
|
48
83
|
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. Under the hood, testID translates to data-testid on Web. On Mobile, testID stays the same - testID |
|
|
49
84
|
|
|
@@ -222,6 +222,7 @@ render(<Example />);
|
|
|
222
222
|
| `tabs` | `TabbedChipProps<TabId>[]` | Yes | `-` | - |
|
|
223
223
|
| `TabComponent` | `FC<TabbedChipProps<TabId>>` | No | `-` | - |
|
|
224
224
|
| `TabsActiveIndicatorComponent` | `TabsActiveIndicatorComponent` | No | `-` | - |
|
|
225
|
+
| `activeColor` | `currentColor \| fg \| fgMuted \| fgInverse \| fgPrimary \| fgWarning \| fgPositive \| fgNegative \| bg \| bgAlternate \| bgInverse \| bgOverlay \| bgElevation1 \| bgElevation2 \| bgPrimary \| bgPrimaryWash \| bgSecondary \| bgTertiary \| bgSecondaryWash \| bgNegative \| bgNegativeWash \| bgPositive \| bgPositiveWash \| bgWarning \| bgWarningWash \| bgLine \| bgLineHeavy \| bgLineInverse \| bgLinePrimary \| bgLinePrimarySubtle \| accentSubtleRed \| accentBoldRed \| accentSubtleGreen \| accentBoldGreen \| accentSubtleBlue \| accentBoldBlue \| accentSubtlePurple \| accentBoldPurple \| accentSubtleYellow \| accentBoldYellow \| accentSubtleGray \| accentBoldGray \| transparent \| ResponsiveValue<Color \| undefined>` | No | `-` | Active label color (from Tabs when set). |
|
|
225
226
|
| `alignContent` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| stretch \| baseline \| first baseline \| last baseline \| space-between \| space-around \| space-evenly>` | No | `-` | - |
|
|
226
227
|
| `alignItems` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
227
228
|
| `alignSelf` | `ResponsiveProp<center \| normal \| auto \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
@@ -248,7 +249,7 @@ render(<Example />);
|
|
|
248
249
|
| `borderedVertical` | `boolean` | No | `-` | Add a border to the top and bottom sides of the box. |
|
|
249
250
|
| `bottom` | `ResponsiveProp<Bottom<string \| number>>` | No | `-` | - |
|
|
250
251
|
| `classNames` | `{ root?: string; scrollContainer?: string \| undefined; tabs?: string \| undefined; } \| undefined` | No | `-` | - |
|
|
251
|
-
| `color` | `currentColor \| fg \| fgMuted \| fgInverse \| fgPrimary \| fgWarning \| fgPositive \| fgNegative \| bg \| bgAlternate \| bgInverse \| bgOverlay \| bgElevation1 \| bgElevation2 \| bgPrimary \| bgPrimaryWash \| bgSecondary \| bgTertiary \| bgSecondaryWash \| bgNegative \| bgNegativeWash \| bgPositive \| bgPositiveWash \| bgWarning \| bgWarningWash \| bgLine \| bgLineHeavy \| bgLineInverse \| bgLinePrimary \| bgLinePrimarySubtle \| accentSubtleRed \| accentBoldRed \| accentSubtleGreen \| accentBoldGreen \| accentSubtleBlue \| accentBoldBlue \| accentSubtlePurple \| accentBoldPurple \| accentSubtleYellow \| accentBoldYellow \| accentSubtleGray \| accentBoldGray \| transparent \| ResponsiveValue<Color \| undefined>` | No | `-` |
|
|
252
|
+
| `color` | `currentColor \| fg \| fgMuted \| fgInverse \| fgPrimary \| fgWarning \| fgPositive \| fgNegative \| bg \| bgAlternate \| bgInverse \| bgOverlay \| bgElevation1 \| bgElevation2 \| bgPrimary \| bgPrimaryWash \| bgSecondary \| bgTertiary \| bgSecondaryWash \| bgNegative \| bgNegativeWash \| bgPositive \| bgPositiveWash \| bgWarning \| bgWarningWash \| bgLine \| bgLineHeavy \| bgLineInverse \| bgLinePrimary \| bgLinePrimarySubtle \| accentSubtleRed \| accentBoldRed \| accentSubtleGreen \| accentBoldGreen \| accentSubtleBlue \| accentBoldBlue \| accentSubtlePurple \| accentBoldPurple \| accentSubtleYellow \| accentBoldYellow \| accentSubtleGray \| accentBoldGray \| transparent \| ResponsiveValue<Color \| undefined>` | No | `-` | Inactive label color (from Tabs when set). |
|
|
252
253
|
| `columnGap` | `0 \| 1 \| 5 \| 10 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 2 \| 3 \| 4 \| 6 \| 7 \| 8 \| 9 \| ResponsiveValue<Space \| undefined>` | No | `-` | - |
|
|
253
254
|
| `compact` | `boolean` | No | `false` | Turn on to use a compact Chip component for each tab. |
|
|
254
255
|
| `dangerouslySetBackground` | `string` | No | `-` | - |
|
|
@@ -12,11 +12,11 @@ import { Tabs, DefaultTabsActiveIndicator } from '@coinbase/cds-web/tabs'
|
|
|
12
12
|
|
|
13
13
|
## Examples
|
|
14
14
|
|
|
15
|
-
Tabs manages which tab is active and positions the animated indicator. For
|
|
15
|
+
Tabs manages which tab is active and positions the animated indicator. For **pill / segmented** controls, use [SegmentedTabs](/components/navigation/SegmentedTabs) instead.
|
|
16
16
|
|
|
17
17
|
### Basics
|
|
18
18
|
|
|
19
|
-
Out of the box, **`Tabs`** uses **`DefaultTab`** for each row (headline text, optional [DotCount](/components/other/DotCount/) via `count` / `max` on each tab) and **`DefaultTabsActiveIndicator`** for the animated underline. **`activeBackground`**
|
|
19
|
+
Out of the box, **`Tabs`** uses **`DefaultTab`** for each row (headline text, optional [DotCount](/components/other/DotCount/) via `count` / `max` on each tab) and **`DefaultTabsActiveIndicator`** for the animated underline. Set **`color`** / **`activeColor`** on **`Tabs`** for inactive / active label tokens, and **`activeBackground`** for the underline (forwarded to the indicator as its **`background`** token).
|
|
20
20
|
|
|
21
21
|
```jsx live
|
|
22
22
|
function Example() {
|
|
@@ -29,23 +29,15 @@ function Example() {
|
|
|
29
29
|
return (
|
|
30
30
|
<Tabs
|
|
31
31
|
accessibilityLabel="Example tabs"
|
|
32
|
-
activeBackground="bgPrimary"
|
|
33
32
|
activeTab={activeTab}
|
|
34
|
-
background="bg"
|
|
35
33
|
gap={4}
|
|
36
34
|
onChange={setActiveTab}
|
|
37
|
-
// default value; can be omitted.
|
|
38
|
-
TabComponent={DefaultTab}
|
|
39
35
|
tabs={tabs}
|
|
40
|
-
// default value; can be omitted.
|
|
41
|
-
TabsActiveIndicatorComponent={DefaultTabsActiveIndicator}
|
|
42
36
|
/>
|
|
43
37
|
);
|
|
44
38
|
}
|
|
45
39
|
```
|
|
46
40
|
|
|
47
|
-
You can omit `TabComponent` explicitly: **`Tabs`** defaults it to **`DefaultTab`**.
|
|
48
|
-
|
|
49
41
|
#### No initial selection
|
|
50
42
|
|
|
51
43
|
```jsx live
|
|
@@ -59,9 +51,7 @@ function Example() {
|
|
|
59
51
|
return (
|
|
60
52
|
<Tabs
|
|
61
53
|
accessibilityLabel="Example tabs"
|
|
62
|
-
activeBackground="bgPrimary"
|
|
63
54
|
activeTab={activeTab}
|
|
64
|
-
background="bg"
|
|
65
55
|
gap={4}
|
|
66
56
|
onChange={setActiveTab}
|
|
67
57
|
tabs={tabs}
|
|
@@ -84,9 +74,7 @@ function Example() {
|
|
|
84
74
|
return (
|
|
85
75
|
<Tabs
|
|
86
76
|
accessibilityLabel="Mail folders"
|
|
87
|
-
activeBackground="bgPrimary"
|
|
88
77
|
activeTab={activeTab}
|
|
89
|
-
background="bg"
|
|
90
78
|
gap={4}
|
|
91
79
|
onChange={setActiveTab}
|
|
92
80
|
tabs={tabs}
|
|
@@ -110,9 +98,40 @@ function Example() {
|
|
|
110
98
|
return (
|
|
111
99
|
<Tabs
|
|
112
100
|
accessibilityLabel="Example tabs"
|
|
113
|
-
activeBackground="bgPrimary"
|
|
114
101
|
activeTab={activeTab}
|
|
115
|
-
|
|
102
|
+
gap={4}
|
|
103
|
+
onChange={setActiveTab}
|
|
104
|
+
tabs={tabs}
|
|
105
|
+
/>
|
|
106
|
+
);
|
|
107
|
+
}
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Accessibility
|
|
111
|
+
|
|
112
|
+
Provide a descriptive **`accessibilityLabel`** on **`Tabs`** for the tab list. **`DefaultTab`** sets `aria-controls` / `aria-selected` for each tab; pair tabs with **`role="tabpanel"`** regions in your page content when you switch panels.
|
|
113
|
+
|
|
114
|
+
### Styling
|
|
115
|
+
|
|
116
|
+
#### Colors
|
|
117
|
+
|
|
118
|
+
You can set **`color`** and **`activeColor`** for label tokens, and **`activeBackground`** for the underline.
|
|
119
|
+
|
|
120
|
+
```jsx live
|
|
121
|
+
function Example() {
|
|
122
|
+
const tabs = [
|
|
123
|
+
{ id: 'tab1', label: 'Tab 1' },
|
|
124
|
+
{ id: 'tab2', label: 'Tab 2' },
|
|
125
|
+
{ id: 'tab3', label: 'Tab 3' },
|
|
126
|
+
];
|
|
127
|
+
const [activeTab, setActiveTab] = useState(tabs[0]);
|
|
128
|
+
return (
|
|
129
|
+
<Tabs
|
|
130
|
+
accessibilityLabel="Example tabs"
|
|
131
|
+
activeBackground="fg"
|
|
132
|
+
activeColor="fg"
|
|
133
|
+
activeTab={activeTab}
|
|
134
|
+
color="fgMuted"
|
|
116
135
|
gap={4}
|
|
117
136
|
onChange={setActiveTab}
|
|
118
137
|
tabs={tabs}
|
|
@@ -151,7 +170,7 @@ function Example() {
|
|
|
151
170
|
}, []);
|
|
152
171
|
|
|
153
172
|
const ActiveIndicator = useCallback(
|
|
154
|
-
(props) => <TabsActiveIndicator {...props} background="
|
|
173
|
+
(props) => <TabsActiveIndicator {...props} background="bgPositive" bottom={0} height={2} />,
|
|
155
174
|
[],
|
|
156
175
|
);
|
|
157
176
|
|
|
@@ -220,10 +239,6 @@ function Example() {
|
|
|
220
239
|
}
|
|
221
240
|
```
|
|
222
241
|
|
|
223
|
-
### Accessibility
|
|
224
|
-
|
|
225
|
-
Provide a descriptive **`accessibilityLabel`** on **`Tabs`** for the tab list. **`DefaultTab`** sets `aria-controls` / `aria-selected` for each tab; pair tabs with **`role="tabpanel"`** regions in your page content when you switch panels.
|
|
226
|
-
|
|
227
242
|
## Props
|
|
228
243
|
|
|
229
244
|
| Prop | Type | Required | Default | Description |
|
|
@@ -234,6 +249,7 @@ Provide a descriptive **`accessibilityLabel`** on **`Tabs`** for the tab list. *
|
|
|
234
249
|
| `TabComponent` | `TabComponent<TabId, TTab>` | No | `-` | The default Component to render each tab. |
|
|
235
250
|
| `TabsActiveIndicatorComponent` | `TabsActiveIndicatorComponent` | No | `-` | The default Component to render the tabs active indicator. |
|
|
236
251
|
| `activeBackground` | `currentColor \| fg \| fgMuted \| fgInverse \| fgPrimary \| fgWarning \| fgPositive \| fgNegative \| bg \| bgAlternate \| bgInverse \| bgOverlay \| bgElevation1 \| bgElevation2 \| bgPrimary \| bgPrimaryWash \| bgSecondary \| bgTertiary \| bgSecondaryWash \| bgNegative \| bgNegativeWash \| bgPositive \| bgPositiveWash \| bgWarning \| bgWarningWash \| bgLine \| bgLineHeavy \| bgLineInverse \| bgLinePrimary \| bgLinePrimarySubtle \| accentSubtleRed \| accentBoldRed \| accentSubtleGreen \| accentBoldGreen \| accentSubtleBlue \| accentBoldBlue \| accentSubtlePurple \| accentBoldPurple \| accentSubtleYellow \| accentBoldYellow \| accentSubtleGray \| accentBoldGray \| transparent` | No | `-` | Background color passed to the TabsActiveIndicatorComponent. |
|
|
252
|
+
| `activeColor` | `currentColor \| fg \| fgMuted \| fgInverse \| fgPrimary \| fgWarning \| fgPositive \| fgNegative \| bg \| bgAlternate \| bgInverse \| bgOverlay \| bgElevation1 \| bgElevation2 \| bgPrimary \| bgPrimaryWash \| bgSecondary \| bgTertiary \| bgSecondaryWash \| bgNegative \| bgNegativeWash \| bgPositive \| bgPositiveWash \| bgWarning \| bgWarningWash \| bgLine \| bgLineHeavy \| bgLineInverse \| bgLinePrimary \| bgLinePrimarySubtle \| accentSubtleRed \| accentBoldRed \| accentSubtleGreen \| accentBoldGreen \| accentSubtleBlue \| accentBoldBlue \| accentSubtlePurple \| accentBoldPurple \| accentSubtleYellow \| accentBoldYellow \| accentSubtleGray \| accentBoldGray \| transparent \| ResponsiveValue<Color>` | No | `-` | Active label color (from Tabs when set). |
|
|
237
253
|
| `alignContent` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| stretch \| baseline \| first baseline \| last baseline \| space-between \| space-around \| space-evenly>` | No | `-` | - |
|
|
238
254
|
| `alignItems` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
239
255
|
| `alignSelf` | `ResponsiveProp<center \| normal \| auto \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
@@ -260,7 +276,7 @@ Provide a descriptive **`accessibilityLabel`** on **`Tabs`** for the tab list. *
|
|
|
260
276
|
| `borderedVertical` | `boolean` | No | `-` | Add a border to the top and bottom sides of the box. |
|
|
261
277
|
| `bottom` | `ResponsiveProp<Bottom<string \| number>>` | No | `-` | - |
|
|
262
278
|
| `classNames` | `{ root?: string; tab?: string \| undefined; activeIndicator?: string \| undefined; } \| undefined` | No | `-` | Custom class names for individual elements of the Tabs component |
|
|
263
|
-
| `color` | `currentColor \| fg \| fgMuted \| fgInverse \| fgPrimary \| fgWarning \| fgPositive \| fgNegative \| bg \| bgAlternate \| bgInverse \| bgOverlay \| bgElevation1 \| bgElevation2 \| bgPrimary \| bgPrimaryWash \| bgSecondary \| bgTertiary \| bgSecondaryWash \| bgNegative \| bgNegativeWash \| bgPositive \| bgPositiveWash \| bgWarning \| bgWarningWash \| bgLine \| bgLineHeavy \| bgLineInverse \| bgLinePrimary \| bgLinePrimarySubtle \| accentSubtleRed \| accentBoldRed \| accentSubtleGreen \| accentBoldGreen \| accentSubtleBlue \| accentBoldBlue \| accentSubtlePurple \| accentBoldPurple \| accentSubtleYellow \| accentBoldYellow \| accentSubtleGray \| accentBoldGray \| transparent \| ResponsiveValue<Color
|
|
279
|
+
| `color` | `currentColor \| fg \| fgMuted \| fgInverse \| fgPrimary \| fgWarning \| fgPositive \| fgNegative \| bg \| bgAlternate \| bgInverse \| bgOverlay \| bgElevation1 \| bgElevation2 \| bgPrimary \| bgPrimaryWash \| bgSecondary \| bgTertiary \| bgSecondaryWash \| bgNegative \| bgNegativeWash \| bgPositive \| bgPositiveWash \| bgWarning \| bgWarningWash \| bgLine \| bgLineHeavy \| bgLineInverse \| bgLinePrimary \| bgLinePrimarySubtle \| accentSubtleRed \| accentBoldRed \| accentSubtleGreen \| accentBoldGreen \| accentSubtleBlue \| accentBoldBlue \| accentSubtlePurple \| accentBoldPurple \| accentSubtleYellow \| accentBoldYellow \| accentSubtleGray \| accentBoldGray \| transparent \| ResponsiveValue<Color>` | No | `-` | Inactive label color (from Tabs when set). |
|
|
264
280
|
| `columnGap` | `0 \| 1 \| 5 \| 10 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 2 \| 3 \| 4 \| 6 \| 7 \| 8 \| 9 \| ResponsiveValue<Space \| undefined>` | No | `-` | - |
|
|
265
281
|
| `dangerouslySetBackground` | `string` | No | `-` | - |
|
|
266
282
|
| `disabled` | `boolean` | No | `-` | Disable interactions on all the tabs. |
|
|
@@ -719,6 +719,8 @@ function testExample() {
|
|
|
719
719
|
| `justifyContent` | `ResponsiveProp<left \| right \| center \| normal \| start \| end \| flex-start \| flex-end \| stretch \| space-between \| space-around \| space-evenly>` | No | `-` | - |
|
|
720
720
|
| `key` | `Key \| null` | No | `-` | - |
|
|
721
721
|
| `label` | `string` | No | `-` | Short messageArea indicating purpose of input |
|
|
722
|
+
| `labelColor` | `currentColor \| fg \| fgMuted \| fgInverse \| fgPrimary \| fgWarning \| fgPositive \| fgNegative \| bg \| bgAlternate \| bgInverse \| bgOverlay \| bgElevation1 \| bgElevation2 \| bgPrimary \| bgPrimaryWash \| bgSecondary \| bgTertiary \| bgSecondaryWash \| bgNegative \| bgNegativeWash \| bgPositive \| bgPositiveWash \| bgWarning \| bgWarningWash \| bgLine \| bgLineHeavy \| bgLineInverse \| bgLinePrimary \| bgLinePrimarySubtle \| accentSubtleRed \| accentBoldRed \| accentSubtleGreen \| accentBoldGreen \| accentSubtleBlue \| accentBoldBlue \| accentSubtlePurple \| accentBoldPurple \| accentSubtleYellow \| accentBoldYellow \| accentSubtleGray \| accentBoldGray \| transparent` | No | `-` | Color token for the field label. |
|
|
723
|
+
| `labelFont` | `display1 \| display2 \| display3 \| title1 \| title2 \| title3 \| title4 \| headline \| body \| label1 \| label2 \| caption \| legal` | No | `-` | Typography token for the field label. |
|
|
722
724
|
| `labelNode` | `null \| string \| number \| bigint \| false \| true \| ReactElement<unknown, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal \| Promise<AwaitedReactNode>` | No | `-` | React node to render label. Takes precedence over label. |
|
|
723
725
|
| `labelVariant` | `inside \| outside` | No | `'outside'` | The variant of the label. Only used when compact is not true. |
|
|
724
726
|
| `left` | `ResponsiveProp<Left<string \| number>>` | No | `-` | - |
|
|
@@ -747,6 +749,7 @@ function testExample() {
|
|
|
747
749
|
| `pin` | `top \| bottom \| left \| right \| all` | No | `-` | Direction in which to absolutely pin the box. |
|
|
748
750
|
| `placeholder` | `string` | No | `-` | Placeholder text displayed inside of the input. Will be replaced if there is a value. |
|
|
749
751
|
| `position` | `ResponsiveProp<fixed \| static \| relative \| absolute \| sticky>` | No | `-` | - |
|
|
752
|
+
| `readOnly` | `boolean` | No | `-` | When true, the value cannot be edited but the control may remain focusable (unlike disabled). |
|
|
750
753
|
| `ref` | `null \| RefObject<HTMLButtonElement \| null> \| (instance: HTMLButtonElement \| null) => void \| (() => VoidOrUndefinedOnly)` | No | `-` | Allows getting a ref to the component instance. Once the component unmounts, React will set ref.current to null (or call the ref with null if you passed a callback ref). |
|
|
751
754
|
| `right` | `ResponsiveProp<Right<string \| number>>` | No | `-` | - |
|
|
752
755
|
| `rowGap` | `0 \| 1 \| 5 \| 10 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 2 \| 3 \| 4 \| 6 \| 7 \| 8 \| 9 \| ResponsiveValue<Space \| undefined>` | No | `-` | - |
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
**📖 Live documentation:** https://cds.coinbase.com/guides/_v9MobileInstallCommands/
|
|
2
|
+
|
|
3
|
+
```bash
|
|
4
|
+
# npm
|
|
5
|
+
npm install @coinbase/cds-common@9.0.0-rc.2 @coinbase/cds-mobile@9.0.0-rc.2
|
|
6
|
+
|
|
7
|
+
# yarn
|
|
8
|
+
yarn add @coinbase/cds-common@9.0.0-rc.2 @coinbase/cds-mobile@9.0.0-rc.2
|
|
9
|
+
```
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
**📖 Live documentation:** https://cds.coinbase.com/guides/_v9MobilePeerDependencies/
|
|
2
|
+
|
|
3
|
+
<br />
|
|
4
|
+
|
|
5
|
+
| Package | Previous range | Required range |
|
|
6
|
+
| -------------------------------- | -------------- | -------------- |
|
|
7
|
+
| `react` | `^18.3.1` | `~19.1.2` |
|
|
8
|
+
| `react-native` | `^0.74.5` | `~0.81.5` |
|
|
9
|
+
| `lottie-react-native` | `^6.7.0` | `7.3.1` |
|
|
10
|
+
| `react-native-gesture-handler` | `^2.16.2` | `2.28.0` |
|
|
11
|
+
| `react-native-reanimated` | `^3.14.0` | `4.1.1` |
|
|
12
|
+
| `react-native-safe-area-context` | `^4.10.5` | `5.6.0` |
|
|
13
|
+
| `react-native-svg` | `^14.1.0` | `15.12.1` |
|
|
14
|
+
| `@shopify/react-native-skia` | - | `2.2.12` |
|
|
15
|
+
| `react-native-worklets` | - | `0.5.2` |
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
**📖 Live documentation:** https://cds.coinbase.com/guides/_v9WebInstallCommands/
|
|
2
|
+
|
|
3
|
+
```bash
|
|
4
|
+
# npm
|
|
5
|
+
npm install @coinbase/cds-common@9.0.0-rc.2 @coinbase/cds-web@9.0.0-rc.2
|
|
6
|
+
|
|
7
|
+
# yarn
|
|
8
|
+
yarn add @coinbase/cds-common@9.0.0-rc.2 @coinbase/cds-web@9.0.0-rc.2
|
|
9
|
+
```
|
|
@@ -0,0 +1,348 @@
|
|
|
1
|
+
**📖 Live documentation:** https://cds.coinbase.com/guides/v9-migration-guide/
|
|
2
|
+
|
|
3
|
+
---
|
|
4
|
+
id: v9-migration-guide
|
|
5
|
+
title: v9 Upgrade Guide
|
|
6
|
+
slug: /guides/v9-upgrade-guide
|
|
7
|
+
hide_title: true
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
import { MDXSection } from '@site/src/components/page/MDXSection';
|
|
11
|
+
import { MDXArticle } from '@site/src/components/page/MDXArticle';
|
|
12
|
+
import { ContentHeader } from '@site/src/components/page/ContentHeader';
|
|
13
|
+
import { DeprecationTable } from '@site/src/components/page/DeprecationTable';
|
|
14
|
+
import { StandalonePlatformSwitcher } from '@site/src/components/page/PlatformSwitcher';
|
|
15
|
+
import { VStack, HStack } from '@coinbase/cds-web/layout';
|
|
16
|
+
import { Text } from '@coinbase/cds-web/typography/Text';
|
|
17
|
+
import { Tag } from '@coinbase/cds-web/tag/Tag';
|
|
18
|
+
|
|
19
|
+
import {
|
|
20
|
+
componentDeprecations,
|
|
21
|
+
hookFunctionDeprecations,
|
|
22
|
+
tokenConstantDeprecations,
|
|
23
|
+
typeDeprecations,
|
|
24
|
+
} from '@site/src/data/v9Deprecations';
|
|
25
|
+
|
|
26
|
+
import WebInstallCommands from './_v9WebInstallCommands.mdx';
|
|
27
|
+
import MobileInstallCommands from './_v9MobileInstallCommands.mdx';
|
|
28
|
+
import WebPeerDependencies from './_v9WebPeerDependencies.mdx';
|
|
29
|
+
import MobilePeerDependencies from './_v9MobilePeerDependencies.mdx';
|
|
30
|
+
|
|
31
|
+
<VStack gap={5}>
|
|
32
|
+
<ContentHeader title="v9 Upgrade Guide" />
|
|
33
|
+
|
|
34
|
+
<MDXSection>
|
|
35
|
+
<MDXArticle>
|
|
36
|
+
|
|
37
|
+
## 👋 Introduction
|
|
38
|
+
|
|
39
|
+
CDS 9 builds on the foundation laid in v8 and focuses on stability, modernization, and addressing specific debt that improves future maintainability.
|
|
40
|
+
|
|
41
|
+
Highlights of this release:
|
|
42
|
+
|
|
43
|
+
- 🔮 React 19 support on web (with backwards compatibility for React 18)
|
|
44
|
+
- 📱 React Native 0.81 / Expo SDK 54 support on mobile
|
|
45
|
+
- 📐 Eliminates hard-coded fixed widths/heights from all components to improve customizability and themeability
|
|
46
|
+
- 🎯 Consolidates standalone visualization packages in order to simplify the CDS ecosystem
|
|
47
|
+
- 🌬️ NEW migrator tool (`@coinbase/cds-migrator`) to help with this and future upgrades
|
|
48
|
+
|
|
49
|
+
</MDXArticle>
|
|
50
|
+
</MDXSection>
|
|
51
|
+
|
|
52
|
+
<MDXSection>
|
|
53
|
+
<MDXArticle>
|
|
54
|
+
|
|
55
|
+
## 📦 Packages
|
|
56
|
+
|
|
57
|
+
The following CDS packages are receiving new versions:
|
|
58
|
+
|
|
59
|
+
- `@coinbase/cds-common@9.0.0-rc.2`
|
|
60
|
+
- `@coinbase/cds-web@9.0.0-rc.2`
|
|
61
|
+
- `@coinbase/cds-mobile@9.0.0-rc.2`
|
|
62
|
+
- `@coinbase/cds-mcp-server@9.0.0-rc.2`
|
|
63
|
+
- `@coinbase/cds-migrator@1.0.0`{' '} <Tag colorScheme="blue">New</Tag>
|
|
64
|
+
|
|
65
|
+
:::tip Release Candidate Status
|
|
66
|
+
CDS 9 is currently in release candidate status. There are no breaking changes planned prior to the official release of 9.0.0. So it is safe to upgrade to `9.0.0-rc.2` if you want to get an early start.
|
|
67
|
+
:::
|
|
68
|
+
|
|
69
|
+
In CDS 9, we are deprecating the standalone visualization packages. See the [Deprecated packages](#packages) for more details.
|
|
70
|
+
|
|
71
|
+
- `@coinbase/cds-web-visualization`{' '} <Tag colorScheme="red">Deprecated</Tag>
|
|
72
|
+
- `@coinbase/cds-mobile-visualization`{' '} <Tag colorScheme="red">Deprecated</Tag>
|
|
73
|
+
|
|
74
|
+
</MDXArticle>
|
|
75
|
+
</MDXSection>
|
|
76
|
+
|
|
77
|
+
<MDXSection>
|
|
78
|
+
<MDXArticle>
|
|
79
|
+
|
|
80
|
+
## ✅ Upgrade Steps
|
|
81
|
+
|
|
82
|
+
### 1. Prerequisites
|
|
83
|
+
|
|
84
|
+
CDS 9 no longer bundles the v7 shim (`cds-web/v7`/`cds-mobile/v7`).
|
|
85
|
+
Incremental upgrade strategies, which this pattern enabled, are no longer recommended.
|
|
86
|
+
Starting with CDS 9, major releases will minimize breaking changes relateive to the prior version, making major upgrades possible to land in a single PR, even for large monorepos.
|
|
87
|
+
|
|
88
|
+
Before upgrading to v9:
|
|
89
|
+
|
|
90
|
+
1. Search your codebase for any remaining `cds-web/v7` / `cds-mobile/v7` imports.
|
|
91
|
+
2. Complete any partial migrations from the v7 shim to proper CDS 8 imports by following the [v8 Migration Guide](./v8-migration-guide).
|
|
92
|
+
3. Once all v7 imports are eliminated, you can upgrade to v9.
|
|
93
|
+
|
|
94
|
+
```tsx
|
|
95
|
+
// ❌ Before (still on v8 with incremental migration)
|
|
96
|
+
import { Button } from '@coinbase/cds-web/v7/buttons/Button';
|
|
97
|
+
|
|
98
|
+
// ✅ After (must complete before upgrading to v9)
|
|
99
|
+
import { Button } from '@coinbase/cds-web/buttons/Button';
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### 2. Update Packages
|
|
103
|
+
|
|
104
|
+
<StandalonePlatformSwitcher.Root>
|
|
105
|
+
<VStack>
|
|
106
|
+
<HStack alignItems="center" justifyContent="space-between" width="100%">
|
|
107
|
+
<Text font="title3">Updgrade CDS Packages</Text>
|
|
108
|
+
<StandalonePlatformSwitcher.Toggle accessibilityLabel="Select package platform" />
|
|
109
|
+
</HStack>
|
|
110
|
+
<Text font="body">Update the CDS packages your app uses to v9.</Text>
|
|
111
|
+
<StandalonePlatformSwitcher.Content platform="web">
|
|
112
|
+
<WebInstallCommands />
|
|
113
|
+
</StandalonePlatformSwitcher.Content>
|
|
114
|
+
<StandalonePlatformSwitcher.Content platform="mobile">
|
|
115
|
+
<MobileInstallCommands />
|
|
116
|
+
</StandalonePlatformSwitcher.Content>
|
|
117
|
+
</VStack>
|
|
118
|
+
</StandalonePlatformSwitcher.Root>
|
|
119
|
+
|
|
120
|
+
<StandalonePlatformSwitcher.Root>
|
|
121
|
+
<VStack>
|
|
122
|
+
<HStack alignItems="center" justifyContent="space-between" width="100%">
|
|
123
|
+
<Text font="title3">Update CDS Peer Dependencies</Text>
|
|
124
|
+
<StandalonePlatformSwitcher.Toggle accessibilityLabel="Select peer dependency platform" />
|
|
125
|
+
</HStack>
|
|
126
|
+
<StandalonePlatformSwitcher.Content platform="web">
|
|
127
|
+
<WebPeerDependencies />
|
|
128
|
+
</StandalonePlatformSwitcher.Content>
|
|
129
|
+
<StandalonePlatformSwitcher.Content platform="mobile">
|
|
130
|
+
<MobilePeerDependencies />
|
|
131
|
+
</StandalonePlatformSwitcher.Content>
|
|
132
|
+
</VStack>
|
|
133
|
+
</StandalonePlatformSwitcher.Root>
|
|
134
|
+
|
|
135
|
+
<br />
|
|
136
|
+
|
|
137
|
+
### 3. Run Automated Codemods
|
|
138
|
+
|
|
139
|
+
The new `@coinbase/cds-migrator` will help expedite your upgrade to CDS 9.
|
|
140
|
+
It encapsulates individual changes in **transforms**, and groups related transforms into versioned **presets**.
|
|
141
|
+
For upgrades from CDS 8 to CDS 9, use the `v8-to-v9` preset.
|
|
142
|
+
|
|
143
|
+
For detailed CLI documentation and individual transform/preset details, see the [package README](https://github.com/coinbase/cds/blob/cds-v9-master/packages/migrator/README.md).
|
|
144
|
+
|
|
145
|
+
:::tip Proactive Codemods
|
|
146
|
+
We will continually publish new transforms and presets to proactively address deprecations in preparation of the following major release.
|
|
147
|
+
:::
|
|
148
|
+
|
|
149
|
+
#### Running the codemods
|
|
150
|
+
|
|
151
|
+
```bash
|
|
152
|
+
# Preview all changes (recommended first step)
|
|
153
|
+
npx @coinbase/cds-migrator ./src -p v8-to-v9 --dry-run
|
|
154
|
+
|
|
155
|
+
# Review the generated migration.log
|
|
156
|
+
cat migration.log
|
|
157
|
+
|
|
158
|
+
# Apply the migration
|
|
159
|
+
npx @coinbase/cds-migrator ./src -p v8-to-v9
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
You can also run a single transform:
|
|
163
|
+
|
|
164
|
+
```bash
|
|
165
|
+
npx @coinbase/cds-migrator ./src -t button-variant-values --dry-run
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
The migrator tool records what it has already run in `.cds-migration-history.json` and leaves `// TODO [cds-migrator:<transform-name>]` comments in the source code for cases that may need manual review.
|
|
169
|
+
|
|
170
|
+
#### Manual upgrade effort
|
|
171
|
+
|
|
172
|
+
The CDS 9 codemods should address the vast majority of potential incompatibility issues, however there are a few specific edge cases that may require manual attention.
|
|
173
|
+
|
|
174
|
+
- Tightening some TypeScript types (`Carousel`, `Drawer`, `Tray`, `Modal`, `TableCell.end`, etc.)
|
|
175
|
+
- Updating custom Stepper progress UIs and `SlideButton` slot components to use Reanimated / `framer-motion` instead of `react-spring`
|
|
176
|
+
- See [Breaking Change Overview](#-breaking-change-overview) for more details
|
|
177
|
+
|
|
178
|
+
</MDXArticle>
|
|
179
|
+
</MDXSection>
|
|
180
|
+
|
|
181
|
+
<MDXSection>
|
|
182
|
+
<MDXArticle>
|
|
183
|
+
|
|
184
|
+
## 💥 Breaking Change Overview
|
|
185
|
+
|
|
186
|
+
### Hard-Coded Dimensions Removed
|
|
187
|
+
|
|
188
|
+
CDS 9 removes hard-coded fixed heights and widths from all components. Components are now driven by their content, your layout, or theme tokens. As a side effect, several constants and utilities that exposed those fixed pixel values are deprecated (see [New Deprecations](#new-deprecations)). Review any surfaces that depended on CDS components occupying fixed dimensions, since those layouts may need small visual adjustments after upgrading.
|
|
189
|
+
|
|
190
|
+
### Packages & Imports
|
|
191
|
+
|
|
192
|
+
- **v7 import paths dropped** — `@coinbase/cds-web/v7` and `@coinbase/cds-mobile/v7` are no longer bundled. Apps must finish their CDS 8 upgrade before jumping to CDS 9.
|
|
193
|
+
- **Visualization packages merged** — deep paths on `@coinbase/cds-(web|mobile)-visualization` may no longer resolve. Use the new `@coinbase/cds-(web|mobile)/visualizations/*` exports.
|
|
194
|
+
|
|
195
|
+
### Cutting react-spring references
|
|
196
|
+
|
|
197
|
+
CDS is migrating away from `react-spring`, which is poorly maintained and has been the source of recurring bugs.
|
|
198
|
+
The implementation detail leaked into the public API of two components — `Stepper` and `SlideButton`.
|
|
199
|
+
These APIs need to be adjusted before CDS can transition to the preferred animation libraries, `framer-motion` and `react-native-reanimated`.
|
|
200
|
+
|
|
201
|
+
#### Stepper <Tag colorScheme="blue">Web</Tag> <Tag colorScheme="green">Mobile</Tag>
|
|
202
|
+
|
|
203
|
+
If you supply a custom step / progress UI to `Stepper`, the `progress` prop is now a plain `number` between `0` and `1` instead of a `react-spring` value. For built-in progress animation, configure timing via the new `progressTimingConfig` / `defaultProgressTimingConfig` props. The legacy `progressSpringConfig` prop is ignored on this animation path.
|
|
204
|
+
|
|
205
|
+
```tsx
|
|
206
|
+
// ❌ Before (v8) — progress was a SpringValue<number>
|
|
207
|
+
const CustomProgress = ({ progress }: { progress: SpringValue<number> }) => (
|
|
208
|
+
<animated.div style={{ width: progress.to((p) => `${p * 100}%`) }} />
|
|
209
|
+
);
|
|
210
|
+
|
|
211
|
+
// ✅ After (v9) — progress is a number between 0 and 1
|
|
212
|
+
const CustomProgress = ({ progress }: { progress: number }) => (
|
|
213
|
+
<div style={{ width: `${progress * 100}%` }} />
|
|
214
|
+
);
|
|
215
|
+
|
|
216
|
+
// Built-in animation timing
|
|
217
|
+
<Stepper
|
|
218
|
+
progressTimingConfig={{ duration: 0.4, ease: 'easeInOut' }}
|
|
219
|
+
// progressSpringConfig is ignored in v9
|
|
220
|
+
/>;
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
#### SlideButton <Tag colorScheme="green">Mobile</Tag>
|
|
224
|
+
|
|
225
|
+
Custom `SlideButtonBackgroundComponent` and `SlideButtonHandleComponent` slots now receive `progress` as a Reanimated `SharedValue<number>` instead of a `react-spring` `SpringValue<number>`. Any custom slot that drove animation with spring helpers must switch to Reanimated.
|
|
226
|
+
|
|
227
|
+
```tsx
|
|
228
|
+
// ❌ Before (v8)
|
|
229
|
+
import { SpringValue } from '@react-spring/native';
|
|
230
|
+
const BackgroundComponent = ({ progress }: { progress: SpringValue<number> }) => {
|
|
231
|
+
// animated.View, react-spring helpers...
|
|
232
|
+
};
|
|
233
|
+
|
|
234
|
+
// ✅ After (v9)
|
|
235
|
+
import Animated, { useAnimatedStyle, type SharedValue } from 'react-native-reanimated';
|
|
236
|
+
|
|
237
|
+
const BackgroundComponent = ({ progress }: { progress: SharedValue<number> }) => {
|
|
238
|
+
const style = useAnimatedStyle(() => ({ opacity: progress.value }));
|
|
239
|
+
return <Animated.View style={style} />;
|
|
240
|
+
};
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
**Spring config:** `animationConfig` on `DefaultSlideButtonHandle` is deprecated. Use `slideButtonSpringConfig` together with Reanimated's `withSpring`.
|
|
244
|
+
|
|
245
|
+
**Layout:** `SlideButton` now applies default heights (`40` for compact, `56` for regular) and derives the handle's `minWidth` from `height`. If you previously omitted `height` and relied on the old interactable-height + spring-driven sizing, double-check the rendered layout — you may need to set `height` explicitly to preserve v8 behavior.
|
|
246
|
+
|
|
247
|
+
### TypeScript Type Changes
|
|
248
|
+
|
|
249
|
+
A handful of CDS types have been tightened to better reflect runtime behavior or to align with React 19's updated typedefs.
|
|
250
|
+
These changes are runtime-compatible but may surface as TypeScript errors after you upgrade.
|
|
251
|
+
|
|
252
|
+
:::tip Tip
|
|
253
|
+
In most cases, removing explicit type annotations and letting TypeScript infer the type from CDS is the simplest fix.
|
|
254
|
+
:::
|
|
255
|
+
|
|
256
|
+
#### React.FC type removed for render-children types <Tag colorScheme="blue">Web</Tag><Tag colorScheme="green">Mobile</Tag>
|
|
257
|
+
|
|
258
|
+
The following components' render functions are now typed as `(props) => ReactNode` instead of using the deprecated `React.FC` type:
|
|
259
|
+
|
|
260
|
+
- `CarouselItem`
|
|
261
|
+
- `Drawer`
|
|
262
|
+
- `Tray`
|
|
263
|
+
- `Modal`
|
|
264
|
+
|
|
265
|
+
#### `TableCell.end` and `SelectOptionGroupComponent.accessory` <Tag colorScheme="blue">Web</Tag>
|
|
266
|
+
|
|
267
|
+
Both components' props now require a stricter type: `React.ReactElement<CellAccessoryProps>`.
|
|
268
|
+
|
|
269
|
+
```tsx
|
|
270
|
+
// ❌ Before (v8) — was previously typed as ReactElement/ReactNode
|
|
271
|
+
<TableCell end={<div>123</div>} />;
|
|
272
|
+
|
|
273
|
+
// ✅ After (v9)
|
|
274
|
+
import { CellTextAccessory } from '@coinbase/cds-web/cells';
|
|
275
|
+
<TableCell end={<CellTextAccessory text="123" />} />;
|
|
276
|
+
```
|
|
277
|
+
|
|
278
|
+
#### Input `onFocus` / `onBlur` Event Types <Tag colorScheme="green">Mobile</Tag>
|
|
279
|
+
|
|
280
|
+
Certain mobile component APIs that accept focus/blur event handlers now use simpler typing
|
|
281
|
+
|
|
282
|
+
```tsx
|
|
283
|
+
// ❌ Before (v8)
|
|
284
|
+
import type { NativeSyntheticEvent, TextInputFocusEventData } from 'react-native';
|
|
285
|
+
const onFocus = (e: NativeSyntheticEvent<TextInputFocusEventData>) => {
|
|
286
|
+
/* ... */
|
|
287
|
+
};
|
|
288
|
+
|
|
289
|
+
// ✅ After (v9)
|
|
290
|
+
import type { FocusEvent } from 'react-native';
|
|
291
|
+
const onFocus = (e: FocusEvent) => {
|
|
292
|
+
/* ... */
|
|
293
|
+
};
|
|
294
|
+
```
|
|
295
|
+
|
|
296
|
+
### Removed APIs (Dropped Deprecations)
|
|
297
|
+
|
|
298
|
+
The following `@deprecated` APIs are **fully removed** in v9.
|
|
299
|
+
|
|
300
|
+
| Package | Dropped deprecations |
|
|
301
|
+
| ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
302
|
+
| <Tag colorScheme="gray">Common</Tag> | `emptyObject`, `StickyFooterProps` |
|
|
303
|
+
| <Tag colorScheme="blue">Web</Tag> | `AnnouncementCardProps`, `FeatureEntryCardProps`, `RadioGroupProps`, `CheckboxGroupProps`, `FeedCardProps`, `IconCounterButton.iconSize` |
|
|
304
|
+
| <Tag colorScheme="green">Mobile</Tag> | `AnnouncementCardProps`, `FeatureEntryCardProps`, `RadioGroupProps`, `CheckboxGroupProps`, `FeedCardProps`, `LinearGradient.isBelowChildren`, `IconCounterButton.iconSize` |
|
|
305
|
+
|
|
306
|
+
</MDXArticle>
|
|
307
|
+
</MDXSection>
|
|
308
|
+
|
|
309
|
+
<MDXSection>
|
|
310
|
+
<MDXArticle>
|
|
311
|
+
|
|
312
|
+
## ⚠️ New Deprecations
|
|
313
|
+
|
|
314
|
+
The following APIs are **still available in v9** but are scheduled for removal in CDS 10. Migrators and/or AI agents will be released following the v9 launch to help with each. You can also start migrating manually using the guidance below.
|
|
315
|
+
|
|
316
|
+
### Packages
|
|
317
|
+
|
|
318
|
+
| Package | Notes |
|
|
319
|
+
| ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
|
320
|
+
| **`@coinbase/cds-web-visualization`** | Use `@coinbase/cds-web/visualizations/{chart,sparkline}` instead. Remove the dependency once your imports are migrated. |
|
|
321
|
+
| **`@coinbase/cds-mobile-visualization`** | Use `@coinbase/cds-mobile/visualizations/{chart,sparkline}` instead. Remove the dependency once your imports are migrated. |
|
|
322
|
+
|
|
323
|
+
:::tip Codemod
|
|
324
|
+
The CDS migrator's `v8-to-v9` preset will update these packages' import paths for you.
|
|
325
|
+
:::
|
|
326
|
+
|
|
327
|
+
### Components
|
|
328
|
+
|
|
329
|
+
<DeprecationTable rows={componentDeprecations} />
|
|
330
|
+
|
|
331
|
+
### Hooks & Functions
|
|
332
|
+
|
|
333
|
+
<DeprecationTable rows={hookFunctionDeprecations} />
|
|
334
|
+
|
|
335
|
+
### Tokens & Constants
|
|
336
|
+
|
|
337
|
+
The following tokens were fixed pixel values that pin component sizing. With v9 removing hard-coded heights/widths, they are no longer published. Define your own values or rely on layout-driven sizing.
|
|
338
|
+
|
|
339
|
+
<DeprecationTable rows={tokenConstantDeprecations} />
|
|
340
|
+
|
|
341
|
+
### Types
|
|
342
|
+
|
|
343
|
+
<DeprecationTable rows={typeDeprecations} />
|
|
344
|
+
|
|
345
|
+
</MDXArticle>
|
|
346
|
+
</MDXSection>
|
|
347
|
+
|
|
348
|
+
</VStack>
|