@cmgfi/clear-ds 1.2.1 → 1.2.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/dist/index.d.ts CHANGED
@@ -13,6 +13,8 @@ import { RefAttributes } from 'react';
13
13
  * (all three use a light gray header).
14
14
  *
15
15
  * @example
16
+ *
17
+ * ```tsx
16
18
  * const [open, setOpen] = useState(['item1']);
17
19
  * <Accordion
18
20
  * variant="page"
@@ -23,6 +25,7 @@ import { RefAttributes } from 'react';
23
25
  * openIds={open}
24
26
  * onChange={setOpen}
25
27
  * />
28
+ * ```
26
29
  */
27
30
  export declare const Accordion: ForwardRefExoticComponent<AccordionProps & RefAttributes<HTMLDivElement>>;
28
31
 
@@ -179,8 +182,11 @@ export declare interface BannerTabItem {
179
182
  * Fully controlled — the parent owns which tab is active.
180
183
  *
181
184
  * @example
185
+ *
186
+ * ```tsx
182
187
  * const [active, setActive] = useState('loan-summary');
183
188
  * <BannerTabs items={loanStages} activeId={active} onChange={setActive} />
189
+ * ```
184
190
  */
185
191
  export declare const BannerTabs: ForwardRefExoticComponent<BannerTabsProps & RefAttributes<HTMLDivElement>>;
186
192
 
@@ -207,16 +213,25 @@ export declare interface BannerTabStatus {
207
213
  * leading/trailing icons, and an optional notification badge.
208
214
  *
209
215
  * @example
210
- * <Button>Submit</Button>
211
216
  *
217
+ * ```tsx
218
+ * <Button>Submit</Button>
219
+ * ```
212
220
  * @example
213
- * <Button variant="secondary" size="sm">Cancel</Button>
214
221
  *
222
+ * ```tsx
223
+ * <Button variant="secondary" size="sm">Cancel</Button>
224
+ * ```
215
225
  * @example
216
- * <Button variant="danger" leadingIcon={<i className="pi pi-trash" />}>Delete</Button>
217
226
  *
227
+ * ```tsx
228
+ * <Button variant="danger" leadingIcon={<i className="pi pi-trash" />}>Delete</Button>
229
+ * ```
218
230
  * @example
231
+ *
232
+ * ```tsx
219
233
  * <Button badge={3} trailingIcon={<i className="pi pi-chevron-down" />}>Actions</Button>
234
+ * ```
220
235
  */
221
236
  export declare const Button: ForwardRefExoticComponent<ButtonProps & RefAttributes<HTMLButtonElement>>;
222
237
 
@@ -254,10 +269,15 @@ export declare type ButtonVariant = 'primary' | 'secondary' | 'ghost' | 'danger'
254
269
  * inside DatePicker, extracted for use on its own.
255
270
  *
256
271
  * @example
257
- * <Calendar value={date} onChange={setDate} />
258
272
  *
273
+ * ```tsx
274
+ * <Calendar value={date} onChange={setDate} />
275
+ * ```
259
276
  * @example
277
+ *
278
+ * ```tsx
260
279
  * <Calendar value={date} onChange={setDate} minDate={new Date()} showFooter />
280
+ * ```
261
281
  */
262
282
  export declare const Calendar: ForwardRefExoticComponent<CalendarProps & RefAttributes<HTMLDivElement>>;
263
283
 
@@ -292,20 +312,27 @@ export declare interface CalendarProps {
292
312
  * All sections are optional — use what you need.
293
313
  *
294
314
  * @example
315
+ *
316
+ * ```tsx
295
317
  * // Standard card
296
318
  * <Card title="Loan Summary" subTitle="Application #12345" footer={<Button>View</Button>}>
297
319
  * <p>Body content goes here.</p>
298
320
  * </Card>
299
- *
321
+ * ```
300
322
  * @example
323
+ *
324
+ * ```tsx
301
325
  * // Content-only container (no header or footer)
302
326
  * <Card><DataTable ... /></Card>
303
- *
327
+ * ```
304
328
  * @example
329
+ *
330
+ * ```tsx
305
331
  * // Interactive / clickable card
306
332
  * <Card title="Open Application" onClick={() => navigate('/app/123')}>
307
333
  * <p>Click anywhere to open.</p>
308
334
  * </Card>
335
+ * ```
309
336
  */
310
337
  export declare const Card: ForwardRefExoticComponent<CardProps & RefAttributes<HTMLDivElement>>;
311
338
 
@@ -337,19 +364,30 @@ export declare interface CardProps {
337
364
  * Three sizes (sm, md, lg) follow the type scale.
338
365
  *
339
366
  * @example
340
- * <Checkbox label="Remember me" />
341
367
  *
368
+ * ```tsx
369
+ * <Checkbox label="Remember me" />
370
+ * ```
342
371
  * @example
343
- * <Checkbox label="Agree to terms" checked={agreed} onChange={(e) => setAgreed(e.target.checked)} />
344
372
  *
373
+ * ```tsx
374
+ * <Checkbox label="Agree to terms" checked={agreed} onChange={(e) => setAgreed(e.target.checked)} />
375
+ * ```
345
376
  * @example
346
- * <Checkbox label="Select all" indeterminate />
347
377
  *
378
+ * ```tsx
379
+ * <Checkbox label="Select all" indeterminate />
380
+ * ```
348
381
  * @example
349
- * <Checkbox label="Accept terms" invalid helperText="You must accept the terms to continue." />
350
382
  *
383
+ * ```tsx
384
+ * <Checkbox label="Accept terms" invalid helperText="You must accept the terms to continue." />
385
+ * ```
351
386
  * @example
387
+ *
388
+ * ```tsx
352
389
  * <Checkbox label="Dense option" size="sm" />
390
+ * ```
353
391
  */
354
392
  export declare const Checkbox: ForwardRefExoticComponent<CheckboxProps & RefAttributes<HTMLInputElement>>;
355
393
 
@@ -376,10 +414,15 @@ export declare interface CheckboxProps extends Omit<React.InputHTMLAttributes<HT
376
414
  * A `Tooltip` showing the `aria-label` is rendered automatically on hover.
377
415
  *
378
416
  * @example
379
- * <CloseButton onClick={onClose} />
380
417
  *
418
+ * ```tsx
419
+ * <CloseButton onClick={onClose} />
420
+ * ```
381
421
  * @example
422
+ *
423
+ * ```tsx
382
424
  * <CloseButton aria-label="Close dialog" size="md" onClick={onClose} />
425
+ * ```
383
426
  */
384
427
  export declare const CloseButton: ForwardRefExoticComponent<CloseButtonProps & RefAttributes<HTMLButtonElement>>;
385
428
 
@@ -418,6 +461,8 @@ export declare interface ColumnFilter {
418
461
  * expandable row groups, nested row expansion, and inline row/cell editing.
419
462
  *
420
463
  * @example
464
+ *
465
+ * ```tsx
421
466
  * <DataTable
422
467
  * data={loans}
423
468
  * dataKey="id"
@@ -426,6 +471,7 @@ export declare interface ColumnFilter {
426
471
  * { field: 'amount', header: 'Amount', body: (row) => formatCurrency(row.amount) },
427
472
  * ]}
428
473
  * />
474
+ * ```
429
475
  */
430
476
  export declare function DataTable<T extends object = Record<string, unknown>>({ data, columns, dataKey, selectionMode, selection, onSelectionChange, sortMode, sortField, sortOrder, multiSortMeta, onSort, expansion, editMode, onRowEditSave, onRowEditCancel, onCellEdit, stripedRows, size, showFooter, loading, emptyMessage, scrollable, scrollHeight, className, style, }: DataTableProps<T>): JSX_2.Element;
431
477
 
@@ -527,13 +573,20 @@ export declare interface DataTableProps<T extends object = Record<string, unknow
527
573
  * or pick one from the calendar. Three views: day, month, and year.
528
574
  *
529
575
  * @example
530
- * <DatePicker label="Closing date" value={date} onChange={setDate} />
531
576
  *
577
+ * ```tsx
578
+ * <DatePicker label="Closing date" value={date} onChange={setDate} />
579
+ * ```
532
580
  * @example
533
- * <DatePicker label="Start date" value={date} onChange={setDate} minDate={new Date()} />
534
581
  *
582
+ * ```tsx
583
+ * <DatePicker label="Start date" value={date} onChange={setDate} minDate={new Date()} />
584
+ * ```
535
585
  * @example
586
+ *
587
+ * ```tsx
536
588
  * <DatePicker label="Date" value={date} onChange={setDate} required invalid helperText="Required." />
589
+ * ```
537
590
  */
538
591
  export declare const DatePicker: ForwardRefExoticComponent<DatePickerProps & RefAttributes<HTMLDivElement>>;
539
592
 
@@ -582,6 +635,8 @@ export declare const DEFAULT_DOC_TYPES: string[];
582
635
  * click, or Escape key.
583
636
  *
584
637
  * @example
638
+ *
639
+ * ```tsx
585
640
  * const [open, setOpen] = useState(false);
586
641
  * <Drawer
587
642
  * isOpen={open}
@@ -592,6 +647,7 @@ export declare const DEFAULT_DOC_TYPES: string[];
592
647
  * >
593
648
  * <p>Drawer content here…</p>
594
649
  * </Drawer>
650
+ * ```
595
651
  */
596
652
  export declare const Drawer: ForwardRefExoticComponent<DrawerProps & RefAttributes<HTMLDivElement>>;
597
653
 
@@ -648,6 +704,8 @@ export declare interface DrawerProps {
648
704
  * variant and size system as Button, with a built-in trailing chevron icon.
649
705
  *
650
706
  * @example
707
+ *
708
+ * ```tsx
651
709
  * <DropdownButton
652
710
  * label="Actions"
653
711
  * items={[
@@ -657,9 +715,12 @@ export declare interface DrawerProps {
657
715
  * ]}
658
716
  * onSelect={handleAction}
659
717
  * />
660
- *
718
+ * ```
661
719
  * @example
720
+ *
721
+ * ```tsx
662
722
  * <DropdownButton label="Export" variant="secondary" size="sm" items={exportItems} onSelect={onExport} />
723
+ * ```
663
724
  */
664
725
  export declare const DropdownButton: ForwardRefExoticComponent<DropdownButtonProps & RefAttributes<HTMLDivElement>>;
665
726
 
@@ -707,10 +768,13 @@ export declare type EditMode = 'row' | 'cell';
707
768
  * Invalid file types show an error message below the drop zone.
708
769
  *
709
770
  * @example
771
+ *
772
+ * ```tsx
710
773
  * <FileUpload
711
774
  * onFilesAdded={files => myApi.upload(files)}
712
775
  * onUpload={results => myApi.classify(results)}
713
776
  * />
777
+ * ```
714
778
  */
715
779
  export declare function FileUpload({ onFilesAdded, onUpload, docTypes, accept, initialFiles, className, style, }: FileUploadProps): JSX_2.Element;
716
780
 
@@ -810,13 +874,20 @@ export declare interface FullNavProps {
810
874
  * mouse users — no extra prop needed.
811
875
  *
812
876
  * @example
813
- * <IconButton icon={<i className="pi pi-search" />} aria-label="Search" />
814
877
  *
878
+ * ```tsx
879
+ * <IconButton icon={<i className="pi pi-search" />} aria-label="Search" />
880
+ * ```
815
881
  * @example
816
- * <IconButton icon={<i className="pi pi-trash" />} aria-label="Delete" variant="danger" />
817
882
  *
883
+ * ```tsx
884
+ * <IconButton icon={<i className="pi pi-trash" />} aria-label="Delete" variant="danger" />
885
+ * ```
818
886
  * @example
887
+ *
888
+ * ```tsx
819
889
  * <IconButton icon={<i className="pi pi-plus" />} aria-label="Add" size="sm" />
890
+ * ```
820
891
  */
821
892
  export declare const IconButton: ForwardRefExoticComponent<IconButtonProps & RefAttributes<HTMLButtonElement>>;
822
893
 
@@ -874,28 +945,39 @@ export declare interface InlineContainedAlertProps {
874
945
  * Sizes follow the type scale (sm=10px, md=12px, lg=14px).
875
946
  *
876
947
  * @example
948
+ *
949
+ * ```tsx
877
950
  * // Basic
878
951
  * <InputText label="Search" placeholder="Enter a keyword" />
879
- *
952
+ * ```
880
953
  * @example
954
+ *
955
+ * ```tsx
881
956
  * // Required with helper text
882
957
  * <InputText label="Email" required helperText="We'll never share your email." />
883
- *
958
+ * ```
884
959
  * @example
960
+ *
961
+ * ```tsx
885
962
  * // Invalid / error state
886
963
  * <InputText label="Email" invalid helperText="Please enter a valid email address." />
887
- *
964
+ * ```
888
965
  * @example
966
+ *
967
+ * ```tsx
889
968
  * // With icons
890
969
  * <InputText
891
970
  * label="Search"
892
971
  * prefixIcon={<i className="pi pi-search" />}
893
972
  * suffixIcon={<i className="pi pi-times" />}
894
973
  * />
895
- *
974
+ * ```
896
975
  * @example
976
+ *
977
+ * ```tsx
897
978
  * // Large size
898
979
  * <InputText label="Full name" size="lg" placeholder="Jane Smith" />
980
+ * ```
899
981
  */
900
982
  export declare const InputText: ForwardRefExoticComponent<InputTextProps & RefAttributes<HTMLInputElement>>;
901
983
 
@@ -931,12 +1013,15 @@ export declare interface InputTextProps extends Omit<React.InputHTMLAttributes<H
931
1013
  * A `Tooltip` showing the `aria-label` is rendered automatically on hover.
932
1014
  *
933
1015
  * @example
1016
+ *
1017
+ * ```tsx
934
1018
  * <LightningButton
935
1019
  * variant="basic"
936
1020
  * items={[{ label: 'Copy Loan', value: 'copy' }]}
937
1021
  * onSelect={(v) => console.log(v)}
938
1022
  * aria-label="Quick actions"
939
1023
  * />
1024
+ * ```
940
1025
  */
941
1026
  export declare const LightningButton: ForwardRefExoticComponent<LightningButtonProps & RefAttributes<HTMLButtonElement>>;
942
1027
 
@@ -982,16 +1067,25 @@ export declare interface LightningButtonProps {
982
1067
  * grouped option sets with bold group headers.
983
1068
  *
984
1069
  * @example
985
- * <ListBox options={items} value={val} onChange={setVal} />
986
1070
  *
1071
+ * ```tsx
1072
+ * <ListBox options={items} value={val} onChange={setVal} />
1073
+ * ```
987
1074
  * @example
988
- * <ListBox multiple options={items} value={vals} onChange={setVals} />
989
1075
  *
1076
+ * ```tsx
1077
+ * <ListBox multiple options={items} value={vals} onChange={setVals} />
1078
+ * ```
990
1079
  * @example
991
- * <ListBox multiple filter label="Loan Type" options={items} value={vals} onChange={setVals} />
992
1080
  *
1081
+ * ```tsx
1082
+ * <ListBox multiple filter label="Loan Type" options={items} value={vals} onChange={setVals} />
1083
+ * ```
993
1084
  * @example
1085
+ *
1086
+ * ```tsx
994
1087
  * <ListBox multiple options={groupedItems} value={vals} onChange={setVals} />
1088
+ * ```
995
1089
  */
996
1090
  export declare const ListBox: ForwardRefExoticComponent<ListBoxProps & RefAttributes<HTMLDivElement>>;
997
1091
 
@@ -1055,6 +1149,8 @@ export declare interface ListBoxProps {
1055
1149
  * a `BannerAlert` strip below.
1056
1150
  *
1057
1151
  * @example
1152
+ *
1153
+ * ```tsx
1058
1154
  * <LoanBannerNav
1059
1155
  * tabs={tabs}
1060
1156
  * activeTabId="urla"
@@ -1062,6 +1158,7 @@ export declare interface ListBoxProps {
1062
1158
  * onRefresh={handleRefresh}
1063
1159
  * onPrimary={handleSave}
1064
1160
  * />
1161
+ * ```
1065
1162
  */
1066
1163
  export declare const LoanBannerNav: ForwardRefExoticComponent<LoanBannerNavProps & RefAttributes<HTMLElement>>;
1067
1164
 
@@ -1197,13 +1294,13 @@ export declare interface MentionItem {
1197
1294
  label: string;
1198
1295
  }
1199
1296
 
1200
- export declare function MiscChip({ label, color, dismissible, onDismiss }: MiscChipProps): JSX_2.Element;
1297
+ export declare function MiscChip({ label, color, dismissible, onDismiss, style, forceFocus }: MiscChipProps): JSX_2.Element;
1201
1298
 
1202
1299
  export declare namespace MiscChip {
1203
1300
  var displayName: string;
1204
1301
  }
1205
1302
 
1206
- export declare type MiscChipColor = 'red-darkest' | 'red-light' | 'yellow-darkest' | 'yellow-dark' | 'yellow-light' | 'green-darkest' | 'green-dark' | 'green-light' | 'blue-darkest' | 'blue-dark' | 'blue-light' | 'navy';
1303
+ export declare type MiscChipColor = 'red-darkest' | 'red-dark' | 'red-light' | 'yellow-darkest' | 'yellow-dark' | 'yellow-light' | 'green-darkest' | 'green-dark' | 'green-light' | 'blue-darkest' | 'blue-dark' | 'blue-light' | 'navy-darkest' | 'navy-dark' | 'navy-light';
1207
1304
 
1208
1305
  export declare interface MiscChipProps {
1209
1306
  label: string;
@@ -1214,6 +1311,9 @@ export declare interface MiscChipProps {
1214
1311
  */
1215
1312
  dismissible?: boolean;
1216
1313
  onDismiss?: () => void;
1314
+ style?: React.CSSProperties;
1315
+ /** Forces the dismiss button to render with a visible focus ring — for Storybook focus-state stories. */
1316
+ forceFocus?: boolean;
1217
1317
  }
1218
1318
 
1219
1319
  /**
@@ -1226,6 +1326,8 @@ export declare interface MiscChipProps {
1226
1326
  * Fully controlled — pass `isOpen` + `onClose`.
1227
1327
  *
1228
1328
  * @example
1329
+ *
1330
+ * ```tsx
1229
1331
  * const [open, setOpen] = useState(false);
1230
1332
  * <Modal
1231
1333
  * isOpen={open}
@@ -1240,6 +1342,7 @@ export declare interface MiscChipProps {
1240
1342
  * >
1241
1343
  * <p>Are you sure you want to leave without saving?</p>
1242
1344
  * </Modal>
1345
+ * ```
1243
1346
  */
1244
1347
  export declare const Modal: ForwardRefExoticComponent<ModalProps & RefAttributes<HTMLDivElement>>;
1245
1348
 
@@ -1276,13 +1379,20 @@ export declare interface ModalProps {
1276
1379
  * and a "Select all" toggle. Three sizes follow the type scale.
1277
1380
  *
1278
1381
  * @example
1279
- * <MultiSelect options={items} value={vals} onChange={setVals} label="Loan types" />
1280
1382
  *
1383
+ * ```tsx
1384
+ * <MultiSelect options={items} value={vals} onChange={setVals} label="Loan types" />
1385
+ * ```
1281
1386
  * @example
1282
- * <MultiSelect options={items} value={vals} onChange={setVals} required invalid helperText="Select at least one." />
1283
1387
  *
1388
+ * ```tsx
1389
+ * <MultiSelect options={items} value={vals} onChange={setVals} required invalid helperText="Select at least one." />
1390
+ * ```
1284
1391
  * @example
1392
+ *
1393
+ * ```tsx
1285
1394
  * <MultiSelect options={items} value={vals} onChange={setVals} filter={false} showSelectAll={false} />
1395
+ * ```
1286
1396
  */
1287
1397
  export declare const MultiSelect: ForwardRefExoticComponent<MultiSelectProps & RefAttributes<HTMLDivElement>>;
1288
1398
 
@@ -1361,17 +1471,24 @@ export declare interface PageChangeEvent {
1361
1471
  * paginated list. Three layout templates: `pages`, `report`, and `full`.
1362
1472
  *
1363
1473
  * @example
1474
+ *
1475
+ * ```tsx
1364
1476
  * // Basic page navigation
1365
1477
  * <Paginator totalRecords={200} first={0} rows={10} onPageChange={setPage} />
1366
- *
1478
+ * ```
1367
1479
  * @example
1480
+ *
1481
+ * ```tsx
1368
1482
  * // Text summary instead of page numbers
1369
1483
  * <Paginator totalRecords={200} first={0} rows={10} onPageChange={setPage} template="report" />
1370
- *
1484
+ * ```
1371
1485
  * @example
1486
+ *
1487
+ * ```tsx
1372
1488
  * // Full layout with rows-per-page selector
1373
1489
  * <Paginator totalRecords={200} first={0} rows={10} onPageChange={setPage}
1374
1490
  * template="full" rowsPerPageOptions={[10, 25, 50]} />
1491
+ * ```
1375
1492
  */
1376
1493
  export declare const Paginator: ForwardRefExoticComponent<PaginatorProps & RefAttributes<HTMLDivElement>>;
1377
1494
 
@@ -1410,6 +1527,8 @@ export declare interface PaginatorProps {
1410
1527
  * and `onChange` fires with the updated arrays on every move action.
1411
1528
  *
1412
1529
  * @example
1530
+ *
1531
+ * ```tsx
1413
1532
  * // Simple string list
1414
1533
  * <Picklist
1415
1534
  * sourceItems={source}
@@ -1418,8 +1537,10 @@ export declare interface PaginatorProps {
1418
1537
  * sourceHeader="Available"
1419
1538
  * targetHeader="Selected"
1420
1539
  * />
1421
- *
1540
+ * ```
1422
1541
  * @example
1542
+ *
1543
+ * ```tsx
1423
1544
  * // Table-style rows
1424
1545
  * <Picklist
1425
1546
  * sourceItems={source}
@@ -1429,6 +1550,7 @@ export declare interface PaginatorProps {
1429
1550
  * targetHeader={<MyTableHeader />}
1430
1551
  * itemTemplate={(item) => <MyTableRow item={item} />}
1431
1552
  * />
1553
+ * ```
1432
1554
  */
1433
1555
  export declare const Picklist: ForwardRefExoticComponent<PicklistProps & RefAttributes<HTMLDivElement>>;
1434
1556
 
@@ -1500,6 +1622,8 @@ export declare interface PicklistProps {
1500
1622
  * screen position to place itself; the trigger is responsible for toggling state.
1501
1623
  *
1502
1624
  * @example
1625
+ *
1626
+ * ```tsx
1503
1627
  * const [open, setOpen] = useState(false);
1504
1628
  * <Popup
1505
1629
  * trigger={<Button onClick={() => setOpen(true)}>Details</Button>}
@@ -1510,6 +1634,7 @@ export declare interface PicklistProps {
1510
1634
  * >
1511
1635
  * <p>…content…</p>
1512
1636
  * </Popup>
1637
+ * ```
1513
1638
  */
1514
1639
  export declare const Popup: ForwardRefExoticComponent<PopupProps & RefAttributes<HTMLDivElement>>;
1515
1640
 
@@ -1641,16 +1766,25 @@ export declare interface ProgressSpinnerProps {
1641
1766
  * under a shared `name` prop so the browser enforces single selection.
1642
1767
  *
1643
1768
  * @example
1644
- * <RadioButton name="plan" value="basic" label="Basic" />
1645
1769
  *
1770
+ * ```tsx
1771
+ * <RadioButton name="plan" value="basic" label="Basic" />
1772
+ * ```
1646
1773
  * @example
1647
- * <RadioButton name="plan" value="pro" label="Pro" checked onChange={handleChange} />
1648
1774
  *
1775
+ * ```tsx
1776
+ * <RadioButton name="plan" value="pro" label="Pro" checked onChange={handleChange} />
1777
+ * ```
1649
1778
  * @example
1650
- * <RadioButton name="plan" value="enterprise" label="Enterprise" invalid helperText="Contact sales first." />
1651
1779
  *
1780
+ * ```tsx
1781
+ * <RadioButton name="plan" value="enterprise" label="Enterprise" invalid helperText="Contact sales first." />
1782
+ * ```
1652
1783
  * @example
1784
+ *
1785
+ * ```tsx
1653
1786
  * <RadioButton name="plan" value="basic" label="Small" size="sm" />
1787
+ * ```
1654
1788
  */
1655
1789
  export declare const RadioButton: ForwardRefExoticComponent<RadioButtonProps & RefAttributes<HTMLInputElement>>;
1656
1790
 
@@ -1763,13 +1897,20 @@ export declare interface RuleFilterValue {
1763
1897
  * idle, hover, active/open, filled, invalid, and disabled.
1764
1898
  *
1765
1899
  * @example
1766
- * <Select options={opts} value={val} onChange={setVal} label="Loan type" />
1767
1900
  *
1901
+ * ```tsx
1902
+ * <Select options={opts} value={val} onChange={setVal} label="Loan type" />
1903
+ * ```
1768
1904
  * @example
1769
- * <Select options={opts} value={val} onChange={setVal} required invalid helperText="Required." />
1770
1905
  *
1906
+ * ```tsx
1907
+ * <Select options={opts} value={val} onChange={setVal} required invalid helperText="Required." />
1908
+ * ```
1771
1909
  * @example
1910
+ *
1911
+ * ```tsx
1772
1912
  * <Select options={opts} value={val} onChange={setVal} filter size="lg" />
1913
+ * ```
1773
1914
  */
1774
1915
  export declare const Select: ForwardRefExoticComponent<SelectProps & RefAttributes<HTMLDivElement>>;
1775
1916
 
@@ -1783,6 +1924,8 @@ export declare const Select: ForwardRefExoticComponent<SelectProps & RefAttribut
1783
1924
  * Each option can carry an optional count number and a colored badge indicator.
1784
1925
  *
1785
1926
  * @example
1927
+ *
1928
+ * ```tsx
1786
1929
  * // Toggle group
1787
1930
  * <SelectButton
1788
1931
  * options={[
@@ -1793,8 +1936,10 @@ export declare const Select: ForwardRefExoticComponent<SelectProps & RefAttribut
1793
1936
  * value={view}
1794
1937
  * onChange={setView}
1795
1938
  * />
1796
- *
1939
+ * ```
1797
1940
  * @example
1941
+ *
1942
+ * ```tsx
1798
1943
  * // Dropdown options variant
1799
1944
  * <SelectButton
1800
1945
  * variant="options"
@@ -1803,6 +1948,7 @@ export declare const Select: ForwardRefExoticComponent<SelectProps & RefAttribut
1803
1948
  * onChange={setStatus}
1804
1949
  * label="Status"
1805
1950
  * />
1951
+ * ```
1806
1952
  */
1807
1953
  export declare const SelectButton: ForwardRefExoticComponent<SelectButtonProps & RefAttributes<HTMLDivElement>>;
1808
1954
 
@@ -1925,12 +2071,15 @@ export declare type SeverityChipVariant = 'plain' | 'contrast' | 'error' | 'warn
1925
2071
  * content left when the panel opens.
1926
2072
  *
1927
2073
  * @example
2074
+ *
2075
+ * ```tsx
1928
2076
  * <SidePanelLayout open={open} panelWidth={470}>
1929
2077
  * <main>…page content…</main>
1930
2078
  * </SidePanelLayout>
1931
2079
  * <SidePanel isOpen={open} onClose={() => setOpen(false)} title="Ryan Smith">
1932
2080
  * …panel body…
1933
2081
  * </SidePanel>
2082
+ * ```
1934
2083
  */
1935
2084
  export declare const SidePanel: ForwardRefExoticComponent<SidePanelProps & RefAttributes<HTMLDivElement>>;
1936
2085
 
@@ -1942,10 +2091,13 @@ export declare const SidePanel: ForwardRefExoticComponent<SidePanelProps & RefAt
1942
2091
  * `SidePanel` alongside it (outside this wrapper).
1943
2092
  *
1944
2093
  * @example
2094
+ *
2095
+ * ```tsx
1945
2096
  * <SidePanelLayout open={panelOpen} panelWidth={470}>
1946
2097
  * <main>…page content…</main>
1947
2098
  * </SidePanelLayout>
1948
2099
  * <SidePanel isOpen={panelOpen} onClose={close} title="Details">…</SidePanel>
2100
+ * ```
1949
2101
  */
1950
2102
  export declare const SidePanelLayout: ForwardRefExoticComponent<SidePanelLayoutProps & RefAttributes<HTMLDivElement>>;
1951
2103
 
@@ -2005,6 +2157,8 @@ export declare type SortOrder = 1 | -1;
2005
2157
  * (defaults to `"More options"`) since it has no visible text label.
2006
2158
  *
2007
2159
  * @example
2160
+ *
2161
+ * ```tsx
2008
2162
  * <SplitButton
2009
2163
  * label="Import"
2010
2164
  * onAction={handleImport}
@@ -2015,9 +2169,12 @@ export declare type SortOrder = 1 | -1;
2015
2169
  * ]}
2016
2170
  * onSelect={handleSelect}
2017
2171
  * />
2018
- *
2172
+ * ```
2019
2173
  * @example
2174
+ *
2175
+ * ```tsx
2020
2176
  * <SplitButton label="Save" variant="secondary" onAction={onSave} items={moreActions} onSelect={onSelect} />
2177
+ * ```
2021
2178
  */
2022
2179
  export declare const SplitButton: ForwardRefExoticComponent<SplitButtonProps & RefAttributes<HTMLDivElement>>;
2023
2180
 
@@ -2104,6 +2261,8 @@ export declare interface TabItem {
2104
2261
  * as `<nav>` for the right semantics.
2105
2262
  *
2106
2263
  * @example
2264
+ *
2265
+ * ```tsx
2107
2266
  * // Panel variant (default) — sub-section switcher with content below.
2108
2267
  * const [active, setActive] = useState('tab1');
2109
2268
  * <Tabs
@@ -2114,8 +2273,10 @@ export declare interface TabItem {
2114
2273
  * activeTab={active}
2115
2274
  * onChange={setActive}
2116
2275
  * />
2117
- *
2276
+ * ```
2118
2277
  * @example
2278
+ *
2279
+ * ```tsx
2119
2280
  * // Nav variant — top-level page navigation, no content panel.
2120
2281
  * <Tabs
2121
2282
  * variant="nav"
@@ -2127,6 +2288,7 @@ export declare interface TabItem {
2127
2288
  * activeTab={page}
2128
2289
  * onChange={setPage}
2129
2290
  * />
2291
+ * ```
2130
2292
  */
2131
2293
  export declare const Tabs: ForwardRefExoticComponent<TabsProps & RefAttributes<HTMLDivElement>>;
2132
2294
 
@@ -2157,16 +2319,25 @@ export declare interface TabsProps {
2157
2319
  * invalid, and disabled. Supports optional auto-grow behaviour.
2158
2320
  *
2159
2321
  * @example
2160
- * <TextArea label="Loan notes" placeholder="Enter notes…" rows={4} />
2161
2322
  *
2323
+ * ```tsx
2324
+ * <TextArea label="Loan notes" placeholder="Enter notes…" rows={4} />
2325
+ * ```
2162
2326
  * @example
2163
- * <TextArea label="Comments" maxLength={500} />
2164
2327
  *
2328
+ * ```tsx
2329
+ * <TextArea label="Comments" maxLength={500} />
2330
+ * ```
2165
2331
  * @example
2166
- * <TextArea label="Description" autoGrow />
2167
2332
  *
2333
+ * ```tsx
2334
+ * <TextArea label="Description" autoGrow />
2335
+ * ```
2168
2336
  * @example
2337
+ *
2338
+ * ```tsx
2169
2339
  * <TextArea label="Notes" invalid helperText="This field is required." />
2340
+ * ```
2170
2341
  */
2171
2342
  export declare const TextArea: ForwardRefExoticComponent<TextAreaProps & RefAttributes<HTMLTextAreaElement>>;
2172
2343
 
@@ -2206,8 +2377,11 @@ export declare namespace Toast {
2206
2377
  * Imperative toast API. Requires `<Toaster />` to be mounted in the app.
2207
2378
  *
2208
2379
  * @example
2380
+ *
2381
+ * ```tsx
2209
2382
  * toast.success('Saved', 'Loan application saved successfully.');
2210
2383
  * toast.error('Failed', 'Unable to update loan. Please try again.');
2384
+ * ```
2211
2385
  */
2212
2386
  export declare const toast: {
2213
2387
  success: (title: string, detail?: string, opts?: ToastOptions) => void;
@@ -2220,11 +2394,14 @@ export declare const toast: {
2220
2394
  * Toaster — mount once in your app root to enable toast notifications.
2221
2395
  *
2222
2396
  * @example
2397
+ *
2398
+ * ```tsx
2223
2399
  * // In App.tsx or layout root:
2224
2400
  * <Toaster />
2225
2401
  *
2226
2402
  * // Anywhere else:
2227
2403
  * toast.success('Saved', 'Your changes have been saved.');
2404
+ * ```
2228
2405
  */
2229
2406
  export declare function Toaster(): ReactPortal | null;
2230
2407
 
@@ -2258,13 +2435,20 @@ export declare type ToastSeverity = 'success' | 'info' | 'warn' | 'error';
2258
2435
  * and controlled/uncontrolled usage.
2259
2436
  *
2260
2437
  * @example
2261
- * <ToggleSwitch label="Enable notifications" checked={on} onChange={e => setOn(e.target.checked)} />
2262
2438
  *
2439
+ * ```tsx
2440
+ * <ToggleSwitch label="Enable notifications" checked={on} onChange={e => setOn(e.target.checked)} />
2441
+ * ```
2263
2442
  * @example
2264
- * <ToggleSwitch label="Auto-lock" defaultChecked />
2265
2443
  *
2444
+ * ```tsx
2445
+ * <ToggleSwitch label="Auto-lock" defaultChecked />
2446
+ * ```
2266
2447
  * @example
2448
+ *
2449
+ * ```tsx
2267
2450
  * <ToggleSwitch label="Feature locked" disabled />
2451
+ * ```
2268
2452
  */
2269
2453
  export declare const ToggleSwitch: ForwardRefExoticComponent<ToggleSwitchProps & RefAttributes<HTMLInputElement>>;
2270
2454
 
@@ -2281,14 +2465,24 @@ export declare interface ToggleSwitchProps extends Omit<React.InputHTMLAttribute
2281
2465
  * A small informational bubble anchored to a trigger element. Appears on
2282
2466
  * hover and keyboard focus; hides on mouse leave and blur.
2283
2467
  *
2468
+ * The bubble is rendered through a portal to `document.body` and positioned
2469
+ * with `position: fixed` coordinates measured from the trigger, so it is never
2470
+ * clipped by an ancestor with `overflow: hidden | auto | scroll` (e.g. a
2471
+ * scrollable table or data grid). It tracks the trigger on scroll and resize
2472
+ * while visible, and flips to the opposite side when the preferred side would
2473
+ * run off-screen. (Same portal + fixed-position approach as Popup/Drawer.)
2474
+ *
2284
2475
  * Wraps its child in an inline container — the child itself is not modified.
2285
2476
  * Uses `aria-describedby` to associate the tooltip text with the trigger for
2286
2477
  * screen readers.
2287
2478
  *
2288
2479
  * @example
2480
+ *
2481
+ * ```tsx
2289
2482
  * <Tooltip content="Delete this record" placement="top">
2290
2483
  * <IconButton icon={<i className="pi pi-trash" />} aria-label="Delete" />
2291
2484
  * </Tooltip>
2485
+ * ```
2292
2486
  */
2293
2487
  export declare function Tooltip({ content, children, placement, delay, disabled, maxWidth, className, }: TooltipProps): JSX_2.Element;
2294
2488
 
@@ -2390,6 +2584,8 @@ export declare interface TopBarUserProfile {
2390
2584
  * - **Right section**: optional AUS action buttons + scrollable tab strip
2391
2585
  *
2392
2586
  * @example
2587
+ *
2588
+ * ```tsx
2393
2589
  * <URLATabsNav
2394
2590
  * applicants={[{ id: 'joint', label: 'Ryan Smith | Laura Smith' }]}
2395
2591
  * selectedApplicantId="joint"
@@ -2398,6 +2594,7 @@ export declare interface TopBarUserProfile {
2398
2594
  * activeTabId={activeTab}
2399
2595
  * onTabChange={setActiveTab}
2400
2596
  * />
2597
+ * ```
2401
2598
  */
2402
2599
  export declare const URLATabsNav: ForwardRefExoticComponent<URLATabsNavProps & RefAttributes<HTMLDivElement>>;
2403
2600