@czi-sds/mcp 0.16.0 → 0.18.0

package/data/component-props/Pagination.json

@@ -2,25 +2,53 @@
   "Pagination": {
     "props": {
       "pageSize": {
-        "type": "number",
-        "isRequired": true
+        "description": "Required. How many items fit on a page, which together with totalCount gives the number of pages. Must be at least 1; a smaller value throws.",
+        "isRequired": true,
+        "type": "number"
       },
       "sdsStyle": {
-        "type": "\"round\" | \"square\"",
-        "isRequired": false
+        "defaultValue": "round",
+        "description": "Whether the page and chevron targets are circles or rounded squares.",
+        "isRequired": false,
+        "type": "\"square\" | \"round\""
       },
       "siblingCount": {
-        "type": "number",
-        "isRequired": false
+        "defaultValue": 1,
+        "description": "How many page numbers to keep on each side of the current page before the rest collapse into an ellipsis.",
+        "isRequired": false,
+        "type": "number"
       },
       "totalCount": {
-        "type": "number",
-        "isRequired": true
+        "description": "Required. Total number of items being paged through: the whole set, not the current page.",
+        "isRequired": true,
+        "type": "number"
       },
       "truncateDropdown": {
-        "type": "\"false\" | \"true\"",
-        "isRequired": false
+        "defaultValue": true,
+        "description": "When true the ellipsis is a menu of the pages it stands for. When false it is a disabled placeholder, and those pages can only be reached by stepping through with the chevrons.",
+        "isRequired": false,
+        "type": "boolean"
+      },
+      "onPageChange": {
+        "description": "A callback function triggered when the page number is changed.",
+        "isRequired": true,
+        "type": "(page: number) => void"
+      },
+      "onNextPage": {
+        "description": "A callback function triggered when the \"Next\" page button is clicked.",
+        "isRequired": true,
+        "type": "() => void"
+      },
+      "onPreviousPage": {
+        "description": "A callback function triggered when the \"Previous\" page button is clicked.",
+        "isRequired": true,
+        "type": "() => void"
+      },
+      "currentPage": {
+        "description": "Required. The page to mark as current, counted from 1. Pagination keeps no page state of its own.",
+        "isRequired": true,
+        "type": "number"
       }
     }
   }
-}
+}

package/data/component-props/Panel.json

