@coinbase/cds-mcp-server 8.17.2 → 8.17.3

package/mcp-docs/web/components/ProgressBarWithFloatLabel.txt

@@ -0,0 +1,182 @@
+# ProgressBarWithFloatLabel
+
+A ProgressBar with a floating label that moves with progress.
+
+## Import
+
+```jsx
+import { ProgressBarWithFloatLabel } from '@coinbase/cds-web/visualizations/ProgressBarWithFloatLabel'
+```
+
+## Props
+
+| Prop | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| `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. |
+| `progress` | `number` | Yes | `-` | Number between 0-1 representing the progress percentage |
+| `className` | `string` | No | `-` | Custom class name for the progress bar with float label root. |
+| `classNames` | `{ root?: string; labelContainer?: string \| undefined; label?: string \| undefined; } \| undefined` | No | `-` | Custom class names for the progress bar with float label. |
+| `disabled` | `boolean` | No | `false` | Toggle used to show a disabled progress visualization |
+| `labelPlacement` | `above \| below` | No | `above` | Position of label relative to the bar |
+| `style` | `CSSProperties` | No | `-` | Custom styles for the progress bar with float label root. |
+| `styles` | `{ root?: CSSProperties; labelContainer?: CSSProperties \| undefined; label?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for the progress bar with float label. |
+| `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 |
+
+
+## Examples
+
+### Label Above
+
+```jsx live
+<VStack gap={2}>
+  <ProgressBarWithFloatLabel label={0} progress={0} labelPlacement="above">
+    <ProgressBar progress={0} />
+  </ProgressBarWithFloatLabel>
+  <ProgressBarWithFloatLabel label={20} progress={0.2} labelPlacement="above">
+    <ProgressBar progress={0.2} />
+  </ProgressBarWithFloatLabel>
+</VStack>
+```
+
+### Label Below
+
+```jsx live
+<VStack gap={2}>
+  <ProgressBarWithFloatLabel label={0} progress={0} labelPlacement="below">
+    <ProgressBar progress={0} />
+  </ProgressBarWithFloatLabel>
+  <ProgressBarWithFloatLabel label={20} progress={0.2} labelPlacement="below">
+    <ProgressBar progress={0.2} />
+  </ProgressBarWithFloatLabel>
+</VStack>
+```
+
+### Disabled
+
+```jsx live
+<VStack gap={2}>
+  <ProgressBarWithFloatLabel label={70} progress={0.7} disabled>
+    <ProgressBar progress={0.7} disabled />
+  </ProgressBarWithFloatLabel>
+</VStack>
+```
+
+### Custom Labels
+
+```jsx live
+function Example() {
+  const renderLabelNumStr = useCallback((num) => {
+    return `$${num.toLocaleString()}`;
+  }, []);
+
+  const renderLabelNum = useCallback((num, disabled) => {
+    return (
+      <TextTitle3 as="span" disabled={disabled}>
+        ${num.toLocaleString()}
+      </TextTitle3>
+    );
+  }, []);
+
+  return (
+    <VStack gap={2}>
+      <ProgressBarWithFloatLabel
+        progress={0.6}
+        label={{ value: 12500, render: renderLabelNumStr }}
+        labelPlacement="above"
+      >
+        <ProgressBar progress={0.6} />
+      </ProgressBarWithFloatLabel>
+      <ProgressBarWithFloatLabel
+        progress={0.6}
+        label={{ value: 12500, render: renderLabelNum }}
+        labelPlacement="above"
+      >
+        <ProgressBar progress={0.6} />
+      </ProgressBarWithFloatLabel>
+      <ProgressBarWithFloatLabel
+        progress={0.6}
+        label={{ value: 12500, render: renderLabelNumStr }}
+        labelPlacement="above"
+        disabled
+      >
+        <ProgressBar disabled progress={0.6} />
+      </ProgressBarWithFloatLabel>
+      <ProgressBarWithFloatLabel
+        progress={0.6}
+        label={{ value: 12500, render: renderLabelNum }}
+        labelPlacement="above"
+        disabled
+      >
+        <ProgressBar disabled progress={0.6} />
+      </ProgressBarWithFloatLabel>
+    </VStack>
+  );
+}
+```
+
+### Custom Styles
+
+You can customize the appearance of the progress bar and float label using the `styles` prop.
+
+```tsx live
+<ProgressContainerWithButtons>
+  {({ calculateProgress }) => (
+    <VStack gap={2}>
+      <ProgressBarWithFloatLabel
+        label={Math.round(calculateProgress(0.4) * 100)}
+        labelPlacement="above"
+        progress={calculateProgress(0.4)}
+        styles={{
+          label: {
+            color: 'var(--color-bgPrimary)',
+            fontWeight: 'bold',
+          },
+        }}
+      >
+        <ProgressBar
+          color="bgPrimary"
+          progress={calculateProgress(0.4)}
+          styles={{
+            container: {
+              height: 'var(--space-8)',
+              borderRadius: 'var(--borderRadius-1000)',
+            },
+            progress: {
+              borderRadius: 'var(--borderRadius-1000)',
+            },
+          }}
+        />
+      </ProgressBarWithFloatLabel>
+    </VStack>
+  )}
+</ProgressContainerWithButtons>
+```
+
+### Interactive Demo
+
+This is for demo purposes. ProgressContainerWithButtons isn't designed for production usage.
+
+```jsx live
+<ProgressContainerWithButtons>
+  {({ calculateProgress }) => (
+    <VStack gap={2}>
+      <ProgressBarWithFloatLabel
+        label={Math.round(calculateProgress(0) * 100)}
+        progress={calculateProgress(0)}
+        labelPlacement="above"
+      >
+        <ProgressBar progress={calculateProgress(0)} />
+      </ProgressBarWithFloatLabel>
+      <ProgressBarWithFloatLabel
+        label={Math.round(calculateProgress(0.2) * 100)}
+        progress={calculateProgress(0.2)}
+        labelPlacement="above"
+      >
+        <ProgressBar progress={calculateProgress(0.2)} />
+      </ProgressBarWithFloatLabel>
+    </VStack>
+  )}
+</ProgressContainerWithButtons>
+```
+
+

package/mcp-docs/web/components/ProgressCircle.txt

@@ -0,0 +1,444 @@
+# ProgressCircle
+
+A circular visual indicator of completion progress.
+
+## Import
+
+```jsx
+import { ProgressCircle } from '@coinbase/cds-web/visualizations/ProgressCircle'
+```
+
+## Props
+
+| Prop | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| `progress` | `number` | Yes | `-` | Number between 0-1 representing the progress percentage |
+| `className` | `string` | No | `-` | Custom class name for the progress circle root. |
+| `classNames` | `{ root?: string; svg?: string \| undefined; circle?: string \| undefined; progress?: string \| undefined; } \| undefined` | No | `-` | Custom class names for the progress circle. |
+| `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. |
+| `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. |
+| `disableAnimateOnMount` | `boolean` | No | `false` | Disable animation on component mount |
+| `disabled` | `boolean` | No | `false` | Toggle used to show a disabled progress visualization |
+| `hideContent` | `boolean` | No | `-` | Toggle used to hide the content node rendered inside the circle. |
+| `hideText` | `boolean` | No | `-` | - |
+| `key` | `Key \| null` | No | `-` | - |
+| `onAnimationEnd` | `(() => void)` | No | `-` | Callback fired when the progress animation ends. |
+| `onAnimationStart` | `(() => void)` | No | `-` | Callback fired when the progress animation starts. |
+| `ref` | `RefObject<HTMLDivElement> \| ((instance: HTMLDivElement \| null) => void) \| null` | No | `-` | - |
+| `size` | `number` | No | `-` | Optional size in px for the visualization. This is useful if the visualization is used in an HStack. If this is omitted the visualization will fill the parent width or height. Since its a circular visualization it will fill the smaller of the parent width or height |
+| `style` | `CSSProperties` | No | `-` | Custom styles for the progress circle root. |
+| `styles` | `{ root?: CSSProperties; svg?: CSSProperties \| undefined; circle?: CSSProperties \| undefined; progress?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for the progress circle. |
+| `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 |
+| `weight` | `normal \| heavy \| thin \| semiheavy` | No | `normal` | Toggle used to change thickness of progress visualization |
+
+
+## Examples
+
+### Default
+
+```jsx live
+<HStack gap={2}>
+  <ProgressCircle progress={0} size={100} />
+  <ProgressCircle progress={0.5} size={100} />
+  <ProgressCircle progress={1} size={100} />
+</HStack>
+```
+
+### Thin
+
+```jsx live
+<HStack gap={2}>
+  <ProgressCircle progress={0} weight="thin" size={100} />
+  <ProgressCircle progress={0.5} weight="thin" size={100} />
+  <ProgressCircle progress={1} weight="thin" size={100} />
+</HStack>
+```
+
+### Semiheavy
+
+```jsx live
+<HStack gap={2}>
+  <ProgressCircle progress={0} weight="semiheavy" size={100} />
+  <ProgressCircle progress={0.5} weight="semiheavy" size={100} />
+  <ProgressCircle progress={1} weight="semiheavy" size={100} />
+</HStack>
+```
+
+### Heavy
+
+```jsx live
+<HStack gap={2}>
+  <ProgressCircle progress={0} weight="heavy" size={100} />
+  <ProgressCircle progress={0.5} weight="heavy" size={100} />
+  <ProgressCircle progress={1} weight="heavy" size={100} />
+</HStack>
+```
+
+### No Text
+
+```jsx live
+<HStack gap={2}>
+  <ProgressCircle progress={0} hideContent size={25} />
+  <ProgressCircle progress={0.5} hideContent size={25} />
+  <ProgressCircle progress={1} hideContent size={25} />
+</HStack>
+```
+
+### Disabled
+
+```jsx live
+<HStack gap={2}>
+  <ProgressCircle progress={0} disabled size={100} />
+  <ProgressCircle progress={0.5} disabled size={100} />
+  <ProgressCircle progress={1} disabled size={100} />
+</HStack>
+```
+
+### Colors
+
+```jsx live
+<HStack gap={2}>
+  <ProgressCircle progress={0.5} color="bgPositive" size={100} />
+  <ProgressCircle progress={0.5} color="bgNegative" size={100} />
+  <ProgressCircle progress={0.5} color="bgPrimary" size={100} />
+  <ProgressCircle progress={0.5} color="fg" size={100} />
+</HStack>
+```
+
+### Fill Parent
+
+The progress circle can be dynamically sized to fit its parent. If you drag the browser window smaller or larger then the ProgressCircle will resize accordingly.
+
+```jsx live
+<HStack gap={2} flexWrap="wrap">
+  <div style={{ height: '15vw', width: '15vw', minWidth: '60px', minHeight: '60px' }}>
+    <ProgressCircle progress={1} />
+  </div>
+  <div style={{ height: '10vw', width: '10vw', minWidth: '60px', minHeight: '60px' }}>
+    <ProgressCircle progress={1} />
+  </div>
+  <div style={{ height: '5vw', width: '5vw', minWidth: '60px', minHeight: '60px' }}>
+    <ProgressCircle progress={1} />
+  </div>
+</HStack>
+```
+
+### Content Node Customization
+
+You can override the default content node to display a custom node. Note that the content node is clipped to the circle.
+
+#### With Asset
+
+You can provide an image, such as an asset, as the content node.
+
+```jsx live
+<VStack gap={2}>
+  <HStack gap={2}>
+    <ProgressCircle
+      progress={1}
+      size={56}
+      styles={{
+        progress: {
+          stroke: assets.eth.color,
+        },
+      }}
+      contentNode={
+        <Box height="100%" padding={0.25} width="100%">
+          <RemoteImage
+            alt={assets.eth.name}
+            shape="circle"
+            source={assets.eth.imageUrl}
+            style={{ width: '100%', height: '100%' }}
+          />
+        </Box>
+      }
+      weight="thin"
+    />
+
+    <ProgressCircle
+      progress={0.75}
+      size={56}
+      styles={{
+        progress: {
+          stroke: assets.ltc.color,
+        },
+      }}
+      contentNode={
+        <Box height="100%" padding={0.25} width="100%">
+          <RemoteImage
+            alt={assets.ltc.name}
+            shape="circle"
+            source={assets.ltc.imageUrl}
+            style={{ width: '100%', height: '100%' }}
+          />
+        </Box>
+      }
+      weight="thin"
+    />
+    <ProgressCircle
+      progress={0.5}
+      size={56}
+      styles={{
+        progress: {
+          stroke: assets.dai.color,
+        },
+      }}
+      contentNode={
+        <Box height="100%" padding={0.25} width="100%">
+          <RemoteImage
+            shape="circle"
+            source={assets.dai.imageUrl}
+            style={{ width: '100%', height: '100%' }}
+          />
+        </Box>
+      }
+      weight="thin"
+    />
+    <ProgressCircle
+      progress={0.25}
+      size={56}
+      styles={{
+        progress: {
+          stroke: assets.sushi.color,
+        },
+      }}
+      contentNode={
+        <Box height="100%" padding={0.25} width="100%">
+          <RemoteImage
+            alt={assets.sushi.name}
+            shape="circle"
+            source={assets.sushi.imageUrl}
+            style={{ width: '100%', height: '100%' }}
+          />
+        </Box>
+      }
+      weight="thin"
+    />
+    <ProgressCircle
+      progress={0}
+      size={56}
+      styles={{
+        progress: {
+          stroke: assets.xrp.color,
+        },
+      }}
+      contentNode={
+        <Box height="100%" padding={0.25} width="100%">
+          <RemoteImage
+            alt={assets.xrp.name}
+            shape="circle"
+            source={assets.xrp.imageUrl}
+            style={{ width: '100%', height: '100%' }}
+          />
+        </Box>
+      }
+      weight="thin"
+    />
+  </HStack>
+  <HStack gap={2}>
+    <ProgressCircle
+      styles={{
+        progress: {
+          stroke: assets.btc.color,
+        },
+      }}
+      progress={0.24}
+      size={24}
+      contentNode={
+        <Box height="100%" padding={0.25} width="100%">
+          <RemoteImage
+            alt={assets.btc.name}
+            shape="circle"
+            source={assets.btc.imageUrl}
+            style={{ width: '100%', height: '100%' }}
+          />
+        </Box>
+      }
+      weight="thin"
+    />
+    <ProgressCircle
+      styles={{
+        progress: {
+          stroke: assets.btc.color,
+        },
+      }}
+      progress={0.24}
+      size={32}
+      contentNode={
+        <Box height="100%" padding={0.25} width="100%">
+          <RemoteImage
+            alt={assets.btc.name}
+            shape="circle"
+            source={assets.btc.imageUrl}
+            style={{ width: '100%', height: '100%' }}
+          />
+        </Box>
+      }
+      weight="thin"
+    />
+    <ProgressCircle
+      styles={{
+        progress: {
+          stroke: assets.btc.color,
+        },
+      }}
+      progress={0.24}
+      size={40}
+      contentNode={
+        <Box height="100%" padding={0.25} width="100%">
+          <RemoteImage
+            alt={assets.btc.name}
+            shape="circle"
+            source={assets.btc.imageUrl}
+            style={{ width: '100%', height: '100%' }}
+          />
+        </Box>
+      }
+      weight="thin"
+    />
+    <ProgressCircle
+      styles={{
+        progress: {
+          stroke: assets.btc.color,
+        },
+      }}
+      progress={0.24}
+      size={48}
+      contentNode={
+        <Box height="100%" padding={0.25} width="100%">
+          <RemoteImage
+            alt={assets.btc.name}
+            shape="circle"
+            source={assets.btc.imageUrl}
+            style={{ width: '100%', height: '100%' }}
+          />
+        </Box>
+      }
+      weight="thin"
+    />
+    <ProgressCircle
+      styles={{
+        progress: {
+          stroke: assets.btc.color,
+        },
+      }}
+      progress={0.24}
+      size={56}
+      contentNode={
+        <Box height="100%" padding={0.25} width="100%">
+          <RemoteImage
+            alt={assets.btc.name}
+            shape="circle"
+            source={assets.btc.imageUrl}
+            style={{ width: '100%', height: '100%' }}
+          />
+        </Box>
+      }
+      weight="thin"
+    />
+  </HStack>
+</VStack>
+```
+
+#### Custom Text Color
+
+The progress circle's default content can be customized to display a custom text color.
+
+```jsx live
+<HStack gap={2}>
+  <ProgressCircle
+    color="fgPrimary"
+    progress={0.2}
+    size={100}
+    contentNode={<DefaultProgressCircleContent color="fgPrimary" progress={0.2} />}
+  />
+  <ProgressCircle
+    color="fgPositive"
+    progress={0.4}
+    size={100}
+    contentNode={<DefaultProgressCircleContent color="fgPositive" progress={0.4} />}
+  />
+</HStack>
+```
+
+### Custom Styles
+
+The progress circle can be customized with styles and class names.
+
+```jsx live
+<HStack gap={2}>
+  <ProgressCircle
+    progress={0.4}
+    size={100}
+    styles={{
+      circle: {
+        stroke: 'transparent',
+      },
+    }}
+    contentNode={<TextTitle1 color="fgPrimary">40%</TextTitle1>}
+    weight="semiheavy"
+  />
+  <ProgressCircle
+    color="fgPositive"
+    progress={0.6}
+    size={100}
+    styles={{
+      progress: {
+        strokeLinecap: 'square',
+      },
+    }}
+    contentNode={<Icon color="fgPositive" name="circleCheckmark" size="l" />}
+  />
+</HStack>
+```
+
+### Interactive Demo
+
+This is for demo purposes. ProgressContainerWithButtons isn't designed for production usage.
+
+```jsx live
+<ProgressContainerWithButtons>
+  {({ calculateProgress }) => (
+    <HStack gap={2}>
+      <ProgressCircle progress={calculateProgress(0)} size={100} />
+      <ProgressCircle progress={calculateProgress(0.2)} size={100} />
+    </HStack>
+  )}
+</ProgressContainerWithButtons>
+```
+
+### Animation Callbacks
+
+You can use the `onAnimationStart` and `onAnimationEnd` callbacks to track the progress of the animation.
+
+```jsx live
+function Example() {
+  const [animationStatus, setAnimationStatus] = React.useState('Ready');
+
+  const handleAnimationStart = useCallback(() => {
+    setAnimationStatus('Animating...');
+  }, []);
+
+  const handleAnimationEnd = useCallback(() => {
+    setAnimationStatus('Animation Ended');
+  }, []);
+
+  return (
+    <ProgressContainerWithButtons>
+      {({ calculateProgress }) => (
+        <VStack gap={2}>
+          <Text>Animation Status: {animationStatus}</Text>
+          <ProgressCircle
+            onAnimationEnd={handleAnimationEnd}
+            onAnimationStart={handleAnimationStart}
+            progress={calculateProgress(0.2)}
+            size={100}
+          />
+        </VStack>
+      )}
+    </ProgressContainerWithButtons>
+  );
+}
+```
+
+