@coinbase/cds-mcp-server 8.35.0 → 8.36.0

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 CHANGED
@@ -8,6 +8,16 @@ All notable changes to this project will be documented in this file.
8
8
 
9
9
  <!-- template-start -->
10
10
 
11
+ ## 8.36.0 (1/6/2026 PST)
12
+
13
+ #### 🚀 Updates
14
+
15
+ - Update MCP Serer setup script to follow latest Claude Code and Cursor guidelines.
16
+
17
+ ## 8.35.1 ((1/5/2026, 03:28 PM PST))
18
+
19
+ This is an artificial version bump with no new change.
20
+
11
21
  ## 8.35.0 ((1/5/2026, 10:03 AM PST))
12
22
 
13
23
  This is an artificial version bump with no new change.
@@ -1,13 +1,7 @@
1
- ---
2
- description:
3
- globs: *.tsx,*.jsx
4
- alwaysApply: false
5
- ---
6
- source: https://github.com/coinbase/cds/blob/master/packages/mcp-server/src/cds.mdc
7
-
8
1
  # CDS Component Priority Rules
9
2
 
10
3
  ## Component Usage Hierarchy
4
+
11
5
  - CDS is the primary design system for React and React Native in this project.
12
6
  - The JS package is `@coinbase/cds-web` for web React apps and `@coinbase/cds-mobile` for mobile React Native apps.
13
7
  - ALWAYS prioritize CDS components over ANY other UI components when a CDS equivalent exists. For React Native this includes React Native built-ins. For web this includes any HTML native elements.
@@ -15,11 +9,13 @@ source: https://github.com/coinbase/cds/blob/master/packages/mcp-server/src/cds.
15
9
  - ALWAYS use CDS components even if other local components or screens in the codebase are not currently using them - the goal is to standardize on CDS.
16
10
 
17
11
  ## Component Research Order
12
+
18
13
  1. FIRST check if there's a CDS component that satisfies the requirement - this is MANDATORY.
19
14
  2. ONLY if no suitable CDS component exists, then consider native React Native components.
20
15
  3. ONLY if neither CDS nor native components work, suggest custom implementations.
21
16
 
22
17
  ## Documentation Location
18
+
23
19
  - ALWAYS use the cds mcp server's list-cds-routes mcp tool to list all CDS routes before trying to use a component.
24
20
  - ALWAYS inspect the documentation for a component with the get-cds-route mcp tool before using it to understand how to import and how to use it.
25
21
  - ALWAYS check examples in the documentation before implementing.
@@ -27,16 +23,19 @@ source: https://github.com/coinbase/cds/blob/master/packages/mcp-server/src/cds.
27
23
  - CAREFULLY review the component APIs, props, and usage examples in the documentation.
28
24
 
29
25
  ## Implementation Guidelines
26
+
30
27
  - MAINTAIN consistent styling and behavior with existing CDS implementations in the codebase.
31
28
  - FOLLOW CDS-specific theming and styling patterns.
32
29
  - RESPECT CDS component hierarchy and composition patterns.
33
30
  - DO NOT mix CDS and non-CDS component styling approaches unless absolutely necessary.
34
31
 
35
32
  ## When Suggesting Code
33
+
36
34
  - ALWAYS import from @coinbase/cds-mobile for mobile or @coinbase/cds-web for web explicitly.
37
35
  - INCLUDE complete imports in your code examples.
38
36
  - DEMONSTRATE proper usage of CDS theming and styling.
39
37
  - SHOW prop usage according to CDS documentation.
40
38
 
41
39
  ## Lint Errors
40
+
42
41
  - If there's a lint error, do not discard other components that don't have lint errors.
package/esm/setup.js CHANGED
@@ -68,21 +68,61 @@ const findRepoRoot = startPath => {
68
68
  throw new Error('Could not find repo root');
69
69
  }
70
70
  };