@@ -2,21 +2,74 @@
   "Panel": {
     "props": {
       "isBackdropClickEnabled": {
-        "type": "\"false\" | \"true\"",
-        "isRequired": false
+        "defaultValue": false,
+        "description": "Overlay only in practice. Adds an invisible backdrop so a click outside the panel reaches onClose. Left off, clicks pass through to the page.",
+        "isRequired": false,
+        "type": "boolean"
       },
       "position": {
-        "type": "\"bottom\" | \"left\" | \"right\"",
-        "isRequired": false
+        "defaultValue": "left",
+        "description": "Which edge the panel is attached to. A basic panel takes \"left\" or \"right\"; an overlay adds \"bottom\".",
+        "isRequired": false,
+        "type": "\"bottom\" | \"left\" | \"right\""
       },
       "sdsType": {
-        "type": "\"overlay\" | \"basic\"",
-        "isRequired": true
+        "defaultValue": "- (required)",
+        "description": "\"basic\" sits in the page and stays until you close it; \"overlay\" floats over the page with a header and close button. It also decides which of the props below apply, so TypeScript needs it spelled out even though the component falls back to \"basic\".",
+        "isRequired": true,
+        "type": "\"overlay\" | \"basic\""
+      },
+      "transitionDuration": {
+        "defaultValue": "{\nenter: theme.transitions.duration.enteringScreen,\nexit: theme.transitions.duration.leavingScreen,\n}",
+        "description": "The duration for the transition, in milliseconds.\nYou may specify a single timeout for all transitions, or individually with an object.",
+        "isRequired": false,
+        "type": "number | { appear?: number | undefined; enter?: number | undefined; exit?: number | undefined; }"
       },
       "width": {
-        "type": "\"string\" | \"number\"",
-        "isRequired": false
+        "defaultValue": "240 (basic) 320 (overlay)",
+        "description": "How wide the panel is, or how tall it is when positioned along the bottom. Numbers are read as pixels. Values below the default are ignored, since the panel keeps that as its minimum in both directions.",
+        "isRequired": false,
+        "type": "string | number"
+      },
+      "open": {
+        "defaultValue": false,
+        "description": "If `true`, the component is shown.",
+        "isRequired": false,
+        "type": "boolean"
+      },
+      "HeaderComponent": {
+        "description": "Overlay only. Fills the header bar beside the close button. Leave it out and the bar holds the close button alone.",
+        "isRequired": false,
+        "type": "ReactNode"
+      },
+      "closeButtonOnClick": {
+        "description": "Overlay only. Runs when the header's close control is clicked. Without it, the control does nothing.",
+        "isRequired": false,
+        "type": "function"
+      },
+      "CloseButtonComponent": {
+        "defaultValue": "<Button sdsStyle=minimal sdsType=secondary size=large backgroundOnHover={false} aria-label=Panel Toggle> <Icon sdsIcon=XMark sdsSize=l /> </Button>",
+        "description": "Overlay only. Replaces the close button. Clicks are handled by the wrapper around it, so it needs no handler of its own.",
+        "isRequired": false,
+        "type": "ReactNode"
+      },
+      "onClose": {
+        "description": "Callback fired when the component requests to be closed.\nThe `reason` parameter can optionally be used to control the response to `onClose`.\n@param event The event source of the callback.\n@param reason Can be: `\"escapeKeyDown\"`, `\"backdropClick\"`.",
+        "isRequired": false,
+        "type": "(event: {}, reason: \"backdropClick\" | \"escapeKeyDown\") => void"
+      },
+      "ModalProps": {
+        "defaultValue": {},
+        "description": "Props applied to the [`Modal`](https://mui.com/material-ui/api/modal/) element.",
+        "isRequired": false,
+        "type": "Partial<ModalProps>"
+      },
+      "slotProps": {
+        "defaultValue": {},
+        "description": "The props used for each slot inside.",
+        "isRequired": false,
+        "type": "{ root?: SlotProps<ElementType<ModalProps, keyof IntrinsicElements>, DrawerRootSlotPropsOverrides, DrawerOwnerState> | undefined; backdrop?: SlotProps<...> | undefined; docked?: SlotProps<...> | undefined; paper?: SlotProps<...> | undefined; transition?: SlotProps<...> | undefined; }"
       }
     }
   }
-}
+}

package/data/component-props/Popover.json

