@cmgfi/clear-ds 1.2.0 → 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
 
@@ -373,11 +411,18 @@ export declare interface CheckboxProps extends Omit<React.InputHTMLAttributes<HT
373
411
  * panels, toasts, tags, or any overlay. Requires an `aria-label` for
374
412
  * screen-reader context (defaults to `"Close"`).
375
413
  *
414
+ * A `Tooltip` showing the `aria-label` is rendered automatically on hover.
415
+ *
376
416
  * @example
377
- * <CloseButton onClick={onClose} />
378
417
  *
418
+ * ```tsx
419
+ * <CloseButton onClick={onClose} />
420
+ * ```
379
421
  * @example
422
+ *
423
+ * ```tsx
380
424
  * <CloseButton aria-label="Close dialog" size="md" onClick={onClose} />
425
+ * ```
381
426
  */
382
427
  export declare const CloseButton: ForwardRefExoticComponent<CloseButtonProps & RefAttributes<HTMLButtonElement>>;
383
428
 
@@ -416,6 +461,8 @@ export declare interface ColumnFilter {
416
461
  * expandable row groups, nested row expansion, and inline row/cell editing.
417
462
  *
418
463
  * @example
464
+ *
465
+ * ```tsx
419
466
  * <DataTable
420
467
  * data={loans}
421
468
  * dataKey="id"
@@ -424,6 +471,7 @@ export declare interface ColumnFilter {
424
471
  * { field: 'amount', header: 'Amount', body: (row) => formatCurrency(row.amount) },
425
472
  * ]}
426
473
  * />
474
+ * ```
427
475
  */
428
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;
429
477
 
@@ -525,13 +573,20 @@ export declare interface DataTableProps<T extends object = Record<string, unknow
525
573
  * or pick one from the calendar. Three views: day, month, and year.
526
574
  *
527
575
  * @example
528
- * <DatePicker label="Closing date" value={date} onChange={setDate} />
529
576
  *
577
+ * ```tsx
578
+ * <DatePicker label="Closing date" value={date} onChange={setDate} />
579
+ * ```
530
580
  * @example
531
- * <DatePicker label="Start date" value={date} onChange={setDate} minDate={new Date()} />
532
581
  *
582
+ * ```tsx
583
+ * <DatePicker label="Start date" value={date} onChange={setDate} minDate={new Date()} />
584
+ * ```
533
585
  * @example
586
+ *
587
+ * ```tsx
534
588
  * <DatePicker label="Date" value={date} onChange={setDate} required invalid helperText="Required." />
589
+ * ```
535
590
  */
536
591
  export declare const DatePicker: ForwardRefExoticComponent<DatePickerProps & RefAttributes<HTMLDivElement>>;
537
592
 
@@ -580,6 +635,8 @@ export declare const DEFAULT_DOC_TYPES: string[];
580
635
  * click, or Escape key.
581
636
  *
582
637
  * @example
638
+ *
639
+ * ```tsx
583
640
  * const [open, setOpen] = useState(false);
584
641
  * <Drawer
585
642
  * isOpen={open}
@@ -590,6 +647,7 @@ export declare const DEFAULT_DOC_TYPES: string[];
590
647
  * >
591
648
  * <p>Drawer content here…</p>
592
649
  * </Drawer>
650
+ * ```
593
651
  */
594
652
  export declare const Drawer: ForwardRefExoticComponent<DrawerProps & RefAttributes<HTMLDivElement>>;
595
653
 
@@ -646,6 +704,8 @@ export declare interface DrawerProps {
646
704
  * variant and size system as Button, with a built-in trailing chevron icon.
647
705
  *
648
706
  * @example
707
+ *
708
+ * ```tsx
649
709
  * <DropdownButton
650
710
  * label="Actions"
651
711
  * items={[
@@ -655,9 +715,12 @@ export declare interface DrawerProps {
655
715
  * ]}
656
716
  * onSelect={handleAction}
657
717
  * />
658
- *
718
+ * ```
659
719
  * @example
720
+ *
721
+ * ```tsx
660
722
  * <DropdownButton label="Export" variant="secondary" size="sm" items={exportItems} onSelect={onExport} />
723
+ * ```
661
724
  */
662
725
  export declare const DropdownButton: ForwardRefExoticComponent<DropdownButtonProps & RefAttributes<HTMLDivElement>>;
663
726
 
@@ -705,10 +768,13 @@ export declare type EditMode = 'row' | 'cell';
705
768
  * Invalid file types show an error message below the drop zone.
706
769
  *
707
770
  * @example
771
+ *
772
+ * ```tsx
708
773
  * <FileUpload
709
774
  * onFilesAdded={files => myApi.upload(files)}
710
775
  * onUpload={results => myApi.classify(results)}
711
776
  * />
777
+ * ```
712
778
  */
713
779
  export declare function FileUpload({ onFilesAdded, onUpload, docTypes, accept, initialFiles, className, style, }: FileUploadProps): JSX_2.Element;
714
780
 
@@ -804,14 +870,24 @@ export declare interface FullNavProps {
804
870
  * A circular icon-only button. Shares the same variants and sizes as Button.
805
871
  * Always requires an `aria-label` since there is no visible text.
806
872
  *
873
+ * A `Tooltip` showing the `aria-label` is rendered automatically on hover for
874
+ * mouse users — no extra prop needed.
875
+ *
807
876
  * @example
808
- * <IconButton icon={<i className="pi pi-search" />} aria-label="Search" />
809
877
  *
878
+ * ```tsx
879
+ * <IconButton icon={<i className="pi pi-search" />} aria-label="Search" />
880
+ * ```
810
881
  * @example
811
- * <IconButton icon={<i className="pi pi-trash" />} aria-label="Delete" variant="danger" />
812
882
  *
883
+ * ```tsx
884
+ * <IconButton icon={<i className="pi pi-trash" />} aria-label="Delete" variant="danger" />
885
+ * ```
813
886
  * @example
887
+ *
888
+ * ```tsx
814
889
  * <IconButton icon={<i className="pi pi-plus" />} aria-label="Add" size="sm" />
890
+ * ```
815
891
  */
816
892
  export declare const IconButton: ForwardRefExoticComponent<IconButtonProps & RefAttributes<HTMLButtonElement>>;
817
893
 
@@ -869,28 +945,39 @@ export declare interface InlineContainedAlertProps {
869
945
  * Sizes follow the type scale (sm=10px, md=12px, lg=14px).
870
946
  *
871
947
  * @example
948
+ *
949
+ * ```tsx
872
950
  * // Basic
873
951
  * <InputText label="Search" placeholder="Enter a keyword" />
874
- *
952
+ * ```
875
953
  * @example
954
+ *
955
+ * ```tsx
876
956
  * // Required with helper text
877
957
  * <InputText label="Email" required helperText="We'll never share your email." />
878
- *
958
+ * ```
879
959
  * @example
960
+ *
961
+ * ```tsx
880
962
  * // Invalid / error state
881
963
  * <InputText label="Email" invalid helperText="Please enter a valid email address." />
882
- *
964
+ * ```
883
965
  * @example
966
+ *
967
+ * ```tsx
884
968
  * // With icons
885
969
  * <InputText
886
970
  * label="Search"
887
971
  * prefixIcon={<i className="pi pi-search" />}
888
972
  * suffixIcon={<i className="pi pi-times" />}
889
973
  * />
890
- *
974
+ * ```
891
975
  * @example
976
+ *
977
+ * ```tsx
892
978
  * // Large size
893
979
  * <InputText label="Full name" size="lg" placeholder="Jane Smith" />
980
+ * ```
894
981
  */
895
982
  export declare const InputText: ForwardRefExoticComponent<InputTextProps & RefAttributes<HTMLInputElement>>;
896
983
 
@@ -923,13 +1010,18 @@ export declare interface InputTextProps extends Omit<React.InputHTMLAttributes<H
923
1010
  * - `basic` — no visible container, teal icon (default)
924
1011
  * - `filled` — solid teal-700 background
925
1012
  *
1013
+ * A `Tooltip` showing the `aria-label` is rendered automatically on hover.
1014
+ *
926
1015
  * @example
1016
+ *
1017
+ * ```tsx
927
1018
  * <LightningButton
928
1019
  * variant="basic"
929
1020
  * items={[{ label: 'Copy Loan', value: 'copy' }]}
930
1021
  * onSelect={(v) => console.log(v)}
931
1022
  * aria-label="Quick actions"
932
1023
  * />
1024
+ * ```
933
1025
  */
934
1026
  export declare const LightningButton: ForwardRefExoticComponent<LightningButtonProps & RefAttributes<HTMLButtonElement>>;
935
1027
 
@@ -975,16 +1067,25 @@ export declare interface LightningButtonProps {
975
1067
  * grouped option sets with bold group headers.
976
1068
  *
977
1069
  * @example
978
- * <ListBox options={items} value={val} onChange={setVal} />
979
1070
  *
1071
+ * ```tsx
1072
+ * <ListBox options={items} value={val} onChange={setVal} />
1073
+ * ```
980
1074
  * @example
981
- * <ListBox multiple options={items} value={vals} onChange={setVals} />
982
1075
  *
1076
+ * ```tsx
1077
+ * <ListBox multiple options={items} value={vals} onChange={setVals} />
1078
+ * ```
983
1079
  * @example
984
- * <ListBox multiple filter label="Loan Type" options={items} value={vals} onChange={setVals} />
985
1080
  *
1081
+ * ```tsx
1082
+ * <ListBox multiple filter label="Loan Type" options={items} value={vals} onChange={setVals} />
1083
+ * ```
986
1084
  * @example
1085
+ *
1086
+ * ```tsx
987
1087
  * <ListBox multiple options={groupedItems} value={vals} onChange={setVals} />
1088
+ * ```
988
1089
  */
989
1090
  export declare const ListBox: ForwardRefExoticComponent<ListBoxProps & RefAttributes<HTMLDivElement>>;
990
1091
 
@@ -1048,6 +1149,8 @@ export declare interface ListBoxProps {
1048
1149
  * a `BannerAlert` strip below.
1049
1150
  *
1050
1151
  * @example
1152
+ *
1153
+ * ```tsx
1051
1154
  * <LoanBannerNav
1052
1155
  * tabs={tabs}
1053
1156
  * activeTabId="urla"
@@ -1055,6 +1158,7 @@ export declare interface ListBoxProps {
1055
1158
  * onRefresh={handleRefresh}
1056
1159
  * onPrimary={handleSave}
1057
1160
  * />
1161
+ * ```
1058
1162
  */
1059
1163
  export declare const LoanBannerNav: ForwardRefExoticComponent<LoanBannerNavProps & RefAttributes<HTMLElement>>;
1060
1164
 
@@ -1190,13 +1294,13 @@ export declare interface MentionItem {
1190
1294
  label: string;
1191
1295
  }
1192
1296
 
1193
- 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;
1194
1298
 
1195
1299
  export declare namespace MiscChip {
1196
1300
  var displayName: string;
1197
1301
  }
1198
1302
 
1199
- 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';
1200
1304
 
1201
1305
  export declare interface MiscChipProps {
1202
1306
  label: string;
@@ -1207,6 +1311,9 @@ export declare interface MiscChipProps {
1207
1311
  */
1208
1312
  dismissible?: boolean;
1209
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;
1210
1317
  }
1211
1318
 
1212
1319
  /**
@@ -1219,6 +1326,8 @@ export declare interface MiscChipProps {
1219
1326
  * Fully controlled — pass `isOpen` + `onClose`.
1220
1327
  *
1221
1328
  * @example
1329
+ *
1330
+ * ```tsx
1222
1331
  * const [open, setOpen] = useState(false);
1223
1332
  * <Modal
1224
1333
  * isOpen={open}
@@ -1233,6 +1342,7 @@ export declare interface MiscChipProps {
1233
1342
  * >
1234
1343
  * <p>Are you sure you want to leave without saving?</p>
1235
1344
  * </Modal>
1345
+ * ```
1236
1346
  */
1237
1347
  export declare const Modal: ForwardRefExoticComponent<ModalProps & RefAttributes<HTMLDivElement>>;
1238
1348
 
@@ -1269,13 +1379,20 @@ export declare interface ModalProps {
1269
1379
  * and a "Select all" toggle. Three sizes follow the type scale.
1270
1380
  *
1271
1381
  * @example
1272
- * <MultiSelect options={items} value={vals} onChange={setVals} label="Loan types" />
1273
1382
  *
1383
+ * ```tsx
1384
+ * <MultiSelect options={items} value={vals} onChange={setVals} label="Loan types" />
1385
+ * ```
1274
1386
  * @example
1275
- * <MultiSelect options={items} value={vals} onChange={setVals} required invalid helperText="Select at least one." />
1276
1387
  *
1388
+ * ```tsx
1389
+ * <MultiSelect options={items} value={vals} onChange={setVals} required invalid helperText="Select at least one." />
1390
+ * ```
1277
1391
  * @example
1392
+ *
1393
+ * ```tsx
1278
1394
  * <MultiSelect options={items} value={vals} onChange={setVals} filter={false} showSelectAll={false} />
1395
+ * ```
1279
1396
  */
1280
1397
  export declare const MultiSelect: ForwardRefExoticComponent<MultiSelectProps & RefAttributes<HTMLDivElement>>;
1281
1398
 
@@ -1354,17 +1471,24 @@ export declare interface PageChangeEvent {
1354
1471
  * paginated list. Three layout templates: `pages`, `report`, and `full`.
1355
1472
  *
1356
1473
  * @example
1474
+ *
1475
+ * ```tsx
1357
1476
  * // Basic page navigation
1358
1477
  * <Paginator totalRecords={200} first={0} rows={10} onPageChange={setPage} />
1359
- *
1478
+ * ```
1360
1479
  * @example
1480
+ *
1481
+ * ```tsx
1361
1482
  * // Text summary instead of page numbers
1362
1483
  * <Paginator totalRecords={200} first={0} rows={10} onPageChange={setPage} template="report" />
1363
- *
1484
+ * ```
1364
1485
  * @example
1486
+ *
1487
+ * ```tsx
1365
1488
  * // Full layout with rows-per-page selector
1366
1489
  * <Paginator totalRecords={200} first={0} rows={10} onPageChange={setPage}
1367
1490
  * template="full" rowsPerPageOptions={[10, 25, 50]} />
1491
+ * ```
1368
1492
  */
1369
1493
  export declare const Paginator: ForwardRefExoticComponent<PaginatorProps & RefAttributes<HTMLDivElement>>;
1370
1494
 
@@ -1403,6 +1527,8 @@ export declare interface PaginatorProps {
1403
1527
  * and `onChange` fires with the updated arrays on every move action.
1404
1528
  *
1405
1529
  * @example
1530
+ *
1531
+ * ```tsx
1406
1532
  * // Simple string list
1407
1533
  * <Picklist
1408
1534
  * sourceItems={source}
@@ -1411,8 +1537,10 @@ export declare interface PaginatorProps {
1411
1537
  * sourceHeader="Available"
1412
1538
  * targetHeader="Selected"
1413
1539
  * />
1414
- *
1540
+ * ```
1415
1541
  * @example
1542
+ *
1543
+ * ```tsx
1416
1544
  * // Table-style rows
1417
1545
  * <Picklist
1418
1546
  * sourceItems={source}
@@ -1422,6 +1550,7 @@ export declare interface PaginatorProps {
1422
1550
  * targetHeader={<MyTableHeader />}
1423
1551
  * itemTemplate={(item) => <MyTableRow item={item} />}
1424
1552
  * />
1553
+ * ```
1425
1554
  */
1426
1555
  export declare const Picklist: ForwardRefExoticComponent<PicklistProps & RefAttributes<HTMLDivElement>>;
1427
1556
 
@@ -1493,6 +1622,8 @@ export declare interface PicklistProps {
1493
1622
  * screen position to place itself; the trigger is responsible for toggling state.
1494
1623
  *
1495
1624
  * @example
1625
+ *
1626
+ * ```tsx
1496
1627
  * const [open, setOpen] = useState(false);
1497
1628
  * <Popup
1498
1629
  * trigger={<Button onClick={() => setOpen(true)}>Details</Button>}
@@ -1503,6 +1634,7 @@ export declare interface PicklistProps {
1503
1634
  * >
1504
1635
  * <p>…content…</p>
1505
1636
  * </Popup>
1637
+ * ```
1506
1638
  */
1507
1639
  export declare const Popup: ForwardRefExoticComponent<PopupProps & RefAttributes<HTMLDivElement>>;
1508
1640
 
@@ -1634,16 +1766,25 @@ export declare interface ProgressSpinnerProps {
1634
1766
  * under a shared `name` prop so the browser enforces single selection.
1635
1767
  *
1636
1768
  * @example
1637
- * <RadioButton name="plan" value="basic" label="Basic" />
1638
1769
  *
1770
+ * ```tsx
1771
+ * <RadioButton name="plan" value="basic" label="Basic" />
1772
+ * ```
1639
1773
  * @example
1640
- * <RadioButton name="plan" value="pro" label="Pro" checked onChange={handleChange} />
1641
1774
  *
1775
+ * ```tsx
1776
+ * <RadioButton name="plan" value="pro" label="Pro" checked onChange={handleChange} />
1777
+ * ```
1642
1778
  * @example
1643
- * <RadioButton name="plan" value="enterprise" label="Enterprise" invalid helperText="Contact sales first." />
1644
1779
  *
1780
+ * ```tsx
1781
+ * <RadioButton name="plan" value="enterprise" label="Enterprise" invalid helperText="Contact sales first." />
1782
+ * ```
1645
1783
  * @example
1784
+ *
1785
+ * ```tsx
1646
1786
  * <RadioButton name="plan" value="basic" label="Small" size="sm" />
1787
+ * ```
1647
1788
  */
1648
1789
  export declare const RadioButton: ForwardRefExoticComponent<RadioButtonProps & RefAttributes<HTMLInputElement>>;
1649
1790
 
@@ -1756,13 +1897,20 @@ export declare interface RuleFilterValue {
1756
1897
  * idle, hover, active/open, filled, invalid, and disabled.
1757
1898
  *
1758
1899
  * @example
1759
- * <Select options={opts} value={val} onChange={setVal} label="Loan type" />
1760
1900
  *
1901
+ * ```tsx
1902
+ * <Select options={opts} value={val} onChange={setVal} label="Loan type" />
1903
+ * ```
1761
1904
  * @example
1762
- * <Select options={opts} value={val} onChange={setVal} required invalid helperText="Required." />
1763
1905
  *
1906
+ * ```tsx
1907
+ * <Select options={opts} value={val} onChange={setVal} required invalid helperText="Required." />
1908
+ * ```
1764
1909
  * @example
1910
+ *
1911
+ * ```tsx
1765
1912
  * <Select options={opts} value={val} onChange={setVal} filter size="lg" />
1913
+ * ```
1766
1914
  */
1767
1915
  export declare const Select: ForwardRefExoticComponent<SelectProps & RefAttributes<HTMLDivElement>>;
1768
1916
 
@@ -1776,6 +1924,8 @@ export declare const Select: ForwardRefExoticComponent<SelectProps & RefAttribut
1776
1924
  * Each option can carry an optional count number and a colored badge indicator.
1777
1925
  *
1778
1926
  * @example
1927
+ *
1928
+ * ```tsx
1779
1929
  * // Toggle group
1780
1930
  * <SelectButton
1781
1931
  * options={[
@@ -1786,8 +1936,10 @@ export declare const Select: ForwardRefExoticComponent<SelectProps & RefAttribut
1786
1936
  * value={view}
1787
1937
  * onChange={setView}
1788
1938
  * />
1789
- *
1939
+ * ```
1790
1940
  * @example
1941
+ *
1942
+ * ```tsx
1791
1943
  * // Dropdown options variant
1792
1944
  * <SelectButton
1793
1945
  * variant="options"
@@ -1796,6 +1948,7 @@ export declare const Select: ForwardRefExoticComponent<SelectProps & RefAttribut
1796
1948
  * onChange={setStatus}
1797
1949
  * label="Status"
1798
1950
  * />
1951
+ * ```
1799
1952
  */
1800
1953
  export declare const SelectButton: ForwardRefExoticComponent<SelectButtonProps & RefAttributes<HTMLDivElement>>;
1801
1954
 
@@ -1918,12 +2071,15 @@ export declare type SeverityChipVariant = 'plain' | 'contrast' | 'error' | 'warn
1918
2071
  * content left when the panel opens.
1919
2072
  *
1920
2073
  * @example
2074
+ *
2075
+ * ```tsx
1921
2076
  * <SidePanelLayout open={open} panelWidth={470}>
1922
2077
  * <main>…page content…</main>
1923
2078
  * </SidePanelLayout>
1924
2079
  * <SidePanel isOpen={open} onClose={() => setOpen(false)} title="Ryan Smith">
1925
2080
  * …panel body…
1926
2081
  * </SidePanel>
2082
+ * ```
1927
2083
  */
1928
2084
  export declare const SidePanel: ForwardRefExoticComponent<SidePanelProps & RefAttributes<HTMLDivElement>>;
1929
2085
 
@@ -1935,10 +2091,13 @@ export declare const SidePanel: ForwardRefExoticComponent<SidePanelProps & RefAt
1935
2091
  * `SidePanel` alongside it (outside this wrapper).
1936
2092
  *
1937
2093
  * @example
2094
+ *
2095
+ * ```tsx
1938
2096
  * <SidePanelLayout open={panelOpen} panelWidth={470}>
1939
2097
  * <main>…page content…</main>
1940
2098
  * </SidePanelLayout>
1941
2099
  * <SidePanel isOpen={panelOpen} onClose={close} title="Details">…</SidePanel>
2100
+ * ```
1942
2101
  */
1943
2102
  export declare const SidePanelLayout: ForwardRefExoticComponent<SidePanelLayoutProps & RefAttributes<HTMLDivElement>>;
1944
2103
 
@@ -1994,7 +2153,12 @@ export declare type SortOrder = 1 | -1;
1994
2153
  * - **Left** (main): executes the primary action when clicked.
1995
2154
  * - **Right** (trigger): opens a dropdown of secondary actions.
1996
2155
  *
2156
+ * The dropdown trigger shows a `Tooltip` with `triggerAriaLabel` on hover
2157
+ * (defaults to `"More options"`) since it has no visible text label.
2158
+ *
1997
2159
  * @example
2160
+ *
2161
+ * ```tsx
1998
2162
  * <SplitButton
1999
2163
  * label="Import"
2000
2164
  * onAction={handleImport}
@@ -2005,9 +2169,12 @@ export declare type SortOrder = 1 | -1;
2005
2169
  * ]}
2006
2170
  * onSelect={handleSelect}
2007
2171
  * />
2008
- *
2172
+ * ```
2009
2173
  * @example
2174
+ *
2175
+ * ```tsx
2010
2176
  * <SplitButton label="Save" variant="secondary" onAction={onSave} items={moreActions} onSelect={onSelect} />
2177
+ * ```
2011
2178
  */
2012
2179
  export declare const SplitButton: ForwardRefExoticComponent<SplitButtonProps & RefAttributes<HTMLDivElement>>;
2013
2180
 
@@ -2094,6 +2261,8 @@ export declare interface TabItem {
2094
2261
  * as `<nav>` for the right semantics.
2095
2262
  *
2096
2263
  * @example
2264
+ *
2265
+ * ```tsx
2097
2266
  * // Panel variant (default) — sub-section switcher with content below.
2098
2267
  * const [active, setActive] = useState('tab1');
2099
2268
  * <Tabs
@@ -2104,8 +2273,10 @@ export declare interface TabItem {
2104
2273
  * activeTab={active}
2105
2274
  * onChange={setActive}
2106
2275
  * />
2107
- *
2276
+ * ```
2108
2277
  * @example
2278
+ *
2279
+ * ```tsx
2109
2280
  * // Nav variant — top-level page navigation, no content panel.
2110
2281
  * <Tabs
2111
2282
  * variant="nav"
@@ -2117,6 +2288,7 @@ export declare interface TabItem {
2117
2288
  * activeTab={page}
2118
2289
  * onChange={setPage}
2119
2290
  * />
2291
+ * ```
2120
2292
  */
2121
2293
  export declare const Tabs: ForwardRefExoticComponent<TabsProps & RefAttributes<HTMLDivElement>>;
2122
2294
 
@@ -2147,16 +2319,25 @@ export declare interface TabsProps {
2147
2319
  * invalid, and disabled. Supports optional auto-grow behaviour.
2148
2320
  *
2149
2321
  * @example
2150
- * <TextArea label="Loan notes" placeholder="Enter notes…" rows={4} />
2151
2322
  *
2323
+ * ```tsx
2324
+ * <TextArea label="Loan notes" placeholder="Enter notes…" rows={4} />
2325
+ * ```
2152
2326
  * @example
2153
- * <TextArea label="Comments" maxLength={500} />
2154
2327
  *
2328
+ * ```tsx
2329
+ * <TextArea label="Comments" maxLength={500} />
2330
+ * ```
2155
2331
  * @example
2156
- * <TextArea label="Description" autoGrow />
2157
2332
  *
2333
+ * ```tsx
2334
+ * <TextArea label="Description" autoGrow />
2335
+ * ```
2158
2336
  * @example
2337
+ *
2338
+ * ```tsx
2159
2339
  * <TextArea label="Notes" invalid helperText="This field is required." />
2340
+ * ```
2160
2341
  */
2161
2342
  export declare const TextArea: ForwardRefExoticComponent<TextAreaProps & RefAttributes<HTMLTextAreaElement>>;
2162
2343
 
@@ -2196,8 +2377,11 @@ export declare namespace Toast {
2196
2377
  * Imperative toast API. Requires `<Toaster />` to be mounted in the app.
2197
2378
  *
2198
2379
  * @example
2380
+ *
2381
+ * ```tsx
2199
2382
  * toast.success('Saved', 'Loan application saved successfully.');
2200
2383
  * toast.error('Failed', 'Unable to update loan. Please try again.');
2384
+ * ```
2201
2385
  */
2202
2386
  export declare const toast: {
2203
2387
  success: (title: string, detail?: string, opts?: ToastOptions) => void;
@@ -2210,11 +2394,14 @@ export declare const toast: {
2210
2394
  * Toaster — mount once in your app root to enable toast notifications.
2211
2395
  *
2212
2396
  * @example
2397
+ *
2398
+ * ```tsx
2213
2399
  * // In App.tsx or layout root:
2214
2400
  * <Toaster />
2215
2401
  *
2216
2402
  * // Anywhere else:
2217
2403
  * toast.success('Saved', 'Your changes have been saved.');
2404
+ * ```
2218
2405
  */
2219
2406
  export declare function Toaster(): ReactPortal | null;
2220
2407
 
@@ -2248,13 +2435,20 @@ export declare type ToastSeverity = 'success' | 'info' | 'warn' | 'error';
2248
2435
  * and controlled/uncontrolled usage.
2249
2436
  *
2250
2437
  * @example
2251
- * <ToggleSwitch label="Enable notifications" checked={on} onChange={e => setOn(e.target.checked)} />
2252
2438
  *
2439
+ * ```tsx
2440
+ * <ToggleSwitch label="Enable notifications" checked={on} onChange={e => setOn(e.target.checked)} />
2441
+ * ```
2253
2442
  * @example
2254
- * <ToggleSwitch label="Auto-lock" defaultChecked />
2255
2443
  *
2444
+ * ```tsx
2445
+ * <ToggleSwitch label="Auto-lock" defaultChecked />
2446
+ * ```
2256
2447
  * @example
2448
+ *
2449
+ * ```tsx
2257
2450
  * <ToggleSwitch label="Feature locked" disabled />
2451
+ * ```
2258
2452
  */
2259
2453
  export declare const ToggleSwitch: ForwardRefExoticComponent<ToggleSwitchProps & RefAttributes<HTMLInputElement>>;
2260
2454
 
@@ -2271,14 +2465,24 @@ export declare interface ToggleSwitchProps extends Omit<React.InputHTMLAttribute
2271
2465
  * A small informational bubble anchored to a trigger element. Appears on
2272
2466
  * hover and keyboard focus; hides on mouse leave and blur.
2273
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
+ *
2274
2475
  * Wraps its child in an inline container — the child itself is not modified.
2275
2476
  * Uses `aria-describedby` to associate the tooltip text with the trigger for
2276
2477
  * screen readers.
2277
2478
  *
2278
2479
  * @example
2480
+ *
2481
+ * ```tsx
2279
2482
  * <Tooltip content="Delete this record" placement="top">
2280
2483
  * <IconButton icon={<i className="pi pi-trash" />} aria-label="Delete" />
2281
2484
  * </Tooltip>
2485
+ * ```
2282
2486
  */
2283
2487
  export declare function Tooltip({ content, children, placement, delay, disabled, maxWidth, className, }: TooltipProps): JSX_2.Element;
2284
2488
 
@@ -2380,6 +2584,8 @@ export declare interface TopBarUserProfile {
2380
2584
  * - **Right section**: optional AUS action buttons + scrollable tab strip
2381
2585
  *
2382
2586
  * @example
2587
+ *
2588
+ * ```tsx
2383
2589
  * <URLATabsNav
2384
2590
  * applicants={[{ id: 'joint', label: 'Ryan Smith | Laura Smith' }]}
2385
2591
  * selectedApplicantId="joint"
@@ -2388,6 +2594,7 @@ export declare interface TopBarUserProfile {
2388
2594
  * activeTabId={activeTab}
2389
2595
  * onTabChange={setActiveTab}
2390
2596
  * />
2597
+ * ```
2391
2598
  */
2392
2599
  export declare const URLATabsNav: ForwardRefExoticComponent<URLATabsNavProps & RefAttributes<HTMLDivElement>>;
2393
2600