@czi-sds/mcp 0.5.3 → 0.5.4

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.
@@ -39,8 +39,6 @@ Click on each state below to enter inspect view and get details on its code attr
39
39
 
40
40
  ---
41
41
 
42
-
43
-
44
42
  ### Rounded Search Input Intent States
45
43
 
46
44
  The `intent` prop is used to communicate the response state of the user's search inquiry.
@@ -76,8 +74,6 @@ These rules establish how much margin should exist between and around elements.
76
74
 
77
75
  ---
78
76
 
79
-
80
-
81
77
  ---
82
78
 
83
79
  ## Square Search Input
@@ -108,8 +104,6 @@ Click on each state below to enter inspect view and get details on its code attr
108
104
 
109
105
  ---
110
106
 
111
-
112
-
113
107
  ### Square Search Input Intent States
114
108
 
115
109
  The `intent` prop is used to communicate the response state of the user's search inquiry.
@@ -141,8 +135,6 @@ Use `intent: warning` to communicate when a user needs to be alerted that their
141
135
 
142
136
  These rules establish how much margin should exist between and around elements.
143
137
 
144
-
145
-
146
138
  **Square Search Input spacing**
147
139
 
148
140
  ---
@@ -179,8 +171,6 @@ Click on each state below to enter inspect view and get details on its code attr
179
171
 
180
172
  ---
181
173
 
182
-
183
-
184
174
  ### Text Area Input
185
175
 
186
176
  The Text Area Input is meant to fit multiple lines of text and should be used when there is the potential that the user will want or need to input more than a single line's worth of content.
@@ -210,8 +200,6 @@ Click on each state below to enter inspect view and get details on its code attr
210
200
 
211
201
  ---
212
202
 
213
-
214
-
215
203
  ### Text Input Intent States
216
204
 
217
205
  The `intent` prop is used to communicate the response state of the text the user has input.
@@ -323,8 +311,6 @@ Click on each state below to enter inspect view and get details on its code attr
323
311
 
324
312
  ---
325
313
 
326
-
327
-
328
314
  ### Rounded Search Input Intent States
329
315
 
330
316
  The `intent` prop is used to communicate the response state of the user's search inquiry.
@@ -390,8 +376,6 @@ Click on each state below to enter inspect view and get details on its code attr
390
376
 
391
377
  ---
392
378
 
393
-
394
-
395
379
  ### Square Search Input Intent States
396
380
 
397
381
  The `intent` prop is used to communicate the response state of the user's search inquiry.
@@ -459,8 +443,6 @@ Click on each state below to enter inspect view and get details on its code attr
459
443
 
460
444
  ---
461
445
 
462
-
463
-
464
446
  ### Text Area Input
465
447
 
466
448
  The Text Area Input is meant to fit multiple lines of text and should be used when there is the potential that the user will want or need to input more than a single line's worth of content.
@@ -490,8 +472,6 @@ Click on each state below to enter inspect view and get details on its code attr
490
472
 
491
473
  ---
492
474
 
493
-
494
-
495
475
  ### Text Input Intent States
496
476
 
497
477
  The `intent` prop is used to communicate the response state of the text the user has input.
@@ -139,8 +139,6 @@ The Dropdown Menu that is activated when the Filter Label is clicked displays th
139
139
 
140
140
  ---
141
141
 
142
-
143
-
144
142
  ### Filter Example
145
143
 
146
144
  The example below shows Complex Filters being used as part of a Basic Panel in CZ GEN EPI.
@@ -234,8 +232,6 @@ The example below shows Simple Filters being used as part of a Basic Panel in CZ
234
232
 
235
233
  ---
236
234
 
237
-
238
-
239
235
  ---
240
236
 
241
237
  ### Simple Filter Spacing
@@ -302,8 +298,6 @@ The Dropdown Menu that is activated when the Filter Label is clicked displays th
302
298
 
303
299
  ---
304
300
 
305
-
306
-
307
301
  ### Complex Filter Example
308
302
 
309
303
  The example below shows Complex Filters being used as part of a Basic Panel in CZ ID.