@@ -2,17 +2,90 @@
   "Popover": {
     "props": {
       "anchorOrigin": {
-        "type": "PopoverOrigin",
-        "isRequired": false,
+        "defaultValue": "{\nvertical: top,\nhorizontal: left,\n}",
         "description": "This is the point on the anchor where the popover's\n`anchorEl` will attach to. This is not used when the\nanchorReference is 'anchorPosition'.\n\nOptions:\nvertical: [top, center, bottom];\nhorizontal: [left, center, right].",
-        "defaultValue": "{\nvertical: top,\nhorizontal: left,\n}"
+        "isRequired": false,
+        "type": "PopoverOrigin"
       },
       "transformOrigin": {
-        "type": "PopoverOrigin",
-        "isRequired": false,
+        "defaultValue": "{\nvertical: top,\nhorizontal: left,\n}",
         "description": "This is the point on the popover which\nwill attach to the anchor's origin.\n\nOptions:\nvertical: [top, center, bottom, x(px)];\nhorizontal: [left, center, right, x(px)].",
-        "defaultValue": "{\nvertical: top,\nhorizontal: left,\n}"
+        "isRequired": false,
+        "type": "PopoverOrigin"
+      },
+      "open": {
+        "description": "If `true`, the component is shown.",
+        "isRequired": true,
+        "type": "boolean"
+      },
+      "anchorEl": {
+        "description": "An HTML element, [PopoverVirtualElement](https://mui.com/material-ui/react-popover/#virtual-element),\nor a function that returns either.\nIt's used to set the position of the popover.",
+        "isRequired": false,
+        "type": "Element | PopoverVirtualElement | () => Element | PopoverVirtualElement | null | null"
+      },
+      "onClose": {
+        "description": "Callback fired when the component requests to be closed.\nThe `reason` parameter can optionally be used to control the response to `onClose`.",
+        "isRequired": false,
+        "type": "(event: {}, reason: \"backdropClick\" | \"escapeKeyDown\") => void"
+      },
+      "children": {
+        "description": "The content of the component.",
+        "isRequired": false,
+        "type": "ReactNode"
+      },
+      "anchorReference": {
+        "defaultValue": "anchorEl",
+        "description": "This determines which anchor prop to refer to when setting\nthe position of the popover.",
+        "isRequired": false,
+        "type": "\"none\" | \"anchorEl\" | \"anchorPosition\""
+      },
+      "anchorPosition": {
+        "description": "This is the position that may be used to set the position of the popover.\nThe coordinates are relative to the application's client area.",
+        "isRequired": false,
+        "type": "PopoverPosition"
+      },
+      "slotProps": {
+        "defaultValue": {},
+        "description": "The props used for each slot inside.",
+        "isRequired": false,
+        "type": "{ root?: SlotProps<ElementType<ModalProps, keyof IntrinsicElements>, PopoverRootSlotPropsOverrides, PopoverOwnerState> | undefined; paper?: SlotProps<...> | undefined; transition?: SlotComponentProps<...> | undefined; backdrop?: SlotProps<...> | undefined; }"
+      },
+      "marginThreshold": {
+        "defaultValue": 16,
+        "description": "Specifies how close to the edge of the window the popover can appear.\nIf null, the popover will not be constrained by the window.",
+        "isRequired": false,
+        "type": "number | null"
+      },
+      "keepMounted": {
+        "defaultValue": false,
+        "description": "Always keep the children in the DOM.\nThis prop can be useful in SEO situation or\nwhen you want to maximize the responsiveness of the Modal.",
+        "isRequired": false,
+        "type": "boolean"
+      },
+      "disableScrollLock": {
+        "defaultValue": false,
+        "description": "Disable the scroll lock behavior.",
+        "isRequired": false,
+        "type": "boolean"
+      },
+      "disablePortal": {
+        "defaultValue": false,
+        "description": "The `children` will be under the DOM hierarchy of the parent component.",
+        "isRequired": false,
+        "type": "boolean"
+      },
+      "elevation": {
+        "defaultValue": 8,
+        "description": "The elevation of the popover.",
+        "isRequired": false,
+        "type": "number"
+      },
+      "transitionDuration": {
+        "defaultValue": "auto",
+        "description": "Set to 'auto' to automatically calculate transition time based on height.",
+        "isRequired": false,
+        "type": "number | { appear?: number | undefined; enter?: number | undefined; exit?: number | undefined; } | \"auto\""
       }
     }
   }
-}
+}

package/data/component-props/PreComposedTable.json

