@coinbase/cds-mcp-server 8.21.8 → 8.22.2
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 +12 -0
- package/mcp-docs/mobile/components/AreaChart.txt +39 -37
- package/mcp-docs/mobile/components/Avatar.txt +18 -18
- package/mcp-docs/mobile/components/AvatarButton.txt +19 -19
- package/mcp-docs/mobile/components/Banner.txt +62 -23
- package/mcp-docs/mobile/components/BarChart.txt +37 -35
- package/mcp-docs/mobile/components/Box.txt +18 -18
- package/mcp-docs/mobile/components/BrowserBar.txt +18 -18
- package/mcp-docs/mobile/components/Button.txt +19 -19
- package/mcp-docs/mobile/components/Carousel.txt +18 -18
- package/mcp-docs/mobile/components/CartesianChart.txt +75 -44
- package/mcp-docs/mobile/components/CheckboxCell.txt +19 -19
- package/mcp-docs/mobile/components/Chip.txt +20 -20
- package/mcp-docs/mobile/components/Coachmark.txt +18 -18
- package/mcp-docs/mobile/components/ContentCard.txt +18 -18
- package/mcp-docs/mobile/components/ContentCardBody.txt +18 -18
- package/mcp-docs/mobile/components/ContentCardFooter.txt +18 -18
- package/mcp-docs/mobile/components/ContentCardHeader.txt +18 -18
- package/mcp-docs/mobile/components/ContentCell.txt +18 -18
- package/mcp-docs/mobile/components/ControlGroup.txt +18 -18
- package/mcp-docs/mobile/components/DatePicker.txt +1 -1
- package/mcp-docs/mobile/components/Divider.txt +18 -18
- package/mcp-docs/mobile/components/DotCount.txt +1 -1
- package/mcp-docs/mobile/components/DotSymbol.txt +2 -2
- package/mcp-docs/mobile/components/Fallback.txt +18 -18
- package/mcp-docs/mobile/components/HStack.txt +18 -18
- package/mcp-docs/mobile/components/Icon.txt +6 -0
- package/mcp-docs/mobile/components/IconButton.txt +19 -19
- package/mcp-docs/mobile/components/InputChip.txt +20 -20
- package/mcp-docs/mobile/components/Interactable.txt +19 -19
- package/mcp-docs/mobile/components/LineChart.txt +1608 -898
- package/mcp-docs/mobile/components/Link.txt +18 -18
- package/mcp-docs/mobile/components/ListCell.txt +37 -19
- package/mcp-docs/mobile/components/Lottie.txt +18 -18
- package/mcp-docs/mobile/components/MediaChip.txt +20 -20
- package/mcp-docs/mobile/components/MultiContentModule.txt +18 -18
- package/mcp-docs/mobile/components/NavigationTitle.txt +18 -18
- package/mcp-docs/mobile/components/NavigationTitleSelect.txt +18 -18
- package/mcp-docs/mobile/components/Numpad.txt +18 -18
- package/mcp-docs/mobile/components/Overlay.txt +18 -18
- package/mcp-docs/mobile/components/PageFooter.txt +17 -17
- package/mcp-docs/mobile/components/PageHeader.txt +17 -17
- package/mcp-docs/mobile/components/PeriodSelector.txt +26 -26
- package/mcp-docs/mobile/components/Point.txt +203 -98
- package/mcp-docs/mobile/components/Pressable.txt +19 -19
- package/mcp-docs/mobile/components/ProgressBar.txt +1 -1
- package/mcp-docs/mobile/components/ProgressBarWithFixedLabels.txt +1 -1
- package/mcp-docs/mobile/components/ProgressBarWithFloatLabel.txt +1 -1
- package/mcp-docs/mobile/components/ProgressCircle.txt +1 -1
- package/mcp-docs/mobile/components/RadioCell.txt +19 -19
- package/mcp-docs/mobile/components/ReferenceLine.txt +197 -54
- package/mcp-docs/mobile/components/RollingNumber.txt +18 -18
- package/mcp-docs/mobile/components/Scrubber.txt +597 -79
- package/mcp-docs/mobile/components/SegmentedTabs.txt +18 -18
- package/mcp-docs/mobile/components/SelectAlpha.txt +1 -1
- package/mcp-docs/mobile/components/SelectChip.txt +20 -20
- package/mcp-docs/mobile/components/SlideButton.txt +19 -19
- package/mcp-docs/mobile/components/Spacer.txt +6 -6
- package/mcp-docs/mobile/components/SparklineInteractive.txt +3 -3
- package/mcp-docs/mobile/components/Spinner.txt +1 -1
- package/mcp-docs/mobile/components/Stepper.txt +18 -18
- package/mcp-docs/mobile/components/TabLabel.txt +18 -18
- package/mcp-docs/mobile/components/TabNavigation.txt +18 -18
- package/mcp-docs/mobile/components/TabbedChips.txt +18 -18
- package/mcp-docs/mobile/components/TabbedChipsAlpha.txt +1 -1
- package/mcp-docs/mobile/components/Tabs.txt +18 -18
- package/mcp-docs/mobile/components/Tag.txt +18 -18
- package/mcp-docs/mobile/components/Text.txt +18 -18
- package/mcp-docs/mobile/components/Toast.txt +18 -18
- package/mcp-docs/mobile/components/Tooltip.txt +17 -1
- package/mcp-docs/mobile/components/TopNavBar.txt +18 -18
- package/mcp-docs/mobile/components/VStack.txt +18 -18
- package/mcp-docs/mobile/components/XAxis.txt +86 -24
- package/mcp-docs/mobile/components/YAxis.txt +75 -17
- package/mcp-docs/mobile/routes.txt +1 -1
- package/mcp-docs/web/components/AreaChart.txt +523 -301
- package/mcp-docs/web/components/Avatar.txt +27 -27
- package/mcp-docs/web/components/AvatarButton.txt +28 -28
- package/mcp-docs/web/components/Banner.txt +71 -32
- package/mcp-docs/web/components/BarChart.txt +182 -313
- package/mcp-docs/web/components/Box.txt +28 -28
- package/mcp-docs/web/components/Button.txt +28 -28
- package/mcp-docs/web/components/Calendar.txt +27 -27
- package/mcp-docs/web/components/Carousel.txt +27 -27
- package/mcp-docs/web/components/CartesianChart.txt +62 -309
- package/mcp-docs/web/components/CheckboxCell.txt +25 -25
- package/mcp-docs/web/components/Chip.txt +27 -27
- package/mcp-docs/web/components/Coachmark.txt +27 -27
- package/mcp-docs/web/components/ContainedAssetCard.txt +27 -27
- package/mcp-docs/web/components/ContentCard.txt +28 -28
- package/mcp-docs/web/components/ContentCardBody.txt +28 -28
- package/mcp-docs/web/components/ContentCardFooter.txt +28 -28
- package/mcp-docs/web/components/ContentCardHeader.txt +28 -28
- package/mcp-docs/web/components/ContentCell.txt +28 -28
- package/mcp-docs/web/components/ControlGroup.txt +27 -27
- package/mcp-docs/web/components/Divider.txt +27 -27
- package/mcp-docs/web/components/Fallback.txt +28 -28
- package/mcp-docs/web/components/FloatingAssetCard.txt +27 -27
- package/mcp-docs/web/components/Grid.txt +28 -28
- package/mcp-docs/web/components/GridColumn.txt +27 -27
- package/mcp-docs/web/components/HStack.txt +28 -28
- package/mcp-docs/web/components/Icon.txt +27 -27
- package/mcp-docs/web/components/IconButton.txt +28 -28
- package/mcp-docs/web/components/InputChip.txt +27 -27
- package/mcp-docs/web/components/Interactable.txt +28 -28
- package/mcp-docs/web/components/LineChart.txt +1598 -1116
- package/mcp-docs/web/components/Link.txt +28 -28
- package/mcp-docs/web/components/ListCell.txt +48 -30
- package/mcp-docs/web/components/Lottie.txt +27 -27
- package/mcp-docs/web/components/MediaChip.txt +27 -27
- package/mcp-docs/web/components/Modal.txt +27 -27
- package/mcp-docs/web/components/ModalBody.txt +27 -27
- package/mcp-docs/web/components/ModalFooter.txt +27 -27
- package/mcp-docs/web/components/ModalHeader.txt +27 -27
- package/mcp-docs/web/components/MultiContentModule.txt +28 -28
- package/mcp-docs/web/components/NavigationBar.txt +5 -5
- package/mcp-docs/web/components/NudgeCard.txt +27 -27
- package/mcp-docs/web/components/Overlay.txt +27 -27
- package/mcp-docs/web/components/PageFooter.txt +26 -26
- package/mcp-docs/web/components/PageHeader.txt +26 -26
- package/mcp-docs/web/components/Pagination.txt +27 -27
- package/mcp-docs/web/components/PeriodSelector.txt +49 -49
- package/mcp-docs/web/components/Point.txt +228 -79
- package/mcp-docs/web/components/Pressable.txt +28 -28
- package/mcp-docs/web/components/RadioCell.txt +25 -25
- package/mcp-docs/web/components/ReferenceLine.txt +208 -60
- package/mcp-docs/web/components/RemoteImage.txt +26 -26
- package/mcp-docs/web/components/RollingNumber.txt +28 -28
- package/mcp-docs/web/components/Scrubber.txt +463 -68
- package/mcp-docs/web/components/SectionHeader.txt +27 -27
- package/mcp-docs/web/components/SegmentedTabs.txt +27 -27
- package/mcp-docs/web/components/SelectChip.txt +27 -27
- package/mcp-docs/web/components/SelectOption.txt +27 -27
- package/mcp-docs/web/components/Sidebar.txt +27 -27
- package/mcp-docs/web/components/SidebarItem.txt +27 -27
- package/mcp-docs/web/components/Spacer.txt +34 -34
- package/mcp-docs/web/components/SparklineInteractive.txt +1 -1
- package/mcp-docs/web/components/Spinner.txt +27 -27
- package/mcp-docs/web/components/Stepper.txt +27 -27
- package/mcp-docs/web/components/TabLabel.txt +27 -27
- package/mcp-docs/web/components/TabNavigation.txt +26 -26
- package/mcp-docs/web/components/TabbedChips.txt +26 -26
- package/mcp-docs/web/components/TabbedChipsAlpha.txt +1 -1
- package/mcp-docs/web/components/Tabs.txt +27 -27
- package/mcp-docs/web/components/Tag.txt +27 -27
- package/mcp-docs/web/components/Text.txt +28 -28
- package/mcp-docs/web/components/TileButton.txt +28 -28
- package/mcp-docs/web/components/Toast.txt +27 -27
- package/mcp-docs/web/components/Tooltip.txt +17 -1
- package/mcp-docs/web/components/VStack.txt +28 -28
- package/mcp-docs/web/components/XAxis.txt +86 -22
- package/mcp-docs/web/components/YAxis.txt +133 -89
- package/package.json +1 -1
|
@@ -99,7 +99,7 @@ function CustomRadioCellExample() {
|
|
|
99
99
|
| `alignItems` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
100
100
|
| `alignSelf` | `ResponsiveProp<center \| normal \| auto \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
101
101
|
| `as` | `label` | No | `-` | - |
|
|
102
|
-
| `aspectRatio` |
|
|
102
|
+
| `aspectRatio` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
103
103
|
| `background` | `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 of the overlay (element being interacted with). |
|
|
104
104
|
| `blendStyles` | `InteractableBlendStyles` | No | `-` | - |
|
|
105
105
|
| `block` | `boolean` | No | `-` | Set element to block and expand to 100% width. |
|
|
@@ -135,28 +135,28 @@ function CustomRadioCellExample() {
|
|
|
135
135
|
| `elevation` | `0 \| 1 \| 2` | No | `-` | - |
|
|
136
136
|
| `flexBasis` | `ResponsiveProp<FlexBasis<string \| number>>` | No | `-` | - |
|
|
137
137
|
| `flexDirection` | `ResponsiveProp<column \| row \| row-reverse \| column-reverse>` | No | `-` | - |
|
|
138
|
-
| `flexGrow` |
|
|
139
|
-
| `flexShrink` |
|
|
138
|
+
| `flexGrow` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
139
|
+
| `flexShrink` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
140
140
|
| `flexWrap` | `ResponsiveProp<nowrap \| wrap \| wrap-reverse>` | No | `-` | - |
|
|
141
141
|
| `focusable` | `boolean` | No | `-` | - |
|
|
142
142
|
| `font` | `ResponsiveProp<FontFamily \| inherit>` | No | `-` | - |
|
|
143
143
|
| `fontFamily` | `ResponsiveProp<FontFamily \| inherit>` | No | `-` | - |
|
|
144
144
|
| `fontSize` | `ResponsiveProp<FontSize \| inherit>` | No | `-` | - |
|
|
145
145
|
| `fontWeight` | `ResponsiveProp<FontWeight \| inherit>` | No | `-` | - |
|
|
146
|
-
| `gap` | `0 \|
|
|
147
|
-
| `grid` |
|
|
148
|
-
| `gridArea` |
|
|
146
|
+
| `gap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
147
|
+
| `grid` | `inherit \| none \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
148
|
+
| `gridArea` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
149
149
|
| `gridAutoColumns` | `ResponsiveProp<GridAutoColumns<string \| number>>` | No | `-` | - |
|
|
150
|
-
| `gridAutoFlow` |
|
|
150
|
+
| `gridAutoFlow` | `inherit \| revert \| row \| column \| -moz-initial \| initial \| revert-layer \| unset \| dense` | No | `-` | - |
|
|
151
151
|
| `gridAutoRows` | `ResponsiveProp<GridAutoRows<string \| number>>` | No | `-` | - |
|
|
152
|
-
| `gridColumn` |
|
|
153
|
-
| `gridColumnEnd` |
|
|
154
|
-
| `gridColumnStart` |
|
|
155
|
-
| `gridRow` |
|
|
156
|
-
| `gridRowEnd` |
|
|
157
|
-
| `gridRowStart` |
|
|
158
|
-
| `gridTemplate` |
|
|
159
|
-
| `gridTemplateAreas` |
|
|
152
|
+
| `gridColumn` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
153
|
+
| `gridColumnEnd` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
154
|
+
| `gridColumnStart` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
155
|
+
| `gridRow` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
156
|
+
| `gridRowEnd` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
157
|
+
| `gridRowStart` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
158
|
+
| `gridTemplate` | `inherit \| none \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
159
|
+
| `gridTemplateAreas` | `inherit \| none \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
160
160
|
| `gridTemplateColumns` | `ResponsiveProp<GridTemplateColumns<string \| number>>` | No | `-` | - |
|
|
161
161
|
| `gridTemplateRows` | `ResponsiveProp<GridTemplateRows<string \| number>>` | No | `-` | - |
|
|
162
162
|
| `height` | `((Height<string \| number> \| { base?: Height<string \| number>; phone?: Height<string \| number> \| undefined; tablet?: Height<string \| number> \| undefined; desktop?: Height<string \| number> \| undefined; }) & (string \| number)) \| undefined` | No | `-` | - |
|
|
@@ -179,15 +179,15 @@ function CustomRadioCellExample() {
|
|
|
179
179
|
| `minWidth` | `ResponsiveProp<MinWidth<string \| number>>` | No | `-` | - |
|
|
180
180
|
| `noScaleOnPress` | `boolean` | No | `-` | Dont scale element on press. |
|
|
181
181
|
| `onChange` | `((inputChangeEvent: ChangeEvent<HTMLInputElement>) => void)` | No | `-` | - |
|
|
182
|
-
| `opacity` |
|
|
182
|
+
| `opacity` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
183
183
|
| `overflow` | `ResponsiveProp<hidden \| auto \| visible \| clip \| scroll>` | No | `-` | - |
|
|
184
|
-
| `padding` | `0 \|
|
|
185
|
-
| `paddingBottom` | `0 \|
|
|
186
|
-
| `paddingEnd` | `0 \|
|
|
187
|
-
| `paddingStart` | `0 \|
|
|
188
|
-
| `paddingTop` | `0 \|
|
|
189
|
-
| `paddingX` | `0 \|
|
|
190
|
-
| `paddingY` | `0 \|
|
|
184
|
+
| `padding` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
185
|
+
| `paddingBottom` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
186
|
+
| `paddingEnd` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
187
|
+
| `paddingStart` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
188
|
+
| `paddingTop` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
189
|
+
| `paddingX` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
190
|
+
| `paddingY` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
191
191
|
| `pin` | `top \| bottom \| left \| right \| all` | No | `-` | Direction in which to absolutely pin the box. |
|
|
192
192
|
| `position` | `ResponsiveProp<fixed \| static \| relative \| absolute \| sticky>` | No | `-` | - |
|
|
193
193
|
| `pressed` | `boolean` | No | `-` | Is the element being pressed. Primarily a mobile feature, but can be used on the web. |
|
|
@@ -202,7 +202,7 @@ function CustomRadioCellExample() {
|
|
|
202
202
|
| `textTransform` | `ResponsiveProp<capitalize \| lowercase \| none \| uppercase>` | No | `-` | - |
|
|
203
203
|
| `titleId` | `string` | No | `-` | Custom ID for the title element. If not provided, a unique ID will be generated. |
|
|
204
204
|
| `top` | `ResponsiveProp<Top<string \| number>>` | No | `-` | - |
|
|
205
|
-
| `transform` |
|
|
205
|
+
| `transform` | `inherit \| none \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
206
206
|
| `transparentWhileInactive` | `boolean` | No | `-` | Mark the background and border as transparent until the element is interacted with (hovered, pressed, etc). Must be used in conjunction with the pressed prop |
|
|
207
207
|
| `transparentWhilePressed` | `boolean` | No | `-` | Mark the background and border as transparent even while element is interacted with (elevation underlay issue). Must be used in conjunction with the pressed prop |
|
|
208
208
|
| `type` | `number \| color \| button \| search \| time \| image \| text \| hidden \| string & {} \| email \| checkbox \| radio \| tel \| url \| date \| submit \| reset \| datetime-local \| file \| month \| password \| range \| week` | No | `-` | - |
|
|
@@ -210,6 +210,6 @@ function CustomRadioCellExample() {
|
|
|
210
210
|
| `value` | `string` | No | `-` | Value of the option. Useful for multiple choice. |
|
|
211
211
|
| `visibility` | `ResponsiveProp<hidden \| visible>` | No | `-` | - |
|
|
212
212
|
| `width` | `((Width<string \| number> \| { base?: Width<string \| number>; phone?: Width<string \| number> \| undefined; tablet?: Width<string \| number> \| undefined; desktop?: Width<string \| number> \| undefined; }) & (string \| number)) \| undefined` | No | `-` | - |
|
|
213
|
-
| `zIndex` |
|
|
213
|
+
| `zIndex` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
214
214
|
|
|
215
215
|
|
|
@@ -10,9 +10,37 @@ import { ReferenceLine } from '@coinbase/cds-web-visualization'
|
|
|
10
10
|
|
|
11
11
|
## Examples
|
|
12
12
|
|
|
13
|
-
###
|
|
13
|
+
### Basics
|
|
14
14
|
|
|
15
|
-
ReferenceLine can be used to add important details to a chart, such as a reference price or date.
|
|
15
|
+
ReferenceLine can be used to add important details to a chart, such as a reference price or date. You can create horizontal lines using `dataY` or vertical lines using `dataX`.
|
|
16
|
+
|
|
17
|
+
#### Simple Reference Line
|
|
18
|
+
|
|
19
|
+
A minimal reference line without labels, useful for marking key thresholds:
|
|
20
|
+
|
|
21
|
+
```jsx live
|
|
22
|
+
<LineChart
|
|
23
|
+
showArea
|
|
24
|
+
height={{ base: 150, tablet: 200, desktop: 250 }}
|
|
25
|
+
series={[
|
|
26
|
+
{
|
|
27
|
+
id: 'prices',
|
|
28
|
+
data: [10, 22, 29, 45, 98, 45, 22, 52, 21, 4, 68, 20, 21, 58],
|
|
29
|
+
color: 'var(--color-fgPositive)',
|
|
30
|
+
},
|
|
31
|
+
]}
|
|
32
|
+
>
|
|
33
|
+
<ReferenceLine
|
|
34
|
+
LineComponent={(props) => <DottedLine {...props} strokeDasharray="0 16" strokeWidth={3} />}
|
|
35
|
+
dataY={10}
|
|
36
|
+
stroke="var(--color-fg)"
|
|
37
|
+
/>
|
|
38
|
+
</LineChart>
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
#### With Labels
|
|
42
|
+
|
|
43
|
+
You can add text labels to reference lines and position them using alignment and offset props:
|
|
16
44
|
|
|
17
45
|
```jsx live
|
|
18
46
|
<LineChart
|
|
@@ -24,18 +52,20 @@ ReferenceLine can be used to add important details to a chart, such as a referen
|
|
|
24
52
|
},
|
|
25
53
|
]}
|
|
26
54
|
inset={0}
|
|
27
|
-
curve="monotone"
|
|
28
55
|
showArea
|
|
29
56
|
>
|
|
30
57
|
<ReferenceLine
|
|
31
58
|
dataX={5}
|
|
32
59
|
label="Vertical Reference Line"
|
|
33
|
-
|
|
60
|
+
labelDx={8}
|
|
61
|
+
labelHorizontalAlignment="left"
|
|
34
62
|
/>
|
|
35
63
|
<ReferenceLine
|
|
36
64
|
dataY={50}
|
|
37
65
|
label="Horizontal Reference Line"
|
|
38
|
-
|
|
66
|
+
labelDy={-8}
|
|
67
|
+
labelHorizontalAlignment="right"
|
|
68
|
+
labelVerticalAlignment="bottom"
|
|
39
69
|
/>
|
|
40
70
|
</LineChart>
|
|
41
71
|
```
|
|
@@ -62,70 +92,163 @@ ReferenceLine relies on `dataX` or `dataY` to position the line. Passing in `dat
|
|
|
62
92
|
<ReferenceLine
|
|
63
93
|
dataY={10000}
|
|
64
94
|
label="10,000"
|
|
95
|
+
labelDy={-4}
|
|
65
96
|
labelPosition="left"
|
|
66
|
-
|
|
97
|
+
labelVerticalAlignment="bottom"
|
|
67
98
|
/>
|
|
68
99
|
<ReferenceLine
|
|
69
100
|
dataY={100000}
|
|
70
101
|
label="100,000"
|
|
102
|
+
labelDy={-4}
|
|
71
103
|
labelPosition="left"
|
|
72
|
-
|
|
104
|
+
labelVerticalAlignment="bottom"
|
|
73
105
|
/>
|
|
74
106
|
</LineChart>
|
|
75
107
|
```
|
|
76
108
|
|
|
77
|
-
###
|
|
109
|
+
### Labels
|
|
78
110
|
|
|
79
|
-
####
|
|
111
|
+
#### Customization
|
|
80
112
|
|
|
81
|
-
You can
|
|
113
|
+
You can customize label appearance using `labelFont`, `labelDx`, `labelDy`, `labelHorizontalAlignment`, and `labelVerticalAlignment` props.
|
|
82
114
|
|
|
83
115
|
```jsx live
|
|
84
116
|
<LineChart
|
|
85
|
-
|
|
86
|
-
height={{ base: 150, tablet: 200, desktop: 250 }}
|
|
87
|
-
inset={{ right: 4 }}
|
|
117
|
+
height={150}
|
|
88
118
|
series={[
|
|
89
119
|
{
|
|
90
120
|
id: 'prices',
|
|
91
121
|
data: [10, 22, 29, 45, 98, 45, 22, 52, 21, 4, 68, 20, 21, 58],
|
|
92
122
|
},
|
|
93
123
|
]}
|
|
124
|
+
showArea
|
|
94
125
|
>
|
|
95
126
|
<ReferenceLine
|
|
96
|
-
dataY={
|
|
97
|
-
label="
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
inset: { top: 4, bottom: 4, left: 8, right: 8 },
|
|
104
|
-
color: 'rgb(var(--yellow70))',
|
|
105
|
-
background: 'var(--color-accentSubtleYellow)',
|
|
106
|
-
font: 'label1',
|
|
107
|
-
}}
|
|
108
|
-
stroke="var(--color-bgWarning)"
|
|
127
|
+
dataY={50}
|
|
128
|
+
label="Target Price"
|
|
129
|
+
labelDy={-8}
|
|
130
|
+
labelFont="legal"
|
|
131
|
+
labelHorizontalAlignment="right"
|
|
132
|
+
labelPosition="right"
|
|
133
|
+
labelVerticalAlignment="bottom"
|
|
109
134
|
/>
|
|
110
135
|
<ReferenceLine
|
|
111
|
-
|
|
112
|
-
label="
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
borderRadius: 4,
|
|
118
|
-
inset: { top: 2, bottom: 2, left: 4, right: 4 },
|
|
119
|
-
color: 'rgb(var(--yellow70))',
|
|
120
|
-
background: 'var(--color-bg)',
|
|
121
|
-
font: 'label1',
|
|
122
|
-
}}
|
|
123
|
-
stroke="transparent"
|
|
136
|
+
dataX={7}
|
|
137
|
+
label="Midpoint"
|
|
138
|
+
labelDx={8}
|
|
139
|
+
labelFont="label1"
|
|
140
|
+
labelHorizontalAlignment="left"
|
|
141
|
+
labelPosition="top"
|
|
124
142
|
/>
|
|
125
143
|
</LineChart>
|
|
126
144
|
```
|
|
127
145
|
|
|
128
|
-
####
|
|
146
|
+
#### Bounds
|
|
147
|
+
|
|
148
|
+
Use `labelBoundsInset` to prevent labels from getting too close to chart edges.
|
|
149
|
+
|
|
150
|
+
```jsx live
|
|
151
|
+
<Box style={{ marginLeft: 'calc(-1 * var(--space-3))', marginRight: 'calc(-1 * var(--space-3))' }}>
|
|
152
|
+
<LineChart
|
|
153
|
+
height={{ base: 150, tablet: 200, desktop: 250 }}
|
|
154
|
+
inset={{ left: 0, right: 0 }}
|
|
155
|
+
series={[
|
|
156
|
+
{
|
|
157
|
+
id: 'prices',
|
|
158
|
+
data: [10, 22, 29, 45, 98, 45, 22, 52, 21, 4, 68, 20, 21, 58],
|
|
159
|
+
},
|
|
160
|
+
]}
|
|
161
|
+
showArea
|
|
162
|
+
>
|
|
163
|
+
<ReferenceLine
|
|
164
|
+
dataX={0}
|
|
165
|
+
label="No Bounds Inset"
|
|
166
|
+
labelBoundsInset={0}
|
|
167
|
+
labelDy={0}
|
|
168
|
+
labelPosition="top"
|
|
169
|
+
/>
|
|
170
|
+
<ReferenceLine
|
|
171
|
+
dataX={13}
|
|
172
|
+
label="12px Bounds Inset"
|
|
173
|
+
labelBoundsInset={{ left: 12, right: 12 }}
|
|
174
|
+
labelDy={0}
|
|
175
|
+
labelPosition="top"
|
|
176
|
+
/>
|
|
177
|
+
</LineChart>
|
|
178
|
+
</Box>
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
#### Custom Component
|
|
182
|
+
|
|
183
|
+
You can adjust the style of the label using a custom `LabelComponent`.
|
|
184
|
+
|
|
185
|
+
```jsx live
|
|
186
|
+
function LabelStyleExample() {
|
|
187
|
+
const LiquidationLabel = useMemo(
|
|
188
|
+
() =>
|
|
189
|
+
memo((props) => (
|
|
190
|
+
<DefaultReferenceLineLabel
|
|
191
|
+
{...props}
|
|
192
|
+
background="var(--color-accentSubtleYellow)"
|
|
193
|
+
borderRadius={4}
|
|
194
|
+
color="rgb(var(--yellow70))"
|
|
195
|
+
dx={12}
|
|
196
|
+
font="label1"
|
|
197
|
+
horizontalAlignment="left"
|
|
198
|
+
inset={{ top: 4, bottom: 4, left: 8, right: 8 }}
|
|
199
|
+
/>
|
|
200
|
+
)),
|
|
201
|
+
[],
|
|
202
|
+
);
|
|
203
|
+
|
|
204
|
+
const PriceLabel = useMemo(
|
|
205
|
+
() =>
|
|
206
|
+
memo((props) => (
|
|
207
|
+
<DefaultReferenceLineLabel
|
|
208
|
+
{...props}
|
|
209
|
+
background="var(--color-bg)"
|
|
210
|
+
borderRadius={4}
|
|
211
|
+
color="rgb(var(--yellow70))"
|
|
212
|
+
dx={-12}
|
|
213
|
+
font="label1"
|
|
214
|
+
horizontalAlignment="right"
|
|
215
|
+
inset={{ top: 2, bottom: 2, left: 4, right: 4 }}
|
|
216
|
+
/>
|
|
217
|
+
)),
|
|
218
|
+
[],
|
|
219
|
+
);
|
|
220
|
+
|
|
221
|
+
return (
|
|
222
|
+
<LineChart
|
|
223
|
+
height={{ base: 150, tablet: 200, desktop: 250 }}
|
|
224
|
+
inset={{ right: 4 }}
|
|
225
|
+
series={[
|
|
226
|
+
{
|
|
227
|
+
id: 'prices',
|
|
228
|
+
data: [10, 22, 29, 45, 98, 45, 22, 52, 21, 4, 68, 20, 21, 58],
|
|
229
|
+
},
|
|
230
|
+
]}
|
|
231
|
+
>
|
|
232
|
+
<ReferenceLine
|
|
233
|
+
LabelComponent={LiquidationLabel}
|
|
234
|
+
dataY={25}
|
|
235
|
+
label="Liquidation"
|
|
236
|
+
labelPosition="left"
|
|
237
|
+
stroke="var(--color-bgWarning)"
|
|
238
|
+
/>
|
|
239
|
+
<ReferenceLine
|
|
240
|
+
LabelComponent={PriceLabel}
|
|
241
|
+
dataY={25}
|
|
242
|
+
label="$25"
|
|
243
|
+
labelPosition="right"
|
|
244
|
+
stroke="transparent"
|
|
245
|
+
/>
|
|
246
|
+
</LineChart>
|
|
247
|
+
);
|
|
248
|
+
}
|
|
249
|
+
```
|
|
250
|
+
|
|
251
|
+
### Draggable Price Target
|
|
129
252
|
|
|
130
253
|
You can pair a ReferenceLine with a custom drag component to create a draggable price target.
|
|
131
254
|
|
|
@@ -179,6 +302,21 @@ function DraggablePriceTarget() {
|
|
|
179
302
|
);
|
|
180
303
|
};
|
|
181
304
|
|
|
305
|
+
const DynamicPriceLabel = memo(
|
|
306
|
+
({ color, ...props }: React.ComponentProps<typeof DefaultReferenceLineLabel> & { color: string }) => (
|
|
307
|
+
<DefaultReferenceLineLabel
|
|
308
|
+
{...props}
|
|
309
|
+
background={color}
|
|
310
|
+
borderRadius={4}
|
|
311
|
+
color="white"
|
|
312
|
+
dx={-12}
|
|
313
|
+
font="label1"
|
|
314
|
+
horizontalAlignment="right"
|
|
315
|
+
inset={{ top: 5, bottom: 5, left: 10, right: 10 }}
|
|
316
|
+
/>
|
|
317
|
+
),
|
|
318
|
+
);
|
|
319
|
+
|
|
182
320
|
const DraggableReferenceLine = memo(
|
|
183
321
|
({
|
|
184
322
|
baselineAmount,
|
|
@@ -207,6 +345,13 @@ function DraggablePriceTarget() {
|
|
|
207
345
|
|
|
208
346
|
const yScale = getYScale();
|
|
209
347
|
|
|
348
|
+
const labelComponent = useCallback(
|
|
349
|
+
(props: React.ComponentProps<typeof DefaultReferenceLineLabel>) => (
|
|
350
|
+
<DynamicPriceLabel {...props} color={color} />
|
|
351
|
+
),
|
|
352
|
+
[color],
|
|
353
|
+
);
|
|
354
|
+
|
|
210
355
|
// Set up persistent event listeners on the chart SVG element
|
|
211
356
|
useEffect(() => {
|
|
212
357
|
const element = chartRef.current;
|
|
@@ -322,18 +467,10 @@ function DraggablePriceTarget() {
|
|
|
322
467
|
return (
|
|
323
468
|
<>
|
|
324
469
|
<ReferenceLine
|
|
470
|
+
LabelComponent={labelComponent}
|
|
325
471
|
dataY={amount}
|
|
326
472
|
label={dollarLabel}
|
|
327
473
|
labelPosition="right"
|
|
328
|
-
labelProps={{
|
|
329
|
-
background: color,
|
|
330
|
-
borderRadius: 4,
|
|
331
|
-
color: 'white',
|
|
332
|
-
dx: -12,
|
|
333
|
-
font: 'label1',
|
|
334
|
-
horizontalAlignment: 'right',
|
|
335
|
-
inset: { top: 5, bottom: 5, left: 10, right: 10 },
|
|
336
|
-
}}
|
|
337
474
|
/>
|
|
338
475
|
<g
|
|
339
476
|
onMouseDown={handleMouseDown}
|
|
@@ -377,6 +514,10 @@ function DraggablePriceTarget() {
|
|
|
377
514
|
},
|
|
378
515
|
);
|
|
379
516
|
|
|
517
|
+
const BaselinePriceLabel = useMemo(() => memo((props) => (
|
|
518
|
+
<DefaultReferenceLineLabel {...props} dx={8} horizontalAlignment="left" />
|
|
519
|
+
)), []);
|
|
520
|
+
|
|
380
521
|
const PriceTargetChart = () => {
|
|
381
522
|
const priceData = useMemo(() => sparklineInteractiveData.year.map((d) => d.value), []);
|
|
382
523
|
const { isPhone } = useBreakpoints();
|
|
@@ -395,7 +536,6 @@ function DraggablePriceTarget() {
|
|
|
395
536
|
ref={chartRef}
|
|
396
537
|
showArea
|
|
397
538
|
animate={false}
|
|
398
|
-
curve="monotone"
|
|
399
539
|
height={250}
|
|
400
540
|
inset={isPhone ? { top: 16, bottom: 16, left: 0, right: 0 } : { top: 16, bottom: 16, left: 8, right: 80 }}
|
|
401
541
|
series={[
|
|
@@ -409,10 +549,10 @@ function DraggablePriceTarget() {
|
|
|
409
549
|
>
|
|
410
550
|
{!isPhone && (
|
|
411
551
|
<ReferenceLine
|
|
552
|
+
LabelComponent={BaselinePriceLabel}
|
|
412
553
|
LineComponent={SolidLine}
|
|
413
554
|
dataY={priceData[priceData.length - 1]}
|
|
414
555
|
label={formatPrice(priceData[priceData.length - 1])}
|
|
415
|
-
labelProps={{ dx: 8, horizontalAlignment: 'left' }}
|
|
416
556
|
/>
|
|
417
557
|
)}
|
|
418
558
|
<DraggableReferenceLine
|
|
@@ -431,20 +571,28 @@ function DraggablePriceTarget() {
|
|
|
431
571
|
|
|
432
572
|
| Prop | Type | Required | Default | Description |
|
|
433
573
|
| --- | --- | --- | --- | --- |
|
|
434
|
-
| `BeaconComponent` | `
|
|
435
|
-
| `BeaconLabelComponent` | `
|
|
436
|
-
| `
|
|
574
|
+
| `BeaconComponent` | `ScrubberBeaconComponent` | No | `DefaultScrubberBeacon` | Custom component for the scrubber beacon. |
|
|
575
|
+
| `BeaconLabelComponent` | `ScrubberBeaconLabelComponent` | No | `DefaultScrubberBeaconLabel` | Custom component to render as a scrubber beacon label. |
|
|
576
|
+
| `LabelComponent` | `ReferenceLineLabelComponent` | No | `DefaultReferenceLineLabel` | Component to render the label. |
|
|
577
|
+
| `LineComponent` | `LineComponent` | No | `DottedLine` | Component to render the line. |
|
|
578
|
+
| `accessibilityLabel` | `string \| ((dataIndex: number) => string)` | No | `-` | Accessibility label for the scrubber. Can be a static string or a function that receives the current dataIndex. If not provided, label will be used if it resolves to a string. |
|
|
579
|
+
| `beaconLabelFont` | `ResponsiveProp<FontFamily \| inherit>` | No | `-` | Font style for the beacon labels. |
|
|
580
|
+
| `beaconLabelHorizontalOffset` | `number` | No | `-` | Horizontal offset for beacon labels from their beacon position. Measured in pixels. |
|
|
581
|
+
| `beaconLabelMinGap` | `number` | No | `-` | Minimum gap between beacon labels to prevent overlap. Measured in pixels. |
|
|
582
|
+
| `beaconTransitions` | `{ update?: Transition$1; pulse?: Transition$1 \| undefined; pulseRepeatDelay?: number \| undefined; } \| undefined` | No | `-` | Transition configuration for the scrubber beacon. |
|
|
437
583
|
| `classNames` | `{ overlay?: string; beacon?: string \| undefined; line?: string \| undefined; beaconLabel?: string \| undefined; } \| undefined` | No | `-` | Custom class names for scrubber elements. |
|
|
438
584
|
| `hideLine` | `boolean` | No | `-` | Hides the scrubber line |
|
|
439
|
-
| `hideOverlay` | `boolean` | No | `-` |
|
|
440
|
-
| `idlePulse` | `boolean` | No | `-` | Pulse the
|
|
585
|
+
| `hideOverlay` | `boolean` | No | `-` | Hides the overlay rect which obscures data beyond the scrubber position. |
|
|
586
|
+
| `idlePulse` | `boolean` | No | `-` | Pulse the beacons while at rest. |
|
|
441
587
|
| `key` | `Key \| null` | No | `-` | - |
|
|
442
|
-
| `label` | `ChartTextChildren \| ((dataIndex: number) => ChartTextChildren)` | No | `-` | Label text displayed above the scrubber line. |
|
|
443
|
-
| `
|
|
588
|
+
| `label` | `ChartTextChildren \| ((dataIndex: number) => ChartTextChildren)` | No | `-` | Label text displayed above the scrubber line. Can be a static string or a function that receives the current dataIndex. |
|
|
589
|
+
| `labelBoundsInset` | `number \| ChartInset` | No | `{ top: 4, bottom: 20, left: 12, right: 12 } when labelElevated is true, otherwise none` | Bounds inset for the scrubber line label to prevent cutoff at chart edges. |
|
|
590
|
+
| `labelElevated` | `boolean` | No | `-` | Whether to elevate the label with a shadow. When true, applies elevation and automatically adds bounds to keep label within chart area. |
|
|
591
|
+
| `labelFont` | `ResponsiveProp<FontFamily \| inherit>` | No | `-` | Font style for the scrubber line label. |
|
|
444
592
|
| `lineStroke` | `string` | No | `-` | Stroke color for the scrubber line. |
|
|
445
593
|
| `overlayOffset` | `number` | No | `2` | Offset of the overlay rect relative to the drawing area. Useful for when scrubbing over lines, where the stroke width would cause part of the line to be visible. |
|
|
446
|
-
| `ref` | `((instance:
|
|
447
|
-
| `seriesIds` | `string[]` | No | `-` |
|
|
594
|
+
| `ref` | `((instance: ScrubberBeaconGroupRef \| null) => void) \| RefObject<ScrubberBeaconGroupRef> \| null` | No | `-` | - |
|
|
595
|
+
| `seriesIds` | `string[]` | No | `-` | Array of series IDs to highlight when scrubbing with scrubber beacons. By default, all series will be highlighted. |
|
|
448
596
|
| `styles` | `{ overlay?: CSSProperties; beacon?: CSSProperties \| undefined; line?: CSSProperties \| undefined; beaconLabel?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for scrubber elements. |
|
|
449
597
|
| `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 |
|
|
450
598
|
|
|
@@ -86,33 +86,33 @@ If no images are shown, RemoteImage will show a default Fallback. Be aware that
|
|
|
86
86
|
| `borderedVertical` | `boolean` | No | `-` | Add a border to the top and bottom sides of the box. |
|
|
87
87
|
| `bottom` | `ResponsiveProp<Bottom<string \| number>>` | No | `-` | - |
|
|
88
88
|
| `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 | `-` | - |
|
|
89
|
-
| `columnGap` | `0 \|
|
|
89
|
+
| `columnGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
90
90
|
| `dangerouslySetBackground` | `string` | No | `-` | - |
|
|
91
91
|
| `display` | `ResponsiveProp<grid \| revert \| none \| block \| inline \| inline-block \| flex \| inline-flex \| inline-grid \| contents \| flow-root \| list-item>` | No | `-` | - |
|
|
92
92
|
| `elevation` | `0 \| 1 \| 2` | No | `-` | - |
|
|
93
93
|
| `flexBasis` | `ResponsiveProp<FlexBasis<string \| number>>` | No | `-` | - |
|
|
94
94
|
| `flexDirection` | `ResponsiveProp<column \| row \| row-reverse \| column-reverse>` | No | `-` | - |
|
|
95
|
-
| `flexGrow` |
|
|
96
|
-
| `flexShrink` |
|
|
95
|
+
| `flexGrow` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
96
|
+
| `flexShrink` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
97
97
|
| `flexWrap` | `ResponsiveProp<nowrap \| wrap \| wrap-reverse>` | No | `-` | - |
|
|
98
98
|
| `font` | `ResponsiveProp<FontFamily \| inherit>` | No | `-` | - |
|
|
99
99
|
| `fontFamily` | `ResponsiveProp<FontFamily \| inherit>` | No | `-` | - |
|
|
100
100
|
| `fontSize` | `ResponsiveProp<FontSize \| inherit>` | No | `-` | - |
|
|
101
101
|
| `fontWeight` | `ResponsiveProp<FontWeight \| inherit>` | No | `-` | - |
|
|
102
|
-
| `gap` | `0 \|
|
|
103
|
-
| `grid` |
|
|
104
|
-
| `gridArea` |
|
|
102
|
+
| `gap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
103
|
+
| `grid` | `inherit \| none \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
104
|
+
| `gridArea` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
105
105
|
| `gridAutoColumns` | `ResponsiveProp<GridAutoColumns<string \| number>>` | No | `-` | - |
|
|
106
|
-
| `gridAutoFlow` |
|
|
106
|
+
| `gridAutoFlow` | `inherit \| revert \| row \| column \| -moz-initial \| initial \| revert-layer \| unset \| dense` | No | `-` | - |
|
|
107
107
|
| `gridAutoRows` | `ResponsiveProp<GridAutoRows<string \| number>>` | No | `-` | - |
|
|
108
|
-
| `gridColumn` |
|
|
109
|
-
| `gridColumnEnd` |
|
|
110
|
-
| `gridColumnStart` |
|
|
111
|
-
| `gridRow` |
|
|
112
|
-
| `gridRowEnd` |
|
|
113
|
-
| `gridRowStart` |
|
|
114
|
-
| `gridTemplate` |
|
|
115
|
-
| `gridTemplateAreas` |
|
|
108
|
+
| `gridColumn` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
109
|
+
| `gridColumnEnd` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
110
|
+
| `gridColumnStart` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
111
|
+
| `gridRow` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
112
|
+
| `gridRowEnd` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
113
|
+
| `gridRowStart` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
114
|
+
| `gridTemplate` | `inherit \| none \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
115
|
+
| `gridTemplateAreas` | `inherit \| none \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
116
116
|
| `gridTemplateColumns` | `ResponsiveProp<GridTemplateColumns<string \| number>>` | No | `-` | - |
|
|
117
117
|
| `gridTemplateRows` | `ResponsiveProp<GridTemplateRows<string \| number>>` | No | `-` | - |
|
|
118
118
|
| `height` | `ResponsiveProp<Height<string \| number>>` | No | `-` | - |
|
|
@@ -132,21 +132,21 @@ If no images are shown, RemoteImage will show a default Fallback. Be aware that
|
|
|
132
132
|
| `minHeight` | `ResponsiveProp<MinHeight<string \| number>>` | No | `-` | - |
|
|
133
133
|
| `minWidth` | `ResponsiveProp<MinWidth<string \| number>>` | No | `-` | - |
|
|
134
134
|
| `onChange` | `FormEventHandler<HTMLImageElement>` | No | `-` | - |
|
|
135
|
-
| `opacity` |
|
|
135
|
+
| `opacity` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
136
136
|
| `overflow` | `ResponsiveProp<hidden \| auto \| visible \| clip \| scroll>` | No | `-` | - |
|
|
137
|
-
| `padding` | `0 \|
|
|
138
|
-
| `paddingBottom` | `0 \|
|
|
139
|
-
| `paddingEnd` | `0 \|
|
|
140
|
-
| `paddingStart` | `0 \|
|
|
141
|
-
| `paddingTop` | `0 \|
|
|
142
|
-
| `paddingX` | `0 \|
|
|
143
|
-
| `paddingY` | `0 \|
|
|
137
|
+
| `padding` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
138
|
+
| `paddingBottom` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
139
|
+
| `paddingEnd` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
140
|
+
| `paddingStart` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
141
|
+
| `paddingTop` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
142
|
+
| `paddingX` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
143
|
+
| `paddingY` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
144
144
|
| `pin` | `top \| bottom \| left \| right \| all` | No | `-` | Direction in which to absolutely pin the box. |
|
|
145
145
|
| `position` | `ResponsiveProp<fixed \| static \| relative \| absolute \| sticky>` | No | `-` | - |
|
|
146
146
|
| `ref` | `((instance: HTMLImageElement \| null) => void) \| RefObject<HTMLImageElement> \| null` | No | `-` | - |
|
|
147
147
|
| `resizeMode` | `cover \| contain` | No | `-` | - |
|
|
148
148
|
| `right` | `ResponsiveProp<Right<string \| number>>` | No | `-` | - |
|
|
149
|
-
| `rowGap` | `0 \|
|
|
149
|
+
| `rowGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
150
150
|
| `shape` | `rectangle \| circle \| squircle \| square \| hexagon` | No | `square` | Shape of RemoteImage |
|
|
151
151
|
| `size` | `s \| l \| m \| xl \| xxl \| xxxl` | No | `m` | Size for a given RemoteImage. If width or height is not defined, it will set size = m as default |
|
|
152
152
|
| `source` | `string` | No | `-` | Absolute url to the image that should be shown in the RemoteImage. If no source is provided then a generic fallback image is used. |
|
|
@@ -156,10 +156,10 @@ If no images are shown, RemoteImage will show a default Fallback. Be aware that
|
|
|
156
156
|
| `textDecoration` | `ResponsiveProp<none \| underline \| overline \| line-through \| underline overline \| underline double>` | No | `-` | - |
|
|
157
157
|
| `textTransform` | `ResponsiveProp<capitalize \| lowercase \| none \| uppercase>` | No | `-` | - |
|
|
158
158
|
| `top` | `ResponsiveProp<Top<string \| number>>` | No | `-` | - |
|
|
159
|
-
| `transform` |
|
|
159
|
+
| `transform` | `inherit \| none \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
160
160
|
| `userSelect` | `ResponsiveProp<text \| none \| auto \| all>` | No | `-` | - |
|
|
161
161
|
| `visibility` | `ResponsiveProp<hidden \| visible>` | No | `-` | - |
|
|
162
162
|
| `width` | `ResponsiveProp<Width<string \| number>>` | No | `-` | - |
|
|
163
|
-
| `zIndex` |
|
|
163
|
+
| `zIndex` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
164
164
|
|
|
165
165
|
|