@@ -89,8 +89,6 @@ npm i czifui
89
89
  yarn add czifui
90
90
  ```
91
91
 
92
-
93
-
94
92
  SDS currently uses Material UI v5
95
93
 
96
94
  czifui installs without direct dependencies to prevent version errors. Please ensure the following peer dependencies are also installed:
@@ -482,8 +480,6 @@ export const Tag = styled.div`
482
480
  `;
483
481
  ```
484
482
 
485
-
486
-
487
483
  4. **CSS & SCSS Variables** - Variables for the `defaultTheme` to use if your app doesn't support `@emotion/styled`
488
484
 
489
485
  ```css
@@ -549,8 +545,6 @@ import { ThemeProvider as EmotionThemeProvider } from "@emotion/react";
549
545
  </StylesProvider>;
550
546
  ```
551
547
 
552
-
553
-
554
548
  3. If you need to override the default SDS theme, please follow the instructions here.
555
549
 
556
550
  ---
@@ -169,8 +169,6 @@ Use when the order of the list's content does not matter.
169
169
 
170
170
  ---
171
171
 
172
-
173
-
174
172
  ### Ordered List
175
173
 
176
174
  Use when the list's content needs to be presented in a specific order or sequence.
@@ -325,8 +323,6 @@ Use when the order of the list's content does not matter.
325
323
 
326
324
  ---
327
325
 
328
-
329
-
330
326
  ### Ordered List
331
327
 
332
328
  Use when the list's content needs to be presented in a specific order or sequence.
@@ -25,8 +25,6 @@ These rules establish how much margin should exist between and around elements.
25
25
 
26
26
  ---
27
27
 
28
-
29
-
30
28
  ## Code
31
29
 
32
30
  ## Loading Indicator Component
@@ -41,5 +39,3 @@ These rules establish how much margin should exist between and around elements.
41
39
  ### LoadingIndicator
42
40
 
43
41
  Storybook
44
-
45
-
@@ -32,8 +32,6 @@ These rules establish how much margin should exist between and around elements.
32
32
 
33
33
  ---
34
34
 
35
-
36
-
37
35
  ## Code
38
36
 
39
37
  ## Jump-to Navigation Component
@@ -49,8 +47,6 @@ These rules establish how much margin should exist between and around elements.
49
47
 
50
48
  Default
51
49
 
52
-
53
-
54
50
  ---
55
51
 
56
52
  Navigation components enable users to move around an application, either between pages or within the same page, and help facilitate user's ability to find relevant content and tools.
@@ -83,8 +79,6 @@ Use a positive pixel value in the `offset` prop to adjust where on the page the
83
79
 
84
80
  These rules establish how much margin should exist between and around elements.
85
81
 
86
-
87
-
88
82
  **Jump-to Navigation spacing**
89
83
 
90
84
  ---
@@ -56,8 +56,6 @@ A Minimal Button can be added to the Notification if additional action from the
56
56
 
57
57
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
58
58
 
59
-
60
-
61
59
  **Notification/Notification**
62
60
 
63
61
  ---
@@ -135,8 +133,6 @@ Each intent is demonstrated below using the Persistent Notification for referenc
135
133
 
136
134
  Storybook
137
135
 
138
-
139
-
140
136
  ---
141
137
 
142
138
  Notifications appear outside of the flow of the page to highlight information to the user whether in response to an action they have completed or to bring their attention to important details.
@@ -185,8 +181,6 @@ Click on each state below to enter inspect view and get details on its code attr
185
181
 
186
182
  ---
187
183
 
188
-
189
-
190
184
  ### Dismissible Notification
191
185
 
192
186
  Use when communicating information that is manually dismissible by the user and does not need to remain persistent on the screen. It can be set to automatically dismiss after a designated period of time using the `autoDismiss` prop; when set to `true`, the automatic dismissal will occur after 8 milliseconds by default, but can be set to a custom length of time by entering a millisecond value into the prop.
@@ -195,8 +189,6 @@ A Minimal Button can be added to the Notification if additional action from the
195
189
 
196
190
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
197
191
 