@@ -2,57 +2,129 @@
   "PreComposedTable": {
     "props": {
       "border": {
-        "type": "any",
-        "isRequired": false
+        "defaultValue": true,
+        "description": "Draws the border around the scrolling table area",
+        "isRequired": false,
+        "type": "boolean"
       },
       "columns": {
-        "type": "any",
-        "isRequired": false
+        "description": "Column definitions that specify how data should be rendered and behave",
+        "isRequired": false,
+        "type": "ColumnDef<TData>[]"
       },
       "enableColumnFiltering": {
-        "type": "any",
-        "isRequired": false
+        "defaultValue": false,
+        "description": "Adds a filter row under the header. Each column gets a search input unless its meta supplies a filterComponent",
+        "isRequired": false,
+        "type": "boolean"
       },
       "enableGlobalFiltering": {
-        "type": "any",
-        "isRequired": false
+        "defaultValue": false,
+        "description": "Displays a search input that filters across all columns",
+        "isRequired": false,
+        "type": "boolean"
       },
       "enablePagination": {
-        "type": "any",
-        "isRequired": false
+        "defaultValue": false,
+        "description": "Enables pagination controls at the bottom of the table",
+        "isRequired": false,
+        "type": "boolean"
       },
       "enableRowSelection": {
-        "type": "any",
-        "isRequired": false
+        "defaultValue": false,
+        "description": "Adds a checkbox column with select-all. To control that column yourself, include one with the id \"SdsTableSelectColumn\" and it will be used instead of the generated one",
+        "isRequired": false,
+        "type": "boolean"
       },
       "enableSorting": {
-        "type": "any",
-        "isRequired": false
+        "defaultValue": false,
+        "description": "Makes column headers sortable, wiring each one's chevron and click handler for you",
+        "isRequired": false,
+        "type": "boolean"
       },
       "onRowSelect": {
-        "type": "any",
-        "isRequired": false
+        "description": "Callback triggered when row selection changes; receives array of selected row data",
+        "isRequired": false,
+        "type": "(selectedRows: TData[]) => void"
       },
       "paginationConfig": {
-        "type": "any",
-        "isRequired": false
+        "description": "Passed through to Pagination, plus a placement for the controls, which sit on the right by default. pageSize also sets the initial page size, which is 10 otherwise. Changing this object resets the table to the first page",
+        "isRequired": false,
+        "type": "Partial<PaginationProps> & { placement?: \"left\" | \"center\" | \"right\" }"
       },
       "shouldPinSelectRowToLeft": {
-        "type": "any",
-        "isRequired": false
+        "defaultValue": true,
+        "description": "Pins the row selection column to the left/right side of the table",
+        "isRequired": false,
+        "type": "boolean"
       },
       "sdsStyle": {
-        "type": "any",
-        "isRequired": false
+        "defaultValue": "lined",
+        "description": "Whether rows are separated by dividers or by alternating backgrounds",
+        "isRequired": false,
+        "type": "\"lined\" | \"striped\""
       },
       "tableOptions": {
-        "type": "any",
-        "isRequired": false
+        "description": "Escape hatch to the underlying TanStack table. Anything here is merged into its options, and a state you supply overrides the one the component keeps, which is how you drive sorting or pagination from outside. The row models and change handlers are always the component's own",
+        "isRequired": false,
+        "type": "Partial<Omit<TableOptions<TData>, \"data\" | \"columns\" | \"getCoreRowModel\">>"
       },
       "tableRowProps": {
-        "type": "any",
-        "isRequired": false
+        "description": "Additional props to pass to each table row component",
+        "isRequired": false,
+        "type": "Partial<TableRowProps>"
+      },
+      "data": {
+        "description": "Array of data objects to display in the table rows",
+        "isRequired": false,
+        "type": "TData[]"
+      },
+      "className": {
+        "description": "CSS class name to apply to the table container",
+        "isRequired": false,
+        "type": "string"
+      },
+      "style": {
+        "description": "Inline styles to apply to the table container",
+        "isRequired": false,
+        "type": "React.CSSProperties"
+      },
+      "tableWidth": {
+        "defaultValue": "100%",
+        "description": "Sets the width of the table container",
+        "isRequired": false,
+        "type": "string"
+      },
+      "pinning": {
+        "description": "Sticks the column to that edge while the table scrolls sideways, with a gradient at the edge once there is something hidden behind it",
+        "isRequired": false,
+        "type": "\"left\" | \"right\""
+      },
+      "verticalAlign": {
+        "description": "Vertical alignment of the column's cells",
+        "isRequired": false,
+        "type": "\"top\" | \"middle\" | \"bottom\""
+      },
+      "widthPercentage": {
+        "description": "The column's share of the table width, as a percentage rather than a fixed size",
+        "isRequired": false,
+        "type": "number"
+      },
+      "isGrow": {
+        "description": "Lets this column absorb whatever width the others leave over",
+        "isRequired": false,
+        "type": "boolean"
+      },
+      "headerCellProps": {
+        "description": "Props for the CellHeader generated from a string header, for tooltips, alignment or truncation",
+        "isRequired": false,
+        "type": "Partial<CellHeaderProps>"
+      },
+      "filterComponent": {
+        "description": "Replaces the default search input in this column's filter cell, for a select or a range instead",
+        "isRequired": false,
+        "type": "(props: { column: Column<TData>; table: Table<TData> }) => React.ReactNode"
       }
     }
   }