71
- const installRules = agentRoot => {
71
+ const CURSOR_MDC_HEADER = "---\ndescription: Apply when working with React components, UI implementations, or Coinbase Design System usage. This rule ensures proper use of CDS components.\n---\n";
72
+ const installCursorRules = agentRoot => {
72
73
  try {
73
- const sourceFile = path.join(__dirname, 'cds.mdc');
74
+ const sourceFile = path.join(__dirname, 'cds.md');
74
75
  const outputDirectory = path.join(agentRoot, 'rules');
75
76
  const outputFile = path.join(outputDirectory, 'cds.mdc');
76
77
  if (!fs.existsSync(outputDirectory)) fs.mkdirSync(outputDirectory, {
77
78
  recursive: true
78
79
  });
80
+
81
+ // Read the plain markdown source and prepend the Cursor MDC header
82
+ const sourceContent = fs.readFileSync(sourceFile, 'utf8');
83
+ const mdcContent = CURSOR_MDC_HEADER + sourceContent;
84
+ fs.writeFileSync(outputFile, mdcContent);
85
+ console.log("\u2705 Copied CDS rules to ".concat(outputFile));
86
+ } catch (error) {
87
+ console.error('❌ Failed to copy CDS rules:', error instanceof Error ? error.message : String(error));
88
+ }
89
+ };
90
+ const installClaudeRules = (repoRoot, agentRoot) => {
91
+ try {
92
+ const sourceFile = path.join(__dirname, 'cds.md');
93
+ const outputDirectory = path.join(agentRoot, 'rules');
94
+ const outputFile = path.join(outputDirectory, 'cds.md');
95
+ if (!fs.existsSync(outputDirectory)) fs.mkdirSync(outputDirectory, {
96
+ recursive: true
97
+ });
98
+
99
+ // Simply copy the plain markdown file for Claude Code
79
100
  fs.cpSync(sourceFile, outputFile);
80
101
  console.log("\u2705 Copied CDS rules to ".concat(outputFile));
102
+
103
+ // Update or create CLAUDE.md with reference to the rules file
104
+ const claudeMdPath = path.join(repoRoot, 'CLAUDE.md');
105
+ const claudeRulesReference = '@.claude/rules/cds.md';
106
+ if (fs.existsSync(claudeMdPath)) {
107
+ const claudeMdContent = fs.readFileSync(claudeMdPath, 'utf8');
108
+ if (!claudeMdContent.includes(claudeRulesReference)) {
109
+ // Add the reference at the beginning of the file
110
+ const updatedContent = "".concat(claudeRulesReference, "\n\n").concat(claudeMdContent);
111
+ fs.writeFileSync(claudeMdPath, updatedContent);
112
+ console.log("\u2705 Added CDS rules reference to ".concat(claudeMdPath));
113
+ } else {
114
+ console.log("\u2705 CDS rules reference already exists in ".concat(claudeMdPath));
115
+ }
116
+ } else {
117
+ // Create CLAUDE.md with the reference
118
+ fs.writeFileSync(claudeMdPath, "".concat(claudeRulesReference, "\n"));
119
+ console.log("\u2705 Created ".concat(claudeMdPath, " with CDS rules reference"));
120
+ }
81
121
  } catch (error) {
82
122
  console.error('❌ Failed to copy CDS rules:', error instanceof Error ? error.message : String(error));
83
123
  }
84
124
  };
85
- const installMcpServer = (repoRoot, cursorRoot) => {
125
+ const installCursorMcpServer = (repoRoot, cursorRoot) => {
86
126
  const mcpServerConfigPath = path.join(cursorRoot, 'mcp.json');
87
127
  let newMcpServerConfig = {
88
128
  mcpServers: {}
@@ -119,6 +159,34 @@ const installMcpServer = (repoRoot, cursorRoot) => {
119
159
  fs.writeFileSync(mcpServerConfigPath, JSON.stringify(newMcpServerConfig, null, 2));
120
160
  console.log("\u2705 Updated MCP server config in ".concat(mcpServerConfigPath));
121
161
  };
162
+ const installClaudeMcpServer = repoRoot => {
163
+ const mcpServerConfigPath = path.join(repoRoot, '.mcp.json');
164
+ let newMcpServerConfig = {
165
+ mcpServers: {}
166
+ };
167
+
168
+ // Claude Code doesn't need --prefix args
169
+ const mcpServerArgs = ['-y', '@coinbase/cds-mcp-server'];
170
+ if (args.noTelemetry) mcpServerArgs.unshift('DISABLE_CDS_MCP_TELEMETRY=1');
171
+ const cdsMcpServerConfig = {
172
+ cds: {
173
+ command: 'npx',
174
+ args: mcpServerArgs
175
+ }
176
+ };
177
+ try {
178
+ const currentMcpServerConfig = JSON.parse(fs.readFileSync(mcpServerConfigPath, 'utf8'));
179
+ newMcpServerConfig = _objectSpread(_objectSpread({}, currentMcpServerConfig), {}, {
180
+ mcpServers: _objectSpread(_objectSpread({}, currentMcpServerConfig.mcpServers), cdsMcpServerConfig)
181
+ });
182
+ } catch (_unused3) {
183
+ newMcpServerConfig = {
184
+ mcpServers: cdsMcpServerConfig
185
+ };
186
+ }
187
+ fs.writeFileSync(mcpServerConfigPath, JSON.stringify(newMcpServerConfig, null, 2));
188
+ console.log("\u2705 Updated MCP server config in ".concat(mcpServerConfigPath));
189
+ };
122
190
  for (const agentValue of selectedAgents) {
123
191
  const agent = agentOptions.find(agent => agent.value === agentValue);
124
192
  if (!agent) {
@@ -130,6 +198,11 @@ for (const agentValue of selectedAgents) {
130
198
  console.log('You can opt out by running setup with the --no-telemetry flag.');
131
199
  const repoRoot = findRepoRoot(process.cwd());
132
200
  const agentRoot = path.join(repoRoot, agent.directory);
133
- installRules(agentRoot);
134
- installMcpServer(repoRoot, agentRoot);
201
+ if (agent.value === 'cursor') {
202
+ installCursorRules(agentRoot);
203
+ installCursorMcpServer(repoRoot, agentRoot);
204
+ } else if (agent.value === 'claude') {
205
+ installClaudeRules(repoRoot, agentRoot);
206
+ installClaudeMcpServer(repoRoot);
207
+ }
135
208
  }
@@ -10,7 +10,7 @@ import { ProgressBar } from '@coinbase/cds-mobile/visualizations/ProgressBar'
10
10
 
11
11
  ## Examples
12
12
 
13
- ### Default
13
+ #### Default
14
14
 
15
15
  ```tsx
16
16
  <VStack gap={2}>
@@ -20,7 +20,7 @@ import { ProgressBar } from '@coinbase/cds-mobile/visualizations/ProgressBar'
20
20
  </VStack>
21
21
  ```
22
22
 
23
- ### Weights
23
+ #### Weights
24
24
 
25
25
  ```tsx
26
26
  <VStack gap={2}>
@@ -31,7 +31,7 @@ import { ProgressBar } from '@coinbase/cds-mobile/visualizations/ProgressBar'
31
31
  </VStack>
32
32
  ```
33
33
 
34
- ### Disabled
34
+ #### Disabled
35
35
 
36
36
  ```tsx
37
37
  <VStack gap={2}>
@@ -41,7 +41,7 @@ import { ProgressBar } from '@coinbase/cds-mobile/visualizations/ProgressBar'
41
41
  </VStack>
42
42
  ```
43
43
 
44
- ### Colors
44
+ #### Colors
45
45
 
46
46
  ```tsx
47
47
  <VStack gap={2}>
@@ -54,11 +54,11 @@ import { ProgressBar } from '@coinbase/cds-mobile/visualizations/ProgressBar'
54
54
  </VStack>
55
55
  ```
56
56
 
57
- ### Custom Styles
57
+ #### Custom Styles
58
58
 
59
59
  You can customize the appearance of the progress bar using the `styles` prop. The `root` style controls the container, and `progress` controls the fill bar.
60
60
 
61
- ```tsx live
61
+ ```tsx
62
62
  <ProgressContainerWithButtons>
63
63
  {({ calculateProgress }) => (
64
64
  <VStack gap={2}>
@@ -80,7 +80,21 @@ You can customize the appearance of the progress bar using the `styles` prop. Th
80
80
  </ProgressContainerWithButtons>
81
81
  ```
82
82
 
83
- ### Animation Callbacks
83
+ ### Animation
84
+
85
+ By default, ProgressBar animates progress changes. Use `disableAnimateOnMount` to skip the initial animation while still animating subsequent changes.
86
+
87
+ ```tsx
88
+ <VStack gap={2}>
89
+ <Text variant="label2">Normal animation</Text>
90
+ <ProgressBar progress={0.5} />
91
+
92
+ <Text variant="label2">Disable animation on mount</Text>
93
+ <ProgressBar disableAnimateOnMount progress={0.5} />
94
+ </VStack>
95
+ ```
96
+
97
+ #### Callbacks
84
98
 
85
99
  You can use the `onAnimationStart` and `onAnimationEnd` callbacks to track the progress of the animation.
86
100
 
@@ -102,7 +116,7 @@ function Example() {
102
116
  <ProgressBar
103
117
  onAnimationEnd={handleAnimationEnd}
104
118
  onAnimationStart={handleAnimationStart}
105
- progress={calculateProgress(0.2)}
119
+ progress={0.2}
106
120
  />
107
121
  </VStack>
108
122
  );
@@ -116,7 +130,7 @@ function Example() {
116
130
  | `progress` | `number` | Yes | `-` | Number between 0-1 representing the progress percentage |
117
131
  | `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` | No | `primary` | Custom progress color. |
118
132
  | `disableAnimateOnMount` | `boolean` | No | `false` | Disable animation on component mount |
119
- | `disabled` | `boolean` | No | `false` | Toggle used to show a disabled progress visualization |
133
+ | `disabled` | `boolean` | No | `-` | Toggle used to show a disabled progress visualization |
120
134
  | `key` | `Key \| null` | No | `-` | - |
121
135
  | `onAnimationEnd` | `(() => void)` | No | `-` | Callback fired when the progress animation ends. |
122
136
  | `onAnimationStart` | `(() => void)` | No | `-` | Callback fired when the progress animation starts. |
@@ -12,7 +12,7 @@ import { ProgressBarWithFixedLabels } from '@coinbase/cds-mobile/visualizations/
12
12
 
13
13
  ### Label Below
14
14
 
15
- ```jsx live
15
+ ```jsx
16
16
  <VStack gap={2}>
17
17
  <ProgressBarWithFixedLabels startLabel={0} endLabel={20} labelPlacement="below">
18
18
  <ProgressBar progress={0.2} />
@@ -25,7 +25,7 @@ import { ProgressBarWithFixedLabels } from '@coinbase/cds-mobile/visualizations/
25
25
 
26
26
  ### Label Beside
27
27
 
28
- ```jsx live
28
+ ```jsx
29
29
  <VStack gap={2}>
30
30
  <ProgressBarWithFixedLabels startLabel={0} endLabel={20} labelPlacement="beside">
31
31
  <ProgressBar progress={0.2} />
@@ -38,7 +38,7 @@ import { ProgressBarWithFixedLabels } from '@coinbase/cds-mobile/visualizations/
38
38
 
39
39
  ### Disabled
40
40
 
41
- ```jsx live
41
+ ```jsx
42
42
  <VStack gap={2}>
43
43
  <ProgressBarWithFixedLabels startLabel={0} endLabel={20} disabled labelPlacement="beside">
44
44
  <ProgressBar disabled progress={0.2} />
@@ -51,7 +51,7 @@ import { ProgressBarWithFixedLabels } from '@coinbase/cds-mobile/visualizations/
51
51
 
52
52
  ### Custom Labels
53
53
 
54
- ```jsx live
54
+ ```jsx
55
55
  function Example() {
56
56
  const renderStartLabelNumStr = useCallback((num) => {
57
57
  return `$${num.toLocaleString()}`;
@@ -119,7 +119,7 @@ function Example() {
119
119
 
120
120
  You can customize the appearance of the progress bar and labels using the `styles` prop.
121
121
 
122
- ```tsx live
122
+ ```tsx
123
123
  <ProgressContainerWithButtons>
124
124
  {({ calculateProgress }) => (
125
125
  <VStack gap={2}>
@@ -145,11 +145,66 @@ You can customize the appearance of the progress bar and labels using the `style
145
145
  </ProgressContainerWithButtons>
146
146
  ```
147
147
 
148
+ ### Animation
149
+
150
+ By default, ProgressBar animates progress changes. Use `disableAnimateOnMount` to skip the initial animation while still animating subsequent changes.
151
+
152
+ ```tsx
153
+ <VStack gap={2}>
154
+ <Text variant="label2">Normal animation</Text>
155
+ <ProgressBarWithFixedLabels startLabel={0} endLabel={50} labelPlacement="above">
156
+ <ProgressBar progress={0.5} />
157
+ </ProgressBarWithFixedLabels>
158
+
159
+ <Text variant="label2">Disable animation on mount</Text>
160
+ <ProgressBarWithFixedLabels
161
+ disableAnimateOnMount
162
+ startLabel={0}
163
+ endLabel={50}
164
+ labelPlacement="above"
165
+ >
166
+ <ProgressBar disableAnimateOnMount progress={0.5} />
167
+ </ProgressBarWithFixedLabels>
168
+ </VStack>
169
+ ```
170
+
171
+ #### Callbacks
172
+
173
+ You can use the `onAnimationStart` and `onAnimationEnd` callbacks to track the progress of the animation.
174
+
175
+ ```jsx
176
+ function Example() {
177
+ const [animationStatus, setAnimationStatus] = React.useState('Ready');
178
+
179
+ const handleAnimationStart = useCallback(() => {
180
+ setAnimationStatus('Animating...');
181
+ }, []);
182
+
183
+ const handleAnimationEnd = useCallback(() => {
184
+ setAnimationStatus('Animation Ended');
185
+ }, []);
186
+
187
+ return (
188
+ <VStack gap={2}>
189
+ <Text>Animation Status: {animationStatus}</Text>
190
+ <ProgressBarWithFixedLabels startLabel={0} endLabel={20} labelPlacement="above">
191
+ <ProgressBar
192
+ onAnimationEnd={handleAnimationEnd}
193
+ onAnimationStart={handleAnimationStart}
194
+ progress={0.2}
195
+ />
196
+ </ProgressBarWithFixedLabels>
197
+ </VStack>
198
+ );
199
+ }
200
+ ```
201
+
148
202
  ## Props
149
203
 
150
204
  | Prop | Type | Required | Default | Description |
151
205
  | --- | --- | --- | --- | --- |
152
- | `disabled` | `boolean` | No | `false` | Toggle used to show a disabled progress visualization |
206
+ | `disableAnimateOnMount` | `boolean` | No | `false` | Disable animation on component mount |
207
+ | `disabled` | `boolean` | No | `-` | Toggle used to show a disabled progress visualization |
153
208
  | `endLabel` | `number \| { value: number; render: (num: number, disabled?: boolean \| undefined) => ReactNode; }` | No | `-` | Label that is pinned to the end of the container. If a number is used then it will format it as a percentage. |
154
209
  | `labelPlacement` | `above \| below \| beside` | No | `beside` | Position of label relative to the bar |
155
210
  | `startLabel` | `number \| { value: number; render: (num: number, disabled?: boolean \| undefined) => ReactNode; }` | No | `-` | Label that is pinned to the start of the container. If a number is used then it will format it as a percentage. |
@@ -12,7 +12,7 @@ import { ProgressBarWithFloatLabel } from '@coinbase/cds-mobile/visualizations/P
12
12
 
13
13
  ### Label Above
14
14
 
15
- ```jsx live
15
+ ```jsx
16
16
  <VStack gap={2}>
17
17
  <ProgressBarWithFloatLabel label={0} progress={0} labelPlacement="above">
18
18
  <ProgressBar progress={0} />
@@ -25,7 +25,7 @@ import { ProgressBarWithFloatLabel } from '@coinbase/cds-mobile/visualizations/P
25
25
 
26
26
  ### Label Below
27
27
 
28
- ```jsx live
28
+ ```jsx
29
29
  <VStack gap={2}>
30
30
  <ProgressBarWithFloatLabel label={0} progress={0} labelPlacement="below">
31
31
  <ProgressBar progress={0} />
@@ -38,7 +38,7 @@ import { ProgressBarWithFloatLabel } from '@coinbase/cds-mobile/visualizations/P
38
38
 
39
39
  ### Disabled
40
40
 
41
- ```jsx live
41
+ ```jsx
42
42
  <VStack gap={2}>
43
43
  <ProgressBarWithFloatLabel label={70} progress={0.7} disabled>
44
44
  <ProgressBar progress={0.7} disabled />
@@ -48,7 +48,7 @@ import { ProgressBarWithFloatLabel } from '@coinbase/cds-mobile/visualizations/P
48
48
 
49
49
  ### Custom Labels
50
50
 
51
- ```jsx live
51
+ ```jsx
52
52
  function Example() {
53
53
  const renderLabelNumStr = useCallback((num) => {
54
54
  return `$${num.toLocaleString()}`;
@@ -103,7 +103,7 @@ function Example() {
103
103
 
104
104
  You can customize the appearance of the progress bar and float label using the `styles` prop.
105
105
 
106
- ```tsx live
106
+ ```tsx
107
107
  <ProgressContainerWithButtons>
108
108
  {({ calculateProgress }) => (
109
109
  <VStack gap={2}>
@@ -122,13 +122,63 @@ You can customize the appearance of the progress bar and float label using the `
122
122
  </ProgressContainerWithButtons>
123
123
  ```
124
124
 
125
+ ### Animation
126
+
127
+ By default, ProgressBar animates progress changes. Use `disableAnimateOnMount` to skip the initial animation while still animating subsequent changes.
128
+
129
+ ```tsx
130
+ <VStack gap={2}>
131
+ <Text variant="label2">Normal animation</Text>
132
+ <ProgressBarWithFloatLabel label={50} progress={0.5} labelPlacement="above">
133
+ <ProgressBar progress={0.5} />
134
+ </ProgressBarWithFloatLabel>
135
+
136
+ <Text variant="label2">Disable animation on mount</Text>
137
+ <ProgressBarWithFloatLabel disableAnimateOnMount label={50} progress={0.5} labelPlacement="above">
138
+ <ProgressBar disableAnimateOnMount progress={0.5} />
139
+ </ProgressBarWithFloatLabel>
140
+ </VStack>
141
+ ```
142
+
143
+ #### Callbacks
144
+
145
+ You can use the `onAnimationStart` and `onAnimationEnd` callbacks to track the progress of the animation.
146
+
147
+ ```jsx
148
+ function Example() {
149
+ const [animationStatus, setAnimationStatus] = React.useState('Ready');
150
+
151
+ const handleAnimationStart = useCallback(() => {
152
+ setAnimationStatus('Animating...');
153
+ }, []);
154
+
155
+ const handleAnimationEnd = useCallback(() => {
156
+ setAnimationStatus('Animation Ended');
157
+ }, []);
158
+
159
+ return (
160
+ <VStack gap={2}>
161
+ <Text>Animation Status: {animationStatus}</Text>
162
+ <ProgressBarWithFloatLabel label={20} progress={0.2} labelPlacement="above">
163
+ <ProgressBar
164
+ onAnimationEnd={handleAnimationEnd}
165
+ onAnimationStart={handleAnimationStart}
166
+ progress={0.2}
167
+ />
168
+ </ProgressBarWithFloatLabel>
169
+ </VStack>
170
+ );
171
+ }
172
+ ```
173
+
125
174
  ## Props
126
175
 
127
176
  | Prop | Type | Required | Default | Description |
128
177
  | --- | --- | --- | --- | --- |
129
178
  | `label` | `number \| { value: number; render: (num: number, disabled?: boolean \| undefined) => ReactNode; }` | Yes | `-` | Label that is floated at the end of the filled in bar. If a number is used then it will format it as a percentage. |
130
179
  | `progress` | `number` | Yes | `-` | Number between 0-1 representing the progress percentage |
131
- | `disabled` | `boolean` | No | `false` | Toggle used to show a disabled progress visualization |
180
+ | `disableAnimateOnMount` | `boolean` | No | `false` | Disable animation on component mount |
181
+ | `disabled` | `boolean` | No | `-` | Toggle used to show a disabled progress visualization |
132
182
  | `labelPlacement` | `above \| below` | No | `above` | Position of label relative to the bar |
133
183
  | `style` | `null \| false \| ViewStyle \| RegisteredStyle<ViewStyle> \| RecursiveArray<ViewStyle \| Falsy \| RegisteredStyle<ViewStyle>>` | No | `-` | Custom styles for the progress bar with float label root. |
134
184
  | `styles` | `{ root?: StyleProp<ViewStyle>; labelContainer?: StyleProp<ViewStyle>; label?: StyleProp<TextStyle>; }` | No | `-` | Custom styles for the progress bar with float label. |
@@ -186,7 +186,25 @@ The progress circle can be customized with styles.
186
186
  </HStack>
187
187
  ```
188
188
 
189
- #### Animation Callbacks
189
+ ### Animation
190
+
191
+ By default, ProgressCircle animates progress changes. Use `disableAnimateOnMount` to skip the initial animation while still animating subsequent changes.
192
+
193
+ ```tsx
194
+ <HStack gap={2}>
195
+ <VStack gap={1} alignItems="center">
196
+ <Text variant="label2">Normal animation</Text>
197
+ <ProgressCircle progress={0.5} size={100} />
198
+ </VStack>
199
+
200
+ <VStack gap={1} alignItems="center">
201
+ <Text variant="label2">Disable animation on mount</Text>
202
+ <ProgressCircle disableAnimateOnMount progress={0.5} size={100} />
203
+ </VStack>
204
+ </HStack>
205
+ ```
206
+
207
+ #### Callbacks
190
208
 
191
209
  You can use the `onAnimationStart` and `onAnimationEnd` callbacks to track the progress of the animation.
192
210
 
@@ -208,7 +226,7 @@ function Example() {
208
226
  <ProgressCircle
209
227
  onAnimationEnd={handleAnimationEnd}
210
228
  onAnimationStart={handleAnimationStart}
211
- progress={calculateProgress(0.2)}
229
+ progress={0.2}
212
230
  size={100}
213
231
  />
214
232
  </VStack>
@@ -224,7 +242,7 @@ function Example() {
224
242
  | `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` | No | `primary` | Custom progress color. |
225
243
  | `contentNode` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | Optional component to override the default content rendered inside the circle. |
226
244
  | `disableAnimateOnMount` | `boolean` | No | `false` | Disable animation on component mount |
227
- | `disabled` | `boolean` | No | `false` | Toggle used to show a disabled progress visualization |
245
+ | `disabled` | `boolean` | No | `-` | Toggle used to show a disabled progress visualization |
228
246
  | `hideContent` | `boolean` | No | `-` | Toggle used to hide the content node rendered inside the circle. |
229
247
  | `hideText` | `boolean` | No | `-` | - |
230
248
  | `key` | `Key \| null` | No | `-` | - |
@@ -383,7 +383,7 @@ function CustomBeaconLabel() {
383
383
 
384
384
  Using `labelElevated` will elevate the Scrubber's reference line label with a shadow.
385
385
 
386
- ```jsx live
386
+ ```jsx
387
387
  <LineChart
388
388
  enableScrubbing
389
389
  height={200}
@@ -725,8 +725,8 @@ function XAxisGradient() {
725
725
  | `userSelect` | `ResponsiveProp<text \| none \| all \| auto>` | No | `-` | - |
726
726
  | `visibility` | `ResponsiveProp<hidden \| visible>` | No | `-` | - |
727
727
  | `width` | `ResponsiveProp<Width<string \| number>>` | No | `-` | - |
728
- | `xAxis` | `(Partial<AxisConfigProps> & AxisBaseProps & { className?: string; classNames?: { root?: string \| undefined; label?: string \| undefined; tickLabel?: string \| undefined; gridLine?: string \| undefined; line?: string \| undefined; tickMark?: string \| undefined; } \| undefined; style?: CSSProperties \| undefined; styles?: { root?: CSSProperties \| undefined; label?: CSSProperties \| undefined; tickLabel?: CSSProperties \| undefined; gridLine?: CSSProperties \| undefined; line?: CSSProperties \| undefined; tickMark?: CSSProperties \| undefined; } \| undefined; GridLineComponent?: LineComponent \| undefined; LineComponent?: LineComponent \| undefined; TickMarkLineComponent?: LineComponent \| undefined; tickLabelFormatter?: ((value: number) => ChartTextChildren) \| undefined; TickLabelComponent?: AxisTickLabelComponent \| undefined; } & { position?: top \| bottom \| undefined; height?: number \| undefined; }) \| undefined` | No | `-` | Configuration for x-axis. Accepts axis config and axis props. To show the axis, set showXAxis to true. |
729
- | `yAxis` | `(Partial<AxisConfigProps> & AxisBaseProps & { className?: string; classNames?: { root?: string \| undefined; label?: string \| undefined; tickLabel?: string \| undefined; gridLine?: string \| undefined; line?: string \| undefined; tickMark?: string \| undefined; } \| undefined; style?: CSSProperties \| undefined; styles?: { root?: CSSProperties \| undefined; label?: CSSProperties \| undefined; tickLabel?: CSSProperties \| undefined; gridLine?: CSSProperties \| undefined; line?: CSSProperties \| undefined; tickMark?: CSSProperties \| undefined; } \| undefined; GridLineComponent?: LineComponent \| undefined; LineComponent?: LineComponent \| undefined; TickMarkLineComponent?: LineComponent \| undefined; tickLabelFormatter?: ((value: number) => ChartTextChildren) \| undefined; TickLabelComponent?: AxisTickLabelComponent \| undefined; } & { axisId?: string \| undefined; position?: left \| right \| undefined; width?: number \| undefined; }) \| undefined` | No | `-` | Configuration for y-axis. Accepts axis config and axis props. To show the axis, set showYAxis to true. |
728
+ | `xAxis` | `(Partial<AxisConfigProps> & SharedProps & { label?: string; labelGap?: number \| undefined; minTickLabelGap?: number \| undefined; requestedTickCount?: number \| undefined; showGrid?: boolean \| undefined; showLine?: boolean \| undefined; showTickMarks?: boolean \| undefined; tickMarkSize?: number \| undefined; ticks?: number[] \| ((value: number) => boolean) \| undefined; tickMarkLabelGap?: number \| undefined; tickInterval?: number \| undefined; tickMinStep?: number \| undefined; tickMaxStep?: number \| undefined; } & { className?: string \| undefined; classNames?: { root?: string \| undefined; label?: string \| undefined; tickLabel?: string \| undefined; gridLine?: string \| undefined; line?: string \| undefined; tickMark?: string \| undefined; } \| undefined; style?: CSSProperties \| undefined; styles?: { root?: CSSProperties \| undefined; label?: CSSProperties \| undefined; tickLabel?: CSSProperties \| undefined; gridLine?: CSSProperties \| undefined; line?: CSSProperties \| undefined; tickMark?: CSSProperties \| undefined; } \| undefined; GridLineComponent?: LineComponent \| undefined; LineComponent?: LineComponent \| undefined; TickMarkLineComponent?: LineComponent \| undefined; tickLabelFormatter?: ((value: number) => ChartTextChildren) \| undefined; TickLabelComponent?: AxisTickLabelComponent \| undefined; } & { position?: top \| bottom \| undefined; height?: number \| undefined; }) \| undefined` | No | `-` | Configuration for x-axis. Accepts axis config and axis props. To show the axis, set showXAxis to true. |
729
+ | `yAxis` | `(Partial<AxisConfigProps> & SharedProps & { label?: string; labelGap?: number \| undefined; minTickLabelGap?: number \| undefined; requestedTickCount?: number \| undefined; showGrid?: boolean \| undefined; showLine?: boolean \| undefined; showTickMarks?: boolean \| undefined; tickMarkSize?: number \| undefined; ticks?: number[] \| ((value: number) => boolean) \| undefined; tickMarkLabelGap?: number \| undefined; tickInterval?: number \| undefined; tickMinStep?: number \| undefined; tickMaxStep?: number \| undefined; } & { className?: string \| undefined; classNames?: { root?: string \| undefined; label?: string \| undefined; tickLabel?: string \| undefined; gridLine?: string \| undefined; line?: string \| undefined; tickMark?: string \| undefined; } \| undefined; style?: CSSProperties \| undefined; styles?: { root?: CSSProperties \| undefined; label?: CSSProperties \| undefined; tickLabel?: CSSProperties \| undefined; gridLine?: CSSProperties \| undefined; line?: CSSProperties \| undefined; tickMark?: CSSProperties \| undefined; } \| undefined; GridLineComponent?: LineComponent \| undefined; LineComponent?: LineComponent \| undefined; TickMarkLineComponent?: LineComponent \| undefined; tickLabelFormatter?: ((value: number) => ChartTextChildren) \| undefined; TickLabelComponent?: AxisTickLabelComponent \| undefined; } & { axisId?: string \| undefined; position?: left \| right \| undefined; width?: number \| undefined; }) \| undefined` | No | `-` | Configuration for y-axis. Accepts axis config and axis props. To show the axis, set showYAxis to true. |
730
730
  | `zIndex` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
731
731
 
732
732
 
@@ -1129,8 +1129,8 @@ function UpdatingChartValues() {
1129
1129
  | `userSelect` | `ResponsiveProp<text \| none \| all \| auto>` | No | `-` | - |
1130
1130
  | `visibility` | `ResponsiveProp<hidden \| visible>` | No | `-` | - |
1131
1131
  | `width` | `ResponsiveProp<Width<string \| number>>` | No | `-` | - |
1132
- | `xAxis` | `(Partial<AxisConfigProps> & AxisBaseProps & { className?: string; classNames?: { root?: string \| undefined; label?: string \| undefined; tickLabel?: string \| undefined; gridLine?: string \| undefined; line?: string \| undefined; tickMark?: string \| undefined; } \| undefined; style?: CSSProperties \| undefined; styles?: { root?: CSSProperties \| undefined; label?: CSSProperties \| undefined; tickLabel?: CSSProperties \| undefined; gridLine?: CSSProperties \| undefined; line?: CSSProperties \| undefined; tickMark?: CSSProperties \| undefined; } \| undefined; GridLineComponent?: LineComponent \| undefined; LineComponent?: LineComponent \| undefined; TickMarkLineComponent?: LineComponent \| undefined; tickLabelFormatter?: ((value: number) => ChartTextChildren) \| undefined; TickLabelComponent?: AxisTickLabelComponent \| undefined; } & { position?: top \| bottom \| undefined; height?: number \| undefined; }) \| undefined` | No | `-` | Configuration for x-axis. Accepts axis config and axis props. To show the axis, set showXAxis to true. |
1133
- | `yAxis` | `(Partial<AxisConfigProps> & AxisBaseProps & { className?: string; classNames?: { root?: string \| undefined; label?: string \| undefined; tickLabel?: string \| undefined; gridLine?: string \| undefined; line?: string \| undefined; tickMark?: string \| undefined; } \| undefined; style?: CSSProperties \| undefined; styles?: { root?: CSSProperties \| undefined; label?: CSSProperties \| undefined; tickLabel?: CSSProperties \| undefined; gridLine?: CSSProperties \| undefined; line?: CSSProperties \| undefined; tickMark?: CSSProperties \| undefined; } \| undefined; GridLineComponent?: LineComponent \| undefined; LineComponent?: LineComponent \| undefined; TickMarkLineComponent?: LineComponent \| undefined; tickLabelFormatter?: ((value: number) => ChartTextChildren) \| undefined; TickLabelComponent?: AxisTickLabelComponent \| undefined; } & { axisId?: string \| undefined; position?: left \| right \| undefined; width?: number \| undefined; }) \| undefined` | No | `-` | Configuration for y-axis. Accepts axis config and axis props. To show the axis, set showYAxis to true. |
1132
+ | `xAxis` | `(Partial<AxisConfigProps> & SharedProps & { label?: string; labelGap?: number \| undefined; minTickLabelGap?: number \| undefined; requestedTickCount?: number \| undefined; showGrid?: boolean \| undefined; showLine?: boolean \| undefined; showTickMarks?: boolean \| undefined; tickMarkSize?: number \| undefined; ticks?: number[] \| ((value: number) => boolean) \| undefined; tickMarkLabelGap?: number \| undefined; tickInterval?: number \| undefined; tickMinStep?: number \| undefined; tickMaxStep?: number \| undefined; } & { className?: string \| undefined; classNames?: { root?: string \| undefined; label?: string \| undefined; tickLabel?: string \| undefined; gridLine?: string \| undefined; line?: string \| undefined; tickMark?: string \| undefined; } \| undefined; style?: CSSProperties \| undefined; styles?: { root?: CSSProperties \| undefined; label?: CSSProperties \| undefined; tickLabel?: CSSProperties \| undefined; gridLine?: CSSProperties \| undefined; line?: CSSProperties \| undefined; tickMark?: CSSProperties \| undefined; } \| undefined; GridLineComponent?: LineComponent \| undefined; LineComponent?: LineComponent \| undefined; TickMarkLineComponent?: LineComponent \| undefined; tickLabelFormatter?: ((value: number) => ChartTextChildren) \| undefined; TickLabelComponent?: AxisTickLabelComponent \| undefined; } & { position?: top \| bottom \| undefined; height?: number \| undefined; }) \| undefined` | No | `-` | Configuration for x-axis. Accepts axis config and axis props. To show the axis, set showXAxis to true. |
1133
+ | `yAxis` | `(Partial<AxisConfigProps> & SharedProps & { label?: string; labelGap?: number \| undefined; minTickLabelGap?: number \| undefined; requestedTickCount?: number \| undefined; showGrid?: boolean \| undefined; showLine?: boolean \| undefined; showTickMarks?: boolean \| undefined; tickMarkSize?: number \| undefined; ticks?: number[] \| ((value: number) => boolean) \| undefined; tickMarkLabelGap?: number \| undefined; tickInterval?: number \| undefined; tickMinStep?: number \| undefined; tickMaxStep?: number \| undefined; } & { className?: string \| undefined; classNames?: { root?: string \| undefined; label?: string \| undefined; tickLabel?: string \| undefined; gridLine?: string \| undefined; line?: string \| undefined; tickMark?: string \| undefined; } \| undefined; style?: CSSProperties \| undefined; styles?: { root?: CSSProperties \| undefined; label?: CSSProperties \| undefined; tickLabel?: CSSProperties \| undefined; gridLine?: CSSProperties \| undefined; line?: CSSProperties \| undefined; tickMark?: CSSProperties \| undefined; } \| undefined; GridLineComponent?: LineComponent \| undefined; LineComponent?: LineComponent \| undefined; TickMarkLineComponent?: LineComponent \| undefined; tickLabelFormatter?: ((value: number) => ChartTextChildren) \| undefined; TickLabelComponent?: AxisTickLabelComponent \| undefined; } & { axisId?: string \| undefined; position?: left \| right \| undefined; width?: number \| undefined; }) \| undefined` | No | `-` | Configuration for y-axis. Accepts axis config and axis props. To show the axis, set showYAxis to true. |
1134
1134
  | `zIndex` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
1135
1135
 
1136
1136
 
@@ -2052,8 +2052,8 @@ function ForecastAssetPrice() {
2052
2052
  | `userSelect` | `ResponsiveProp<text \| none \| all \| auto>` | No | `-` | - |
2053
2053
  | `visibility` | `ResponsiveProp<hidden \| visible>` | No | `-` | - |
2054
2054
  | `width` | `ResponsiveProp<Width<string \| number>>` | No | `-` | - |
2055
- | `xAxis` | `(Partial<AxisConfigProps> & AxisBaseProps & { className?: string; classNames?: { root?: string \| undefined; label?: string \| undefined; tickLabel?: string \| undefined; gridLine?: string \| undefined; line?: string \| undefined; tickMark?: string \| undefined; } \| undefined; style?: CSSProperties \| undefined; styles?: { root?: CSSProperties \| undefined; label?: CSSProperties \| undefined; tickLabel?: CSSProperties \| undefined; gridLine?: CSSProperties \| undefined; line?: CSSProperties \| undefined; tickMark?: CSSProperties \| undefined; } \| undefined; GridLineComponent?: LineComponent \| undefined; LineComponent?: LineComponent \| undefined; TickMarkLineComponent?: LineComponent \| undefined; tickLabelFormatter?: ((value: number) => ChartTextChildren) \| undefined; TickLabelComponent?: AxisTickLabelComponent \| undefined; } & { position?: top \| bottom \| undefined; height?: number \| undefined; }) \| undefined` | No | `-` | Configuration for x-axis. Accepts axis config and axis props. To show the axis, set showXAxis to true. |
2056
- | `yAxis` | `(Partial<AxisConfigProps> & AxisBaseProps & { className?: string; classNames?: { root?: string \| undefined; label?: string \| undefined; tickLabel?: string \| undefined; gridLine?: string \| undefined; line?: string \| undefined; tickMark?: string \| undefined; } \| undefined; style?: CSSProperties \| undefined; styles?: { root?: CSSProperties \| undefined; label?: CSSProperties \| undefined; tickLabel?: CSSProperties \| undefined; gridLine?: CSSProperties \| undefined; line?: CSSProperties \| undefined; tickMark?: CSSProperties \| undefined; } \| undefined; GridLineComponent?: LineComponent \| undefined; LineComponent?: LineComponent \| undefined; TickMarkLineComponent?: LineComponent \| undefined; tickLabelFormatter?: ((value: number) => ChartTextChildren) \| undefined; TickLabelComponent?: AxisTickLabelComponent \| undefined; } & { axisId?: string \| undefined; position?: left \| right \| undefined; width?: number \| undefined; }) \| undefined` | No | `-` | Configuration for y-axis. Accepts axis config and axis props. To show the axis, set showYAxis to true. |
2055
+ | `xAxis` | `(Partial<AxisConfigProps> & SharedProps & { label?: string; labelGap?: number \| undefined; minTickLabelGap?: number \| undefined; requestedTickCount?: number \| undefined; showGrid?: boolean \| undefined; showLine?: boolean \| undefined; showTickMarks?: boolean \| undefined; tickMarkSize?: number \| undefined; ticks?: number[] \| ((value: number) => boolean) \| undefined; tickMarkLabelGap?: number \| undefined; tickInterval?: number \| undefined; tickMinStep?: number \| undefined; tickMaxStep?: number \| undefined; } & { className?: string \| undefined; classNames?: { root?: string \| undefined; label?: string \| undefined; tickLabel?: string \| undefined; gridLine?: string \| undefined; line?: string \| undefined; tickMark?: string \| undefined; } \| undefined; style?: CSSProperties \| undefined; styles?: { root?: CSSProperties \| undefined; label?: CSSProperties \| undefined; tickLabel?: CSSProperties \| undefined; gridLine?: CSSProperties \| undefined; line?: CSSProperties \| undefined; tickMark?: CSSProperties \| undefined; } \| undefined; GridLineComponent?: LineComponent \| undefined; LineComponent?: LineComponent \| undefined; TickMarkLineComponent?: LineComponent \| undefined; tickLabelFormatter?: ((value: number) => ChartTextChildren) \| undefined; TickLabelComponent?: AxisTickLabelComponent \| undefined; } & { position?: top \| bottom \| undefined; height?: number \| undefined; }) \| undefined` | No | `-` | Configuration for x-axis. Accepts axis config and axis props. To show the axis, set showXAxis to true. |
2056
+ | `yAxis` | `(Partial<AxisConfigProps> & SharedProps & { label?: string; labelGap?: number \| undefined; minTickLabelGap?: number \| undefined; requestedTickCount?: number \| undefined; showGrid?: boolean \| undefined; showLine?: boolean \| undefined; showTickMarks?: boolean \| undefined; tickMarkSize?: number \| undefined; ticks?: number[] \| ((value: number) => boolean) \| undefined; tickMarkLabelGap?: number \| undefined; tickInterval?: number \| undefined; tickMinStep?: number \| undefined; tickMaxStep?: number \| undefined; } & { className?: string \| undefined; classNames?: { root?: string \| undefined; label?: string \| undefined; tickLabel?: string \| undefined; gridLine?: string \| undefined; line?: string \| undefined; tickMark?: string \| undefined; } \| undefined; style?: CSSProperties \| undefined; styles?: { root?: CSSProperties \| undefined; label?: CSSProperties \| undefined; tickLabel?: CSSProperties \| undefined; gridLine?: CSSProperties \| undefined; line?: CSSProperties \| undefined; tickMark?: CSSProperties \| undefined; } \| undefined; GridLineComponent?: LineComponent \| undefined; LineComponent?: LineComponent \| undefined; TickMarkLineComponent?: LineComponent \| undefined; tickLabelFormatter?: ((value: number) => ChartTextChildren) \| undefined; TickLabelComponent?: AxisTickLabelComponent \| undefined; } & { axisId?: string \| undefined; position?: left \| right \| undefined; width?: number \| undefined; }) \| undefined` | No | `-` | Configuration for y-axis. Accepts axis config and axis props. To show the axis, set showYAxis to true. |
2057
2057
  | `zIndex` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
2058
2058
 
2059
2059
 
@@ -108,7 +108,25 @@ This is for demo purposes. ProgressContainerWithButtons isn't designed for produ
108
108
  </ProgressContainerWithButtons>
109
109
  ```
110
110
 
111
- ### Animation Callbacks
111
+ ### Animation
112
+
113
+ By default, ProgressBar animates progress changes. Use `disableAnimateOnMount` to skip the initial animation while still animating subsequent changes.
114
+
115
+ ```tsx live
116
+ <ProgressContainerWithButtons>
117
+ {({ calculateProgress }) => (
118
+ <VStack gap={2}>
119
+ <Text variant="label2">Normal animation</Text>
120
+ <ProgressBar progress={calculateProgress(0)} />
121
+
122
+ <Text variant="label2">Disable animation on mount</Text>
123
+ <ProgressBar disableAnimateOnMount progress={calculateProgress(0.3)} />
124
+ </VStack>
125
+ )}
126
+ </ProgressContainerWithButtons>
127
+ ```
128
+
129
+ #### Callbacks
112
130
 
113
131
  You can use the `onAnimationStart` and `onAnimationEnd` callbacks to track the progress of the animation.
114
132
 
@@ -150,7 +168,7 @@ function Example() {
150
168
  | `classNames` | `{ root?: string; progress?: string \| undefined; } \| undefined` | No | `-` | Custom class names for the progress bar. |
151
169
  | `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` | No | `primary` | Custom progress color. |
152
170
  | `disableAnimateOnMount` | `boolean` | No | `false` | Disable animation on component mount |
153
- | `disabled` | `boolean` | No | `false` | Toggle used to show a disabled progress visualization |
171
+ | `disabled` | `boolean` | No | `-` | Toggle used to show a disabled progress visualization |
154
172
  | `key` | `Key \| null` | No | `-` | - |
155
173
  | `onAnimationEnd` | `(() => void)` | No | `-` | Callback fired when the progress animation ends. |
156
174
  | `onAnimationStart` | `(() => void)` | No | `-` | Callback fired when the progress animation starts. |
@@ -195,13 +195,84 @@ This is for demo purposes. ProgressContainerWithButtons isn't designed for produ
195
195
  </ProgressContainerWithButtons>
196
196
  ```
197
197
 
198
+ ### Animation
199
+
200
+ By default, ProgressBar animates progress changes. Use `disableAnimateOnMount` to skip the initial animation while still animating subsequent changes.
201
+
202
+ ```tsx live
203
+ <ProgressContainerWithButtons>
204
+ {({ calculateProgress }) => (
205
+ <VStack gap={2}>
206
+ <Text variant="label2">Normal animation</Text>
207
+ <ProgressBarWithFixedLabels
208
+ startLabel={0}
209
+ endLabel={Math.round(calculateProgress(0) * 100)}
210
+ labelPlacement="above"
211
+ >
212
+ <ProgressBar progress={calculateProgress(0)} />
213
+ </ProgressBarWithFixedLabels>
214
+
215
+ <Text variant="label2">Disable animation on mount</Text>
216
+ <ProgressBarWithFixedLabels
217
+ disableAnimateOnMount
218
+ startLabel={0}
219
+ endLabel={Math.round(calculateProgress(0.3) * 100)}
220
+ labelPlacement="above"
221
+ >
222
+ <ProgressBar disableAnimateOnMount progress={calculateProgress(0.3)} />
223
+ </ProgressBarWithFixedLabels>
224
+ </VStack>
225
+ )}
226
+ </ProgressContainerWithButtons>
227
+ ```
228
+
229
+ #### Callbacks
230
+
231
+ You can use the `onAnimationStart` and `onAnimationEnd` callbacks to track the progress of the animation.
232
+
233
+ ```jsx live
234
+ function Example() {
235
+ const [animationStatus, setAnimationStatus] = React.useState('Ready');
236
+
237
+ const handleAnimationStart = useCallback(() => {
238
+ setAnimationStatus('Animating...');
239
+ }, []);
240
+
241
+ const handleAnimationEnd = useCallback(() => {
242
+ setAnimationStatus('Animation Ended');
243
+ }, []);
244
+
245
+ return (
246
+ <ProgressContainerWithButtons>
247
+ {({ calculateProgress }) => (
248
+ <VStack gap={2}>
249
+ <Text>Animation Status: {animationStatus}</Text>
250
+ <ProgressBarWithFixedLabels
251
+ startLabel={0}
252
+ endLabel={Math.round(calculateProgress(0.2) * 100)}
253
+ labelPlacement="above"
254
+ >
255
+ <ProgressBar
256
+ onAnimationEnd={handleAnimationEnd}
257
+ onAnimationStart={handleAnimationStart}
258
+ progress={calculateProgress(0.2)}
259
+ />
260
+ </ProgressBarWithFixedLabels>
261
+ </VStack>
262
+ )}
263
+ </ProgressContainerWithButtons>
264
+ );
265
+ }
266
+ ```
267
+
198
268
  ## Props
199
269
 
200
270
  | Prop | Type | Required | Default | Description |
201
271
  | --- | --- | --- | --- | --- |
202
272
  | `className` | `string` | No | `-` | Custom class name for the progress bar with fixed labels root. |
203
273
  | `classNames` | `{ root?: string; labelContainer?: string \| undefined; startLabel?: string \| undefined; endLabel?: string \| undefined; } \| undefined` | No | `-` | Custom class names for the progress bar with fixed labels. |
204
- | `disabled` | `boolean` | No | `false` | Toggle used to show a disabled progress visualization |
274
+ | `disableAnimateOnMount` | `boolean` | No | `false` | Disable animation on component mount |
275
+ | `disabled` | `boolean` | No | `-` | Toggle used to show a disabled progress visualization |
205
276
  | `endLabel` | `number \| { value: number; render: (num: number, disabled?: boolean \| undefined) => ReactNode; }` | No | `-` | Label that is pinned to the end of the container. If a number is used then it will format it as a percentage. |
206
277
  | `labelPlacement` | `above \| below \| beside` | No | `beside` | Position of label relative to the bar |
207
278
  | `startLabel` | `number \| { value: number; render: (num: number, disabled?: boolean \| undefined) => ReactNode; }` | No | `-` | Label that is pinned to the start of the container. If a number is used then it will format it as a percentage. |
@@ -164,6 +164,76 @@ This is for demo purposes. ProgressContainerWithButtons isn't designed for produ
164
164
  </ProgressContainerWithButtons>
165
165
  ```
166
166
 
167
+ ### Animation
168
+
169
+ By default, ProgressBar animates progress changes. Use `disableAnimateOnMount` to skip the initial animation while still animating subsequent changes.
170
+
171
+ ```tsx live
172
+ <ProgressContainerWithButtons>
173
+ {({ calculateProgress }) => (
174
+ <VStack gap={2}>
175
+ <Text variant="label2">Normal animation</Text>
176
+ <ProgressBarWithFloatLabel
177
+ label={Math.round(calculateProgress(0) * 100)}
178
+ progress={calculateProgress(0)}
179
+ labelPlacement="above"
180
+ >
181
+ <ProgressBar progress={calculateProgress(0)} />
182
+ </ProgressBarWithFloatLabel>
183
+
184
+ <Text variant="label2">Disable animation on mount</Text>
185
+ <ProgressBarWithFloatLabel
186
+ disableAnimateOnMount
187
+ label={Math.round(calculateProgress(0.3) * 100)}
188
+ progress={calculateProgress(0.3)}
189
+ labelPlacement="above"
190
+ >
191
+ <ProgressBar disableAnimateOnMount progress={calculateProgress(0.3)} />
192
+ </ProgressBarWithFloatLabel>
193
+ </VStack>
194
+ )}
195
+ </ProgressContainerWithButtons>
196
+ ```
197
+
198
+ #### Callbacks
199
+
200
+ You can use the `onAnimationStart` and `onAnimationEnd` callbacks to track the progress of the animation.
201
+
202
+ ```jsx live
203
+ function Example() {
204
+ const [animationStatus, setAnimationStatus] = React.useState('Ready');
205
+
206
+ const handleAnimationStart = useCallback(() => {
207
+ setAnimationStatus('Animating...');
208
+ }, []);
209
+
210
+ const handleAnimationEnd = useCallback(() => {
211
+ setAnimationStatus('Animation Ended');
212
+ }, []);
213
+
214
+ return (
215
+ <ProgressContainerWithButtons>
216
+ {({ calculateProgress }) => (
217
+ <VStack gap={2}>
218
+ <Text>Animation Status: {animationStatus}</Text>
219
+ <ProgressBarWithFloatLabel
220
+ label={Math.round(calculateProgress(0.2) * 100)}
221
+ progress={calculateProgress(0.2)}
222
+ labelPlacement="above"
223
+ >
224
+ <ProgressBar
225
+ onAnimationEnd={handleAnimationEnd}
226
+ onAnimationStart={handleAnimationStart}
227
+ progress={calculateProgress(0.2)}
228
+ />
229
+ </ProgressBarWithFloatLabel>
230
+ </VStack>
231
+ )}
232
+ </ProgressContainerWithButtons>
233
+ );
234
+ }
235
+ ```
236
+
167
237
  ## Props
168
238
 
169
239
  | Prop | Type | Required | Default | Description |
@@ -172,7 +242,8 @@ This is for demo purposes. ProgressContainerWithButtons isn't designed for produ
172
242
  | `progress` | `number` | Yes | `-` | Number between 0-1 representing the progress percentage |
173
243
  | `className` | `string` | No | `-` | Custom class name for the progress bar with float label root. |
174
244
  | `classNames` | `{ root?: string; labelContainer?: string \| undefined; label?: string \| undefined; } \| undefined` | No | `-` | Custom class names for the progress bar with float label. |
175
- | `disabled` | `boolean` | No | `false` | Toggle used to show a disabled progress visualization |
245
+ | `disableAnimateOnMount` | `boolean` | No | `false` | Disable animation on component mount |
246
+ | `disabled` | `boolean` | No | `-` | Toggle used to show a disabled progress visualization |
176
247
  | `labelPlacement` | `above \| below` | No | `above` | Position of label relative to the bar |
177
248
  | `style` | `CSSProperties` | No | `-` | Custom styles for the progress bar with float label root. |
178
249
  | `styles` | `{ root?: CSSProperties; labelContainer?: CSSProperties \| undefined; label?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for the progress bar with float label. |
@@ -13,7 +13,7 @@ import { ProgressCircle } from '@coinbase/cds-web/visualizations/ProgressCircle'
13
13
  ### Default
14
14
 
15
15
  ```jsx live
16
- <HStack gap={2}>
16
+ <HStack gap={2} flexWrap="wrap">
17
17
  <ProgressCircle progress={0} size={100} />
18
18
  <ProgressCircle progress={0.5} size={100} />
19
19
  <ProgressCircle progress={1} size={100} />
@@ -23,7 +23,7 @@ import { ProgressCircle } from '@coinbase/cds-web/visualizations/ProgressCircle'
23
23
  ### Thin
24
24
 
25
25
  ```jsx live
26
- <HStack gap={2}>
26
+ <HStack gap={2} flexWrap="wrap">
27
27
  <ProgressCircle progress={0} weight="thin" size={100} />
28
28
  <ProgressCircle progress={0.5} weight="thin" size={100} />
29
29
  <ProgressCircle progress={1} weight="thin" size={100} />
@@ -33,7 +33,7 @@ import { ProgressCircle } from '@coinbase/cds-web/visualizations/ProgressCircle'
33
33
  ### Semiheavy
34
34
 
35
35
  ```jsx live
36
- <HStack gap={2}>
36
+ <HStack gap={2} flexWrap="wrap">
37
37
  <ProgressCircle progress={0} weight="semiheavy" size={100} />
38
38
  <ProgressCircle progress={0.5} weight="semiheavy" size={100} />
39
39
  <ProgressCircle progress={1} weight="semiheavy" size={100} />
@@ -43,7 +43,7 @@ import { ProgressCircle } from '@coinbase/cds-web/visualizations/ProgressCircle'
43
43
  ### Heavy
44
44
 
45
45
  ```jsx live
46
- <HStack gap={2}>
46
+ <HStack gap={2} flexWrap="wrap">
47
47
  <ProgressCircle progress={0} weight="heavy" size={100} />
48
48
  <ProgressCircle progress={0.5} weight="heavy" size={100} />
49
49
  <ProgressCircle progress={1} weight="heavy" size={100} />
@@ -53,7 +53,7 @@ import { ProgressCircle } from '@coinbase/cds-web/visualizations/ProgressCircle'
53
53
  ### No Text
54
54
 
55
55
  ```jsx live
56
- <HStack gap={2}>
56
+ <HStack gap={2} flexWrap="wrap">
57
57
  <ProgressCircle progress={0} hideContent size={25} />
58
58
  <ProgressCircle progress={0.5} hideContent size={25} />
59
59
  <ProgressCircle progress={1} hideContent size={25} />
@@ -63,7 +63,7 @@ import { ProgressCircle } from '@coinbase/cds-web/visualizations/ProgressCircle'
63
63
  ### Disabled
64
64
 
65
65
  ```jsx live
66
- <HStack gap={2}>
66
+ <HStack gap={2} flexWrap="wrap">
67
67
  <ProgressCircle progress={0} disabled size={100} />
68
68
  <ProgressCircle progress={0.5} disabled size={100} />
69
69
  <ProgressCircle progress={1} disabled size={100} />
@@ -73,7 +73,7 @@ import { ProgressCircle } from '@coinbase/cds-web/visualizations/ProgressCircle'
73
73
  ### Colors
74
74
 
75
75
  ```jsx live
76
- <HStack gap={2}>
76
+ <HStack gap={2} flexWrap="wrap">
77
77
  <ProgressCircle progress={0.5} color="bgPositive" size={100} />
78
78
  <ProgressCircle progress={0.5} color="bgNegative" size={100} />
79
79
  <ProgressCircle progress={0.5} color="bgPrimary" size={100} />
@@ -109,7 +109,7 @@ You can provide an image, such as an asset, as the content node.
109
109
 
110
110
  ```jsx live
111
111
  <VStack gap={2}>
112
- <HStack gap={2}>
112
+ <HStack gap={2} flexWrap="wrap">
113
113
  <ProgressCircle
114
114
  progress={1}
115
115
  size={56}
@@ -211,7 +211,7 @@ You can provide an image, such as an asset, as the content node.
211
211
  weight="thin"
212
212
  />
213
213
  </HStack>
214
- <HStack gap={2}>
214
+ <HStack gap={2} flexWrap="wrap">
215
215
  <ProgressCircle
216
216
  styles={{
217
217
  progress: {
@@ -387,7 +387,29 @@ This is for demo purposes. ProgressContainerWithButtons isn't designed for produ
387
387
  </ProgressContainerWithButtons>
388
388
  ```
389
389
 
390
- ### Animation Callbacks
390
+ ### Animation
391
+
392
+ By default, ProgressCircle animates progress changes. Use `disableAnimateOnMount` to skip the initial animation while still animating subsequent changes.
393
+
394
+ ```tsx live
395
+ <ProgressContainerWithButtons>
396
+ {({ calculateProgress }) => (
397
+ <HStack gap={2}>
398
+ <VStack gap={1} alignItems="center">
399
+ <Text variant="label2">Normal animation</Text>
400
+ <ProgressCircle progress={calculateProgress(0)} size={100} />
401
+ </VStack>
402
+
403
+ <VStack gap={1} alignItems="center">
404
+ <Text variant="label2">Disable animation on mount</Text>
405
+ <ProgressCircle disableAnimateOnMount progress={calculateProgress(0.3)} size={100} />
406
+ </VStack>
407
+ </HStack>
408
+ )}
409
+ </ProgressContainerWithButtons>
410
+ ```
411
+
412
+ #### Callbacks
391
413
 
392
414
  You can use the `onAnimationStart` and `onAnimationEnd` callbacks to track the progress of the animation.
393
415
 
@@ -431,7 +453,7 @@ function Example() {
431
453
  | `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` | No | `primary` | Custom progress color. |
432
454
  | `contentNode` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | Optional component to override the default content rendered inside the circle. |
433
455
  | `disableAnimateOnMount` | `boolean` | No | `false` | Disable animation on component mount |
434
- | `disabled` | `boolean` | No | `false` | Toggle used to show a disabled progress visualization |
456
+ | `disabled` | `boolean` | No | `-` | Toggle used to show a disabled progress visualization |
435
457
  | `hideContent` | `boolean` | No | `-` | Toggle used to hide the content node rendered inside the circle. |
436
458
  | `hideText` | `boolean` | No | `-` | - |
437
459
  | `key` | `Key \| null` | No | `-` | - |
@@ -672,6 +672,7 @@ function CustomTickLabelExample() {
672
672
  | `showTickMarks` | `boolean` | No | `-` | Whether to show tick marks on the axis. |
673
673
  | `style` | `CSSProperties` | No | `-` | Custom style for the axis. |
674
674
  | `styles` | `{ root?: CSSProperties; label?: CSSProperties \| undefined; tickLabel?: CSSProperties \| undefined; gridLine?: CSSProperties \| undefined; line?: CSSProperties \| undefined; tickMark?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for the axis. |
675
+ | `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 |
675
676
  | `tickInterval` | `number` | No | `32 (for x-axis)` | Interval at which to show ticks. When provided, calculates tick count based on available space. |
676
677
  | `tickLabelFormatter` | `((value: number) => ChartTextChildren)` | No | `-` | Formatter function for axis tick values. Tick values will be wrapped in ChartText component. |
677
678
  | `tickMarkLabelGap` | `number` | No | `2 for x-axis, 8 for y-axis` | Space between the axis tick mark and labels. If tick marks are not shown, this is the gap between the axis and the chart. |
@@ -580,6 +580,7 @@ function CustomTickLabelExample() {
580
580
  | `showTickMarks` | `boolean` | No | `-` | Whether to show tick marks on the axis. |
581
581
  | `style` | `CSSProperties` | No | `-` | Custom style for the axis. |
582
582
  | `styles` | `{ root?: CSSProperties; label?: CSSProperties \| undefined; tickLabel?: CSSProperties \| undefined; gridLine?: CSSProperties \| undefined; line?: CSSProperties \| undefined; tickMark?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for the axis. |
583
+ | `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 |
583
584
  | `tickInterval` | `number` | No | `32 (for x-axis)` | Interval at which to show ticks. When provided, calculates tick count based on available space. |
584
585
  | `tickLabelFormatter` | `((value: number) => ChartTextChildren)` | No | `-` | Formatter function for axis tick values. Tick values will be wrapped in ChartText component. |
585
586
  | `tickMarkLabelGap` | `number` | No | `2 for x-axis, 8 for y-axis` | Space between the axis tick mark and labels. If tick marks are not shown, this is the gap between the axis and the chart. |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coinbase/cds-mcp-server",
3
- "version": "8.35.0",
3
+ "version": "8.36.0",
4
4
  "description": "Coinbase Design System - MCP Server",
5
5
  "repository": {
6
6
  "type": "git",
@@ -29,10 +29,6 @@
29
29
  "mcp-docs",
30
30
  "CHANGELOG"
31
31
  ],
32
- "peerDependencies": {
33
- "react": "^18.3.1",
34
- "react-dom": "^18.3.1"
35
- },
36
32
  "dependencies": {
37
33
  "@inquirer/prompts": "^7.5.3",
38
34
  "@modelcontextprotocol/sdk": "^1.13.1",
@@ -41,7 +37,6 @@
41
37
  "devDependencies": {
42
38
  "@babel/core": "^7.28.0",
43
39
  "@babel/preset-env": "^7.28.0",
44
- "@babel/preset-react": "^7.27.1",
45
40
  "@babel/preset-typescript": "^7.27.1"
46
41
  }
47
42
  }