198
-
199
-
200
192
  **Default**
201
193
 
202
194
  ---
@@ -272,8 +264,6 @@ Each intent is demonstrated below using the Persistent Notification for referenc
272
264
 
273
265
  Storybook
274
266
 
275
-
276
-
277
267
  ---
278
268
 
279
269
  Notifications appear outside of the flow of the page to highlight information to the user whether in response to an action they have completed or to bring their attention to important details.
@@ -19,8 +19,6 @@ Panels are comprised of containers within which other elements are placed. Use t
19
19
 
20
20
  The example below shows where in CZ GEN EPI the Basic Panel is used.
21
21
 
22
-
23
-
24
22
  **Basic Panel_left**
25
23
 
26
24
  ---
@@ -101,8 +99,6 @@ Although Overlay Panels can be designed to contain a wide range of elements, the
101
99
 
102
100
  ---
103
101
 
104
-
105
-
106
102
  ### Overlay Panel Examples
107
103
 
108
104
  The examples below show where in CZ ID the Overlay Panel is currently being used.
@@ -128,14 +124,10 @@ The examples below show where in CZ ID the Overlay Panel is currently being used
128
124
 
129
125
  ### PanelBasic (coming soon)
130
126
 
131
-
132
-
133
127
  ---
134
128
 
135
129
  ### PanelOverlay (coming soon)
136
130
 
137
-
138
-
139
131
  ---
140
132
 
141
133
  Panels are elements that contain supplementary information or actions for the page's content they appear on. Where and how they display is determined by the type of content on them.
@@ -36,8 +36,6 @@ Click on each state below to enter inspect view and get details on its code attr
36
36
 
37
37
  ---
38
38
 
39
-
40
-
41
39
  ### Small Search Input
42
40
 
43
41
  Used in napari hub for searching within plugin Filter Dropdown Menus when there are more menu items than can be viewed without scrolling.
@@ -77,8 +75,6 @@ These rules establish how much margin should exist between and around elements.
77
75
 
78
76
  ---
79
77
 
80
-
81
-
82
78
  ## Code
83
79
 
84
80
  ## Field Input Components
@@ -93,5 +89,3 @@ These rules establish how much margin should exist between and around elements.
93
89
  ### InputSearch
94
90
 
95
91
  Storybook
96
-
97
-
@@ -23,8 +23,6 @@ Search is a flexible way for users to find data of interest or filter down their
23
23
 
24
24
  Search results are displayed on the current page by filtering down the visible content within the searchable area(s) to show matches only. This search is the most common pattern; it is used both at the component and the page levels.
25
25
 
26
-
27
-
28
26
  **napari hub + org_On-page Results flow_Overview**
29
27
 
30
28
  ---
@@ -47,8 +45,6 @@ Search is initiated when the user clicks a button, hits “enter”, or complete
47
45
 
48
46
  This method is recommended when search results must be fetched from the backend, or when the user needs to set up other specifications before initiating the search.
49
47
 
50
-
51
-
52
48
  #### **3.** Results Displayed in Searched Content Area
53
49
 
54
50
  Results are displayed by filtering the content in the searchable area (1) so that only search results are visible.
@@ -95,8 +91,6 @@ That being said, for the On-page Results flow, keep in mind:
95
91
 
96
92
  Search results are displayed on a different page than where the search was originally initiated. Depending on the use case, this may be a unique “Results” page, or an existing page where the data is usually located. The Results Page flow is often combined with the On-page Results flow. Learn more about Combining Search Types.
97
93
 
98
-
99
-
100
94
  **napari hub + org_Results Page flow_Overview**
101
95
 
102
96
  ---
@@ -109,8 +103,6 @@ It is recommended to position Search Inputs at the top level of the content the
109
103
 
110
104
  For example, if the search will display results from across the whole site (1), position the Search Input in a top-level navigation or outside of the page content hierarchy (2).
111
105
 
112
-
113
-
114
106
  **Results Page – 1**
115
107
 
116
108
  ---
@@ -121,8 +113,6 @@ Search is initiated when the user clicks a button (1), hits “enter” (2), or
121
113
 