-}
+}

package/data/component-props/ProteinStructureViewer.json

@@ -0,0 +1,117 @@
+{
+  "ProteinStructureViewer": {
+    "props": {
+      "backgroundColor": {
+        "description": "Canvas background, as `#RRGGBB`. Defaults to the SDS theme's base\nbackground, so the canvas follows the surrounding page in both modes.",
+        "isRequired": false,
+        "type": "string"
+      },
+      "showAxes": {
+        "defaultValue": true,
+        "description": "Show the orientation axes widget and the reset-camera button.",
+        "isRequired": false,
+        "type": "boolean"
+      },
+      "showLegend": {
+        "defaultValue": true,
+        "description": "Show the stats and color scale legend overlaid on the viewer.",
+        "isRequired": false,
+        "type": "boolean"
+      },
+      "sequenceViewerBackgroundColor": {
+        "description": "Sequence panel background, as any CSS color. Defaults to the SDS theme's\nprimary surface, so the panel follows the surrounding page in both modes.",
+        "isRequired": false,
+        "type": "string"
+      },
+      "showSequenceViewer": {
+        "defaultValue": true,
+        "description": "Show the sequence panel pinned along the bottom of the viewer.",
+        "isRequired": false,
+        "type": "boolean"
+      },
+      "stats": {
+        "description": "Up to three whole-structure stats shown along the bottom. A null entry\nreserves its column without rendering anything, so the columns never shift\nas values come and go.",
+        "isRequired": false,
+        "type": "(StructureStat | null)[]"
+      },
+      "pdb": {
+        "defaultValue": "- (required)",
+        "description": "Structure to render, as raw PDB text.",
+        "isRequired": true,
+        "type": "string"
+      },
+      "plddt": {
+        "description": "Per-residue pLDDT confidence on a 0-1 scale, ordered by residue. When\nsupplied the structure is colored by pLDDT unless `residueOverlay` takes\nover.",
+        "isRequired": false,
+        "type": "number[] | null"
+      },
+      "residueOverlay": {
+        "description": "Per-residue values that override pLDDT coloring while set.",
+        "isRequired": false,
+        "type": "ResidueValueOverlay | null"
+      },
+      "selectedResidue": {
+        "defaultValue": null,
+        "description": "0-based index of the selected residue, or null when none is selected.\nControlled: selecting a residue zooms the camera in on it, and clearing the\nselection zooms back out to the default view.",
+        "isRequired": false,
+        "type": "number | null"
+      },
+      "onResidueClick": {
+        "description": "Called with the clicked residue.",
+        "isRequired": false,
+        "type": "(residue: ResidueRef) => void"
+      },
+      "onResidueHover": {
+        "description": "Called as the pointer moves over residues, and with `null` when it leaves\nthe structure.",
+        "isRequired": false,
+        "type": "(residue: ResidueRef | null) => void"
+      },
+      "onSelectionClear": {
+        "description": "Called when the user clicks empty space, clearing the selection.",
+        "isRequired": false,
+        "type": "() => void"
+      },
+      "values": {
+        "defaultValue": "- (required)",
+        "description": "0-based residue index to value. Residues absent from the map read as 0, so they render in the neutral gray rather than at the bottom of the scale.",
+        "isRequired": false,
+        "type": "Map<number, number>"
+      },
+      "max": {
+        "defaultValue": "- (required)",
+        "description": "The value mapped to the top of the color scale.",
+        "isRequired": false,
+        "type": "number"
+      },
+      "min": {
+        "defaultValue": 0,
+        "description": "Values at or below this render in a neutral gray rather than on the scale.",
+        "isRequired": false,
+        "type": "number"
+      },
+      "colorScale": {
+        "defaultValue": "PLASMA_COLOR_SCALE",
+        "description": "Scale used to color residues and to draw the legend.",
+        "isRequired": false,
+        "type": "ColorScale"
+      },
+      "tooltip": {
+        "description": "Help tooltip attached to the legend caption.",
+        "isRequired": false,
+        "type": "string"
+      },
+      "readoutLabel": {
+        "defaultValue": "Value",
+        "description": "Label for the per-residue readout that replaces a stat slot on hover.",
+        "isRequired": false,
+        "type": "string"
+      },
+      "value": {
+        "defaultValue": "- (required)",
+        "description": "The stat's value, already formatted for display.",
+        "isRequired": false,
+        "type": "string"
+      }
+    }
+  }
+}