122
114
  Because results will be displayed on a new page, Live Search is not recommended.
123
115
 
124
-
125
-
126
116
  **Results Page – 2**
127
117
 
128
118
  ---
@@ -135,8 +125,6 @@ The results page format depends on the product's use case and content. In the ex
135
125
 
136
126
  If there are no results, it is recommended to display a bank state on the results page.
137
127
 
138
-
139
-
140
128
  **Results Page – 3**
141
129
 
142
130
  ---
@@ -149,8 +137,6 @@ Depending on the product and the user’s workflow, they may take a number of ne
149
137
  - Interact with results, like drilling down into a single result (2) .
150
138
  - Filter or Sort Results.
151
139
 
152
-
153
-
154
140
  **Results Page – 4**
155
141
 
156
142
  ---
@@ -281,8 +267,6 @@ If there are no results, it is recommended that a “No Results” blank state i
281
267
 
282
268
  ---
283
269
 
284
-
285
-
286
270
  **4. User Takes Action on Results**
287
271
 
288
272
  Depending on the product and the user’s workflow, users may take a number of next actions on the results, possibly including:
@@ -508,8 +492,6 @@ The following behaviors are recommended for displaying search results within a D
508
492
 
509
493
  ---
510
494
 
511
-
512
-
513
495
  ## Other Considerations
514
496
 
515
497
  | Search is a complex component, and is highly subjective to each product's use case. While it's impossible to support and document every use case, here is a collection of patterns that may be useful to consider when implementing it. The patterns detailed below have not been developed by the SDS team and are simply examples pulled from products that utilize the SDS components. **Please consider the information in this section as inspiration only.** | | **Jump to pattern:** Combining Search Types Supporting User Behavior |
@@ -48,8 +48,6 @@ Click on each variant below to enter inspect view and get details on its code at
48
48
 
49
49
  These rules establish how much margin should exist between and around elements. Multiple Basic Cells are placed beside each other to create a Table Row. Stack Table Rows below a Table Header to create a full Table.
50
50
 
51
-
52
-
53
51
  **Basic Cell spacing**
54
52
 
55
53
  ---
@@ -222,8 +220,6 @@ Click on each variant below to enter inspect view and get details on its code at
222
220
 
223
221
  **Note:** Dotted lines around the cells below are only for demonstration purposes to show the cells' containers; in application, individual cells have no borders.
224
222
 
225
-
226
-
227
223
  **Default**
228
224
 
229
225
  ---
@@ -300,8 +296,6 @@ Click on each variant below to enter inspect view and get details on its code at
300
296
 
301
297
  These rules establish how much margin should exist between and around elements. Multiple content cells are placed beside each other to create a Table Row. Stack Table Rows below a Table Header to create a full Table.
302
298
 
303
-
304
-
305
299
  **Content Cell spacing**
306
300
 
307
301
  ---
@@ -342,8 +336,6 @@ Each Header Cell can have an optional Tooltip appear when hovered over by using
342
336
 
343
337
  ---
344
338
 
345
-
346
-
347
339
  ### Header Cell Variants
348
340
 
349
341
  Click on each variant below to enter inspect view and get details on its code attributes and any global styles it uses.
@@ -409,8 +401,6 @@ Use the `disabled` prop to gray out all of the cells in the row and make it so u
409
401
 
410
402
  Click on each variant below to enter inspect view and get details on its code attributes and any global styles it uses.
411
403
 
412
-
413
-
414
404
  **Default**
415
405
 
416
406
  ---
@@ -455,12 +445,8 @@ An overflow Icon Button, represented by the `DotsHorizontal3` icon (2), can be u
455
445
 
456
446
  ---
457
447
 
458
-
459
-
460
448
  For efficiency, Tables can be designed to allow users to complete actions across multiple Table Rows at the same time, known as bulk actions. Similar to row actions, bulk actions are completed by clicking on corresponding Icon Buttons that are located at the top right of the Table, above the Table Header; they should be inactive when no rows are selected (1).
461
449
 