package/data/component-props/SegmentedControl.json

@@ -2,9 +2,48 @@
   "SegmentedControl": {
     "props": {
       "buttonDefinition": {
-        "type": "SingleButtonDefinition[]",
-        "isRequired": true
+        "defaultValue": "- (required)",
+        "description": "One entry per segment, in the order they appear. The shape is described in the table below.",
+        "isRequired": true,
+        "type": "SingleButtonDefinition[]"
+      },
+      "onChange": {
+        "description": "Callback fired when the value changes.\n@param event The event source of the callback.\n@param value of the selected buttons. When `exclusive` is true\nthis is a single value; when false an array of selected values. If no value\nis selected and `exclusive` is true the value is null; when false an empty array.",
+        "isRequired": false,
+        "type": "function"
+      },
+      "aria-label": {
+        "defaultValue": "Segmented Control",
+        "description": "Defines a string value that labels the current element.\n@see aria-labelledby.",
+        "isRequired": false,
+        "type": "string"
+      },
+      "icon": {
+        "description": "An SDS icon name, drawn at the small size, or an SVG element of your own for artwork SDS does not carry. Size an element you pass to 16px and fill it with currentColor so it follows the selection.",
+        "isRequired": false,
+        "type": "keyof IconNameToSizes | React.ReactElement"
+      },
+      "label": {
+        "description": "Text for the segment, used instead of an icon. It becomes the segment's accessible name and the tooltip's fallback text.",
+        "isRequired": false,
+        "type": "string"
+      },
+      "shouldShowTooltip": {
+        "defaultValue": true,
+        "description": "Whether the segment has a tooltip. Worth turning off for a labelled segment, whose tooltip would only repeat the label.",
+        "isRequired": false,
+        "type": "boolean"
+      },
+      "tooltipProps": {
+        "description": "Passed to the segment's Tooltip, so it takes a title, a subtitle, a placement, and the rest of the Tooltip API. Without a title, the tooltip falls back to the label or the value. Note that the title is not used as the segment's accessible name.",
+        "isRequired": false,
+        "type": "Partial<Omit<TooltipProps, \"children\">>"
+      },
+      "tooltipText": {
+        "description": "Deprecated in favour of tooltipProps, and logs a warning. It sets the tooltip's title, overriding tooltipProps.title when both are given, and it is the one tooltip prop that also sets the segment's accessible name.",
+        "isRequired": false,
+        "type": "string"
       }
     }
   }
-}
+}