462
-
463
-
464
450
  **Bulk Table Row actions_default**
465
451
 
466
452
  ---
@@ -469,8 +455,6 @@ To make Table Rows selectable, designers must include Checkbox Inputs in the fir
469
455
 
470
456
  Because actions taken at the row level will impact stored data in the application, row and bulk actions are completely controlled by the application itself and not the SDS component.
471
457
 
472
-
473
-
474
458
  **Bulk Table Row actions_selected**
475
459
 
476
460
  ---
@@ -561,8 +545,6 @@ Storybook
561
545
 
562
546
  ---
563
547
 
564
-
565
-
566
548
  ### CellComponent
567
549
 
568
550
  Storybook
@@ -593,8 +575,6 @@ Storybook
593
575
 
594
576
  Storybook
595
577
 
596
-
597
-
598
578
  ---
599
579
 
600
580
  Tables are used to store and visually organize data and other content into a series of cells grouped into a collection of rows and columns, helping users better understand and analyze a given set of information.
@@ -190,8 +190,6 @@ These rules establish how much margin should exist between and around elements.
190
190
 
191
191
  ---
192
192
 
193
-
194
-
195
193
  ## Code
196
194
 
197
195
  ## Tabs Component
@@ -274,8 +272,6 @@ Overall, include a counter when necessary to indicate the number of items on tha
274
272
  | **Default + Underline** | **Hover** | **Active** | **Disabled** |
275
273
  | ----------------------- | --------- | ---------- | ------------ |
276
274
 
277
-
278
-
279
275
  **Tabs**
280
276
 
281
277
  ---
@@ -403,8 +399,6 @@ These rules establish how much margin should exist between and around elements.
403
399
 
404
400
  ---
405
401
 
406
-
407
-
408
402
  ## Code
409
403
 
410
404
  ## Tabs Component
@@ -420,8 +414,6 @@ These rules establish how much margin should exist between and around elements.
420
414
 
421
415
  Storybook
422
416
 
423
-
424
-
425
417
  ---
426
418
 
427
419
  Tabs allow users to switch between different sets of information or content that is related to one overarching category or group while staying on the same page.
@@ -524,8 +516,6 @@ Include a counter when necessary to indicate the number of items on that Tab's s
524
516
 
525
517
  ---
526
518
 
527
-
528
-
529
519
  ### Small Tabs
530
520
 
531
521
  Alternative Tab size to be used only in conjunction with Large Tabs when a secondary layer of tabbing is needed.
@@ -430,8 +430,6 @@ Storybook
430
430
 
431
431
  Storybook
432
432
 
433
-
434
-
435
433
  ---
436
434
 
437
435
  Tags are used to label the status of certain elements or in conjunction with filters to indicate which have been applied when viewing datasets.
@@ -42,10 +42,6 @@ These rules establish how much margin should exist between and around elements.
42
42
 
43
43
  ---
44
44
 
45
-
46
-
47
-
48
-
49
45
  ## Code
50
46
 
51
47
  ## Text Link Component
@@ -61,8 +57,6 @@ These rules establish how much margin should exist between and around elements.
61
57
 
62
58
  Storybook
63
59
 
64
-
65
-
66
60
  ---
67
61
 
68
62
  Text Links are interactive elements that, when clicked, navigate the user away from the page they are currently viewing to another page or screen.
@@ -102,8 +96,6 @@ Click on each state below to enter inspect view and get details on its code attr
102
96
 
103
97
  ---
104
98
 
105
-
106
-
107
99
  ### Dashed Text Link
108
100
 
109
101
  Use the Dashed Text Link when the Text Link is placed on a background where the Default Text Link does not provide enough contrast to pass visual accessibility standards. The color of the link and its underline is inherited from the color used in the paragraph it is part of, see Dashed Text Link Color Examples below.
@@ -156,8 +148,6 @@ Note: Default Text Links fall in line with the rest of the text in the paragraph
156
148
 
157
149
  ---
158
150
 
159
-
160
-
161
151
  ## Code
162
152
 
163
153
  ## Text Link Component
@@ -212,8 +202,6 @@ Click on each state below to enter inspect view and get details on its code attr
212
202
 
213
203
  ---
214
204
 
215
-
216
-
217
205
  ### Dashed Text Link
218
206
 
219
207
  Use the Dashed Text Link when the Text Link is placed on a background where the Default Text Link does not provide enough contrast to pass visual accessibility standards. The color of the link and its underline is inherited from the color used in the paragraph it is part of, see Dashed Text Link Color Examples below.
@@ -235,8 +223,6 @@ Click on each state below to enter inspect view and get details on its code attr
235
223
 
236
224
  ---
237
225
 
238
-
239
-
240
226
  ### Dashed Text Link Color Examples
241
227
 
242
228
  See below for visual examples of how the Dashed Text Link should be used in different colors depending on the color of the background it is placed upon.
@@ -280,5 +266,3 @@ Note: Default Text Links fall in line with the rest of the text in the paragraph
280
266
  ### Link
281
267
 
282
268
  Storybook
283
-
284
-
@@ -240,14 +240,10 @@ Click on each state below to enter inspect view and get details on its code attr
240
240
 
241
241
  ---
242
242
 
243
-
244
-
245
243
  **Default + Subtitle**
246
244
 
247
245
  ---
248
246
 
249
-
250
-
251
247
  ### Light Tooltip
252
248
 
253
249
  Use to display supplementary information such as definitions, instructions, or expanded details which require more text in the Tooltip. The white background on the Tooltip makes longer blocks of copy easier for the user to read. Use the `width` prop to expand the width of the Light Tooltip to a max-width of 550px if there is a need to display particularly long blocks of copy.
@@ -258,8 +254,6 @@ The Tooltip is positioned relative to the on-screen element as opposed to relati
258
254
 
259
255
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
260
256
 
261
-
262
-
263
257
  **Default**
264
258
 
265
259
  ---
@@ -371,8 +365,6 @@ Click on each state below to enter inspect view and get details on its code attr
371
365
 
372
366
  ---
373
367
 
374
-
375
-
376
368
  **Default + Indicator**
377
369
 
378
370
  ---
@@ -575,8 +567,6 @@ The Tooltip is positioned relative to the on-screen element as opposed to relati
575
567
 
576
568
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
577
569
 
578
-
579
-
580
570
  **Default**
581
571
 
582
572
  ---
@@ -587,8 +577,6 @@ Click on each state below to enter inspect view and get details on its code attr
587
577
 
588
578
  ---
589
579
 
590
-
591
-
592
580
  ### Light Tooltip
593
581
 
594
582
  Use to display supplementary information such as definitions, instructions, or expanded details which require more text in the Tooltip. The white background on the Tooltip makes longer blocks of copy easier for the user to read. Use the `width` prop to expand the width of the Light Tooltip to a max width of 550px if there is a need to display particularly long blocks of copy.
@@ -599,8 +587,6 @@ The Tooltip is positioned relative to the on-screen element as opposed to relati
599
587
 
600
588
  Click on each state below to enter inspect view and get details on its code attributes and any global styles it uses.
601
589
 
602
-
603
-
604
590
  **Default**
605
591
 
606
592
  ---
@@ -862,8 +848,6 @@ Storybook
862
848
 
863
849
  Storybook
864
850
 
865
-
866
-
867
851
  ---
868
852
 
869
853
  Tooltips are used throughout the UI and appear whenever users hover over elements that require additional context, instructions, or details.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@czi-sds/mcp",
3
3
  "description": "The official MCP server for SDS",
4
- "version": "0.5.3",
4
+ "version": "0.5.4",
5
5
  "main": "dist/stdio.js",
6
6
  "files": [
7
7
  "dist",
@@ -62,5 +62,5 @@
62
62
  "tsx": "^4.20.3",
63
63
  "typescript": "^5.9.2"
64
64
  },
65
- "gitHead": "b429604fd8fd932c28053faff1a6651cb61ada5f"
65
+ "gitHead": "521a9fa26e971802a4b20b663104db10822d0874"
66
66
  }