wjec-one 4.1.0 → 4.2.0-alpha.0

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/README.md CHANGED
@@ -1050,6 +1050,19 @@ Here is a list of our components along with some documentation for them.
1050
1050
  <th>Description</th>
1051
1051
  </tr>
1052
1052
  </thead><tbody>
1053
+ <tr>
1054
+ <td>ariaControlLabels</td>
1055
+ <td><code>{ dot: string; next: string; previous: string; }</code></td>
1056
+ <td>false</td>
1057
+ <td><code>{
1058
+ dot: 'Go to slide {index}',
1059
+ next: 'Go to next slide',
1060
+ previous: 'Go to previous slide'
1061
+ }</code></td>
1062
+ <td>Accessibility labels for slide controls</td>
1063
+ </tr>
1064
+ </tbody>
1065
+ <tbody>
1053
1066
  <tr>
1054
1067
  <td>buffer</td>
1055
1068
  <td><code>number</code></td>
@@ -1121,6 +1134,15 @@ Here is a list of our components along with some documentation for them.
1121
1134
  <td>The duration (in milliseconds) of the transition between slides</td>
1122
1135
  </tr>
1123
1136
  </tbody>
1137
+ <tbody>
1138
+ <tr>
1139
+ <td>slideWidth</td>
1140
+ <td><code>Width<string , number></code></td>
1141
+ <td>false</td>
1142
+ <td><code>100%</code></td>
1143
+ <td>The width of each slide relative to the container</td>
1144
+ </tr>
1145
+ </tbody>
1124
1146
  <tbody>
1125
1147
  <tr>
1126
1148
  <td>id</td>
@@ -1458,6 +1480,53 @@ Once the component unmounts, React will set `ref.current` to `null`
1458
1480
  <th>Description</th>
1459
1481
  </tr>
1460
1482
  </thead><tbody>
1483
+ <tr>
1484
+ <td>icon</td>
1485
+ <td><code>(props: SVGProps<SVGSVGElement>) => SVGComponent</code></td>
1486
+ <td>false</td>
1487
+ <td><code>-</code></td>
1488
+ <td>An SVG component that will be rendered to the left of the Input's content. Usually used to denote the purpose of the input field (for example, an envelope icon for "email address")</td>
1489
+ </tr>
1490
+ </tbody>
1491
+ <tbody>
1492
+ <tr>
1493
+ <td>label</td>
1494
+ <td><code>FormattedString</code></td>
1495
+ <td>false</td>
1496
+ <td><code>-</code></td>
1497
+ <td>The text that will be displayed as the Input's label</td>
1498
+ </tr>
1499
+ </tbody>
1500
+ <tbody>
1501
+ <tr>
1502
+ <td>onChange</td>
1503
+ <td><code>(value: string) => void</code></td>
1504
+ <td>false</td>
1505
+ <td><code>-</code></td>
1506
+ <td>A handler that will be invoked each time the content of the Input is changed. Provides the latest value as the only argument
1507
+ @param value The updated value of the Input
1508
+ @returns void</td>
1509
+ </tr>
1510
+ </tbody>
1511
+ <tbody>
1512
+ <tr>
1513
+ <td>placeholder</td>
1514
+ <td><code>string</code></td>
1515
+ <td>false</td>
1516
+ <td><code>-</code></td>
1517
+ <td>The text that will be displayed as the Input's placeholder when no value is present</td>
1518
+ </tr>
1519
+ </tbody>
1520
+ <tbody>
1521
+ <tr>
1522
+ <td>value</td>
1523
+ <td><code>string</code></td>
1524
+ <td>false</td>
1525
+ <td><code>-</code></td>
1526
+ <td>A string that will be used as the value of the Input</td>
1527
+ </tr>
1528
+ </tbody>
1529
+ <tbody>
1461
1530
  <tr>
1462
1531
  <td>clearButtonBehaviour</td>
1463
1532
  <td><code>"clear" , "clearAndClose" , "close"</code></td>
@@ -1504,24 +1573,6 @@ Once the component unmounts, React will set `ref.current` to `null`
1504
1573
  <td>-</td>
1505
1574
  </tr>
1506
1575
  </tbody>
1507
- <tbody>
1508
- <tr>
1509
- <td>icon</td>
1510
- <td><code>(props: SVGProps<SVGSVGElement>) => SVGComponent</code></td>
1511
- <td>false</td>
1512
- <td><code>-</code></td>
1513
- <td>-</td>
1514
- </tr>
1515
- </tbody>
1516
- <tbody>
1517
- <tr>
1518
- <td>label</td>
1519
- <td><code>FormattedString</code></td>
1520
- <td>false</td>
1521
- <td><code>-</code></td>
1522
- <td>-</td>
1523
- </tr>
1524
- </tbody>
1525
1576
  <tbody>
1526
1577
  <tr>
1527
1578
  <td>loading</td>
@@ -1549,15 +1600,6 @@ Once the component unmounts, React will set `ref.current` to `null`
1549
1600
  <td>-</td>
1550
1601
  </tr>
1551
1602
  </tbody>
1552
- <tbody>
1553
- <tr>
1554
- <td>onChange</td>
1555
- <td><code>(value: string) => void</code></td>
1556
- <td>false</td>
1557
- <td><code>-</code></td>
1558
- <td>-</td>
1559
- </tr>
1560
- </tbody>
1561
1603
  <tbody>
1562
1604
  <tr>
1563
1605
  <td>onFilter</td>
@@ -1581,7 +1623,7 @@ Once the component unmounts, React will set `ref.current` to `null`
1581
1623
  <td>optionTemplate</td>
1582
1624
  <td><code>FC<{ option: T; index: number; filteredOptions: T[]; }></code></td>
1583
1625
  <td>false</td>
1584
- <td><code>({ option }) => <React.Fragment>{option as string | number | boolean}</React.Fragment></code></td>
1626
+ <td><code>({ option }) => <React.Fragment>{option.toString()}</React.Fragment></code></td>
1585
1627
  <td>-</td>
1586
1628
  </tr>
1587
1629
  </tbody>
@@ -1596,19 +1638,10 @@ Once the component unmounts, React will set `ref.current` to `null`
1596
1638
  </tbody>
1597
1639
  <tbody>
1598
1640
  <tr>
1599
- <td>placeholder</td>
1600
- <td><code>string</code></td>
1601
- <td>false</td>
1602
- <td><code>-</code></td>
1603
- <td>-</td>
1604
- </tr>
1605
- </tbody>
1606
- <tbody>
1607
- <tr>
1608
- <td>value</td>
1641
+ <td>ariaLabel</td>
1609
1642
  <td><code>string</code></td>
1610
1643
  <td>false</td>
1611
- <td><code>-</code></td>
1644
+ <td><code>formattedStringToPlainText(label)</code></td>
1612
1645
  <td>-</td>
1613
1646
  </tr>
1614
1647
  </tbody>
@@ -1617,25 +1650,11 @@ Once the component unmounts, React will set `ref.current` to `null`
1617
1650
  <td>ariaCloseLabel</td>
1618
1651
  <td><code>string</code></td>
1619
1652
  <td>false</td>
1620
- <td><code>-</code></td>
1621
- <td>-</td>
1622
- </tr>
1623
- </tbody>
1624
- <tbody>
1625
- <tr>
1626
- <td>ariaExpanded</td>
1627
- <td><code>boolean</code></td>
1628
- <td>false</td>
1629
- <td><code>-</code></td>
1630
- <td>-</td>
1631
- </tr>
1632
- </tbody>
1633
- <tbody>
1634
- <tr>
1635
- <td>ariaLabel</td>
1636
- <td><code>string</code></td>
1637
- <td>false</td>
1638
- <td><code>-</code></td>
1653
+ <td><code>clearButtonBehaviour === 'clear'
1654
+ ? 'Clear filter'
1655
+ : clearButtonBehaviour === 'clearAndClose'
1656
+ ? 'Clear filter and close list'
1657
+ : 'Close list'</code></td>
1639
1658
  <td>-</td>
1640
1659
  </tr>
1641
1660
  </tbody>
@@ -1648,24 +1667,6 @@ Once the component unmounts, React will set `ref.current` to `null`
1648
1667
  <td>-</td>
1649
1668
  </tr>
1650
1669
  </tbody>
1651
- <tbody>
1652
- <tr>
1653
- <td>ariaPosInSet</td>
1654
- <td><code>number</code></td>
1655
- <td>false</td>
1656
- <td><code>-</code></td>
1657
- <td>-</td>
1658
- </tr>
1659
- </tbody>
1660
- <tbody>
1661
- <tr>
1662
- <td>ariaSetSize</td>
1663
- <td><code>number</code></td>
1664
- <td>false</td>
1665
- <td><code>-</code></td>
1666
- <td>-</td>
1667
- </tr>
1668
- </tbody>
1669
1670
  <tbody>
1670
1671
  <tr>
1671
1672
  <td>id</td>
@@ -1921,16 +1922,16 @@ The identifier that will be passed through to the underlying HTML element</td>
1921
1922
  </tr>
1922
1923
  </thead><tbody>
1923
1924
  <tr>
1924
- <td>type</td>
1925
- <td><code>"time" , "date" , "dateTime"</code></td>
1925
+ <td>date</td>
1926
+ <td><code>Date</code></td>
1926
1927
  <td>false</td>
1927
- <td><code>dateTime</code></td>
1928
+ <td><code>-</code></td>
1928
1929
  <td>-</td>
1929
1930
  </tr>
1930
1931
  </tbody>
1931
1932
  <tbody>
1932
1933
  <tr>
1933
- <td>date</td>
1934
+ <td>maxDate</td>
1934
1935
  <td><code>Date</code></td>
1935
1936
  <td>false</td>
1936
1937
  <td><code>-</code></td>
@@ -1939,8 +1940,8 @@ The identifier that will be passed through to the underlying HTML element</td>
1939
1940
  </tbody>
1940
1941
  <tbody>
1941
1942
  <tr>
1942
- <td>disabled</td>
1943
- <td><code>boolean</code></td>
1943
+ <td>minDate</td>
1944
+ <td><code>Date</code></td>
1944
1945
  <td>false</td>
1945
1946
  <td><code>-</code></td>
1946
1947
  <td>-</td>
@@ -1948,8 +1949,8 @@ The identifier that will be passed through to the underlying HTML element</td>
1948
1949
  </tbody>
1949
1950
  <tbody>
1950
1951
  <tr>
1951
- <td>label</td>
1952
- <td><code>any</code></td>
1952
+ <td>onChangeDate</td>
1953
+ <td><code>(date: Date) => void</code></td>
1953
1954
  <td>false</td>
1954
1955
  <td><code>-</code></td>
1955
1956
  <td>-</td>
@@ -1957,8 +1958,17 @@ The identifier that will be passed through to the underlying HTML element</td>
1957
1958
  </tbody>
1958
1959
  <tbody>
1959
1960
  <tr>
1960
- <td>maxDate</td>
1961
- <td><code>Date</code></td>
1961
+ <td>type</td>
1962
+ <td><code>"date" , "time" , "dateTime"</code></td>
1963
+ <td>false</td>
1964
+ <td><code>dateTime</code></td>
1965
+ <td>-</td>
1966
+ </tr>
1967
+ </tbody>
1968
+ <tbody>
1969
+ <tr>
1970
+ <td>description</td>
1971
+ <td><code>string</code></td>
1962
1972
  <td>false</td>
1963
1973
  <td><code>-</code></td>
1964
1974
  <td>-</td>
@@ -1966,8 +1976,8 @@ The identifier that will be passed through to the underlying HTML element</td>
1966
1976
  </tbody>
1967
1977
  <tbody>
1968
1978
  <tr>
1969
- <td>minDate</td>
1970
- <td><code>Date</code></td>
1979
+ <td>disabled</td>
1980
+ <td><code>boolean</code></td>
1971
1981
  <td>false</td>
1972
1982
  <td><code>-</code></td>
1973
1983
  <td>-</td>
@@ -1975,8 +1985,8 @@ The identifier that will be passed through to the underlying HTML element</td>
1975
1985
  </tbody>
1976
1986
  <tbody>
1977
1987
  <tr>
1978
- <td>onChangeDate</td>
1979
- <td><code>(date: Date) => void</code></td>
1988
+ <td>label</td>
1989
+ <td><code>any</code></td>
1980
1990
  <td>false</td>
1981
1991
  <td><code>-</code></td>
1982
1992
  <td>-</td>
@@ -2002,8 +2012,8 @@ The identifier that will be passed through to the underlying HTML element</td>
2002
2012
  </tbody>
2003
2013
  <tbody>
2004
2014
  <tr>
2005
- <td>required</td>
2006
- <td><code>boolean</code></td>
2015
+ <td>status</td>
2016
+ <td><code>"error" , "success" , "warning"</code></td>
2007
2017
  <td>false</td>
2008
2018
  <td><code>-</code></td>
2009
2019
  <td>-</td>
@@ -2011,8 +2021,8 @@ The identifier that will be passed through to the underlying HTML element</td>
2011
2021
  </tbody>
2012
2022
  <tbody>
2013
2023
  <tr>
2014
- <td>validationMessage</td>
2015
- <td><code>string</code></td>
2024
+ <td>statusMessage</td>
2025
+ <td><code>any</code></td>
2016
2026
  <td>false</td>
2017
2027
  <td><code>-</code></td>
2018
2028
  <td>-</td>
@@ -2339,26 +2349,6 @@ The identifier that will be passed through to the underlying HTML element</td>
2339
2349
  <td>Determines the size at which the component is rendered: "small" (inline with other form components) or "medium" (larger block with bigger clickable area)</td>
2340
2350
  </tr>
2341
2351
  </tbody>
2342
- <tbody>
2343
- <tr>
2344
- <td>files</td>
2345
- <td><code>File[]</code></td>
2346
- <td>false</td>
2347
- <td><code>-</code></td>
2348
- <td>The list of selected files
2349
- @deprecated This prop has been deprecated because the FileInput component no longer persists/displays a list of selected files</td>
2350
- </tr>
2351
- </tbody>
2352
- <tbody>
2353
- <tr>
2354
- <td>height</td>
2355
- <td><code>Height<string , number></code></td>
2356
- <td>false</td>
2357
- <td><code>-</code></td>
2358
- <td>The height at which the component will be rendered
2359
- @deprecated Deprecated because the component now has preset sizes as determined by the "displaySize" prop</td>
2360
- </tr>
2361
- </tbody>
2362
2352
  <tbody>
2363
2353
  <tr>
2364
2354
  <td>label</td>
@@ -2424,16 +2414,6 @@ The identifier that will be passed through to the underlying HTML element</td>
2424
2414
  <td>The placeholder text that will be displayed inside the component</td>
2425
2415
  </tr>
2426
2416
  </tbody>
2427
- <tbody>
2428
- <tr>
2429
- <td>placeholderTitle</td>
2430
- <td><code>string</code></td>
2431
- <td>false</td>
2432
- <td><code>-</code></td>
2433
- <td>The placeholder title that will be displayed inside the component
2434
- @deprecated Deprecated in favor of the new label prop</td>
2435
- </tr>
2436
- </tbody>
2437
2417
  <tbody>
2438
2418
  <tr>
2439
2419
  <td>status</td>
@@ -2470,16 +2450,6 @@ The identifier that will be passed through to the underlying HTML element</td>
2470
2450
  <td>A list of mime types that determines the files that can be selected; an error will be reported via onError() if an invalid file is selected</td>
2471
2451
  </tr>
2472
2452
  </tbody>
2473
- <tbody>
2474
- <tr>
2475
- <td>width</td>
2476
- <td><code>Width<string , number></code></td>
2477
- <td>false</td>
2478
- <td><code>-</code></td>
2479
- <td>The width at which the component will be rendered
2480
- @deprecated Deprecated because the component now has preset sizes as determined by the "displaySize" prop</td>
2481
- </tr>
2482
- </tbody>
2483
2453
  <tbody>
2484
2454
  <tr>
2485
2455
  <td>ariaLabel</td>
@@ -4284,7 +4254,7 @@ The identifier that will be passed through to the underlying HTML element</td>
4284
4254
  </tr>
4285
4255
  </tbody>
4286
4256
  </table></details>
4287
- <details><summary id="localizationmenu">LocalizationMenu</summary>No description provided<h3>Props</h3><table><thead>
4257
+ <details><summary id="modal">Modal</summary>No description provided<h3>Props</h3><table><thead>
4288
4258
  <tr>
4289
4259
  <th>Name</th>
4290
4260
  <th>Type</th>
@@ -4294,161 +4264,71 @@ The identifier that will be passed through to the underlying HTML element</td>
4294
4264
  </tr>
4295
4265
  </thead><tbody>
4296
4266
  <tr>
4297
- <td>context</td>
4298
- <td><code>Context<[DestructurableRecord<LocalizationState<L>>, Dispatch<Action>]></code></td>
4299
- <td>true</td>
4300
- <td><code>-</code></td>
4301
- <td>-</td>
4267
+ <td>actionButton</td>
4268
+ <td><code>any</code></td>
4269
+ <td>false</td>
4270
+ <td><code>Confirm</code></td>
4271
+ <td>The label that will be displayed for the Modal's action button; providing a value of `false` will result in the action button being omitted</td>
4302
4272
  </tr>
4303
4273
  </tbody>
4304
4274
  <tbody>
4305
4275
  <tr>
4306
- <td>icons</td>
4307
- <td><code>IconsMap<L></code></td>
4276
+ <td>actionButtonIcon</td>
4277
+ <td><code>(props: SVGProps<SVGSVGElement>) => SVGComponent</code></td>
4308
4278
  <td>false</td>
4309
- <td><code>-</code></td>
4310
- <td>-</td>
4279
+ <td><code>actionType === 'negative' ? MinusIcon : ChevronRightIcon</code></td>
4280
+ <td>An icon that will be display for the action button</td>
4311
4281
  </tr>
4312
4282
  </tbody>
4313
4283
  <tbody>
4314
4284
  <tr>
4315
- <td>keySuffix</td>
4285
+ <td>actionButtonId</td>
4316
4286
  <td><code>string</code></td>
4317
4287
  <td>false</td>
4318
4288
  <td><code>-</code></td>
4319
- <td>-</td>
4289
+ <td>The identifier that will be passed through to the underlying HTML element of the action button</td>
4320
4290
  </tr>
4321
4291
  </tbody>
4322
4292
  <tbody>
4323
4293
  <tr>
4324
- <td>open</td>
4294
+ <td>actionDisabled</td>
4325
4295
  <td><code>boolean</code></td>
4326
4296
  <td>false</td>
4327
- <td><code>false</code></td>
4328
- <td>-</td>
4329
- </tr>
4330
- </tbody>
4331
- <tbody>
4332
- <tr>
4333
- <td>selectLocaleAction</td>
4334
- <td><code>(locale: L) => AsyncAction</code></td>
4335
- <td>true</td>
4336
4297
  <td><code>-</code></td>
4337
- <td>-</td>
4298
+ <td>Determines whether the action button is subject to user interaction</td>
4338
4299
  </tr>
4339
4300
  </tbody>
4340
4301
  <tbody>
4341
4302
  <tr>
4342
- <td>showLocaleNameInList</td>
4303
+ <td>actionLoading</td>
4343
4304
  <td><code>boolean</code></td>
4344
4305
  <td>false</td>
4345
- <td><code>true</code></td>
4346
- <td>-</td>
4306
+ <td><code>-</code></td>
4307
+ <td>Determines whether the action button should display a loading animation to indicate activity</td>
4347
4308
  </tr>
4348
4309
  </tbody>
4349
4310
  <tbody>
4350
4311
  <tr>
4351
- <td>showSelectedLocaleName</td>
4352
- <td><code>boolean</code></td>
4312
+ <td>actionLoadingProgress</td>
4313
+ <td><code>number</code></td>
4353
4314
  <td>false</td>
4354
4315
  <td><code>-</code></td>
4355
- <td>-</td>
4316
+ <td>Determines the progress % to be represented by the loading animation. If no value is provided, the loading animation will loop in an infinite, indeterminate state</td>
4356
4317
  </tr>
4357
4318
  </tbody>
4358
4319
  <tbody>
4359
4320
  <tr>
4360
- <td>ariaLabel</td>
4361
- <td><code>string</code></td>
4321
+ <td>actionType</td>
4322
+ <td><code>"negative" , "positive"</code></td>
4362
4323
  <td>false</td>
4363
- <td><code>-</code></td>
4364
- <td>-</td>
4324
+ <td><code>positive</code></td>
4325
+ <td>Determines which button component is used to render the action button; `"negative"` will result in a DestructiveButton being used and `"positive"` will use a PrimaryButton</td>
4365
4326
  </tr>
4366
4327
  </tbody>
4367
4328
  <tbody>
4368
4329
  <tr>
4369
- <td>id</td>
4370
- <td><code>string</code></td>
4371
- <td>false</td>
4372
- <td><code>-</code></td>
4373
- <td>The identifier that will be passed through to the underlying HTML element</td>
4374
- </tr>
4375
- </tbody>
4376
- </table></details>
4377
- <details><summary id="modal">Modal</summary>No description provided<h3>Props</h3><table><thead>
4378
- <tr>
4379
- <th>Name</th>
4380
- <th>Type</th>
4381
- <th>Required</th>
4382
- <th>Default</th>
4383
- <th>Description</th>
4384
- </tr>
4385
- </thead><tbody>
4386
- <tr>
4387
- <td>actionButton</td>
4388
- <td><code>any</code></td>
4389
- <td>false</td>
4390
- <td><code>Confirm</code></td>
4391
- <td>The label that will be displayed for the Modal's action button; providing a value of `false` will result in the action button being omitted</td>
4392
- </tr>
4393
- </tbody>
4394
- <tbody>
4395
- <tr>
4396
- <td>actionButtonIcon</td>
4397
- <td><code>(props: SVGProps<SVGSVGElement>) => SVGComponent</code></td>
4398
- <td>false</td>
4399
- <td><code>actionType === 'negative' ? MinusIcon : ChevronRightIcon</code></td>
4400
- <td>An icon that will be display for the action button</td>
4401
- </tr>
4402
- </tbody>
4403
- <tbody>
4404
- <tr>
4405
- <td>actionButtonId</td>
4406
- <td><code>string</code></td>
4407
- <td>false</td>
4408
- <td><code>-</code></td>
4409
- <td>The identifier that will be passed through to the underlying HTML element of the action button</td>
4410
- </tr>
4411
- </tbody>
4412
- <tbody>
4413
- <tr>
4414
- <td>actionDisabled</td>
4415
- <td><code>boolean</code></td>
4416
- <td>false</td>
4417
- <td><code>-</code></td>
4418
- <td>Determines whether the action button is subject to user interaction</td>
4419
- </tr>
4420
- </tbody>
4421
- <tbody>
4422
- <tr>
4423
- <td>actionLoading</td>
4424
- <td><code>boolean</code></td>
4425
- <td>false</td>
4426
- <td><code>-</code></td>
4427
- <td>Determines whether the action button should display a loading animation to indicate activity</td>
4428
- </tr>
4429
- </tbody>
4430
- <tbody>
4431
- <tr>
4432
- <td>actionLoadingProgress</td>
4433
- <td><code>number</code></td>
4434
- <td>false</td>
4435
- <td><code>-</code></td>
4436
- <td>Determines the progress % to be represented by the loading animation. If no value is provided, the loading animation will loop in an infinite, indeterminate state</td>
4437
- </tr>
4438
- </tbody>
4439
- <tbody>
4440
- <tr>
4441
- <td>actionType</td>
4442
- <td><code>"negative" , "positive"</code></td>
4443
- <td>false</td>
4444
- <td><code>positive</code></td>
4445
- <td>Determines which button component is used to render the action button; `"negative"` will result in a DestructiveButton being used and `"positive"` will use a PrimaryButton</td>
4446
- </tr>
4447
- </tbody>
4448
- <tbody>
4449
- <tr>
4450
- <td>blockScroll</td>
4451
- <td><code>boolean</code></td>
4330
+ <td>blockScroll</td>
4331
+ <td><code>boolean</code></td>
4452
4332
  <td>false</td>
4453
4333
  <td><code>true</code></td>
4454
4334
  <td>Determines whether background scrolling should be disabled when the Modal is open</td>
@@ -5459,7 +5339,7 @@ The identifier that will be passed through to the underlying HTML element</td>
5459
5339
  </thead><tbody>
5460
5340
  <tr>
5461
5341
  <td>backgroundColor</td>
5462
- <td><code>BackgroundColor , keyof ColorPalette</code></td>
5342
+ <td><code>string , number , symbol , (string & {})</code></td>
5463
5343
  <td>false</td>
5464
5344
  <td><code>-</code></td>
5465
5345
  <td>CSS property for the backgroundColor</td>
@@ -5468,7 +5348,7 @@ The identifier that will be passed through to the underlying HTML element</td>
5468
5348
  <tbody>
5469
5349
  <tr>
5470
5350
  <td>color</td>
5471
- <td><code>keyof ColorPalette , Color</code></td>
5351
+ <td><code>string , number , symbol , (string & {})</code></td>
5472
5352
  <td>false</td>
5473
5353
  <td><code>-</code></td>
5474
5354
  <td>CSS property for the color</td>
@@ -6211,7 +6091,7 @@ The identifier that will be passed through to the underlying HTML element</td>
6211
6091
  </tr>
6212
6092
  </tbody>
6213
6093
  </table></details>
6214
- <details><summary id="signinform">SigninForm</summary>No description provided<h3>Props</h3><table><thead>
6094
+ <details><summary id="subparagraph">SubParagraph</summary>No description provided<h3>Props</h3><table><thead>
6215
6095
  <tr>
6216
6096
  <th>Name</th>
6217
6097
  <th>Type</th>
@@ -6221,35 +6101,8 @@ The identifier that will be passed through to the underlying HTML element</td>
6221
6101
  </tr>
6222
6102
  </thead><tbody>
6223
6103
  <tr>
6224
- <td>allowForgotPassword</td>
6225
- <td><code>boolean</code></td>
6226
- <td>false</td>
6227
- <td><code>true</code></td>
6228
- <td>-</td>
6229
- </tr>
6230
- </tbody>
6231
- <tbody>
6232
- <tr>
6233
- <td>allowSignup</td>
6234
- <td><code>boolean</code></td>
6235
- <td>false</td>
6236
- <td><code>true</code></td>
6237
- <td>-</td>
6238
- </tr>
6239
- </tbody>
6240
- <tbody>
6241
- <tr>
6242
- <td>autocomplete</td>
6243
- <td><code>boolean</code></td>
6244
- <td>false</td>
6245
- <td><code>true</code></td>
6246
- <td>-</td>
6247
- </tr>
6248
- </tbody>
6249
- <tbody>
6250
- <tr>
6251
- <td>enforceFormCompletion</td>
6252
- <td><code>boolean</code></td>
6104
+ <td>color</td>
6105
+ <td><code>Color</code></td>
6253
6106
  <td>false</td>
6254
6107
  <td><code>-</code></td>
6255
6108
  <td>-</td>
@@ -6257,170 +6110,188 @@ The identifier that will be passed through to the underlying HTML element</td>
6257
6110
  </tbody>
6258
6111
  <tbody>
6259
6112
  <tr>
6260
- <td>padding</td>
6261
- <td><code>Padding<string , number></code></td>
6262
- <td>false</td>
6263
- <td><code>50px 30px 30px</code></td>
6264
- <td>-</td>
6265
- </tr>
6266
- </tbody>
6267
- <tbody>
6268
- <tr>
6269
- <td>passwordValidator</td>
6270
- <td><code>(passwordA: string, passwordB: string) => boolean</code></td>
6113
+ <td>id</td>
6114
+ <td><code>string</code></td>
6271
6115
  <td>false</td>
6272
- <td><code>(newPassword, newPasswordConfirm) => newPassword === newPasswordConfirm</code></td>
6273
- <td>-</td>
6116
+ <td><code>-</code></td>
6117
+ <td>The identifier that will be passed through to the underlying HTML element</td>
6274
6118
  </tr>
6275
6119
  </tbody>
6276
- <tbody>
6120
+ </table></details>
6121
+ <details><summary id="subtitle">SubTitle</summary>No description provided<h3>Props</h3><table><thead>
6122
+ <tr>
6123
+ <th>Name</th>
6124
+ <th>Type</th>
6125
+ <th>Required</th>
6126
+ <th>Default</th>
6127
+ <th>Description</th>
6128
+ </tr>
6129
+ </thead><tbody>
6277
6130
  <tr>
6278
- <td>profileActions</td>
6279
- <td><code>ProfileAction[]</code></td>
6131
+ <td>id</td>
6132
+ <td><code>string</code></td>
6280
6133
  <td>false</td>
6281
6134
  <td><code>-</code></td>
6282
- <td>-</td>
6135
+ <td>The identifier that will be passed through to the underlying HTML element</td>
6283
6136
  </tr>
6284
6137
  </tbody>
6285
- <tbody>
6138
+ </table></details>
6139
+ <details><summary id="table">Table</summary>No description provided<h3>Props</h3><table><thead>
6140
+ <tr>
6141
+ <th>Name</th>
6142
+ <th>Type</th>
6143
+ <th>Required</th>
6144
+ <th>Default</th>
6145
+ <th>Description</th>
6146
+ </tr>
6147
+ </thead><tbody>
6286
6148
  <tr>
6287
- <td>repeatNewPassword</td>
6288
- <td><code>boolean</code></td>
6289
- <td>false</td>
6149
+ <td>columns</td>
6150
+ <td><code>TableColumn<T, N>[]</code></td>
6151
+ <td>true</td>
6290
6152
  <td><code>-</code></td>
6291
- <td>-</td>
6153
+ <td>A list of column configurations objects used to determine what is displayed by the Table</td>
6292
6154
  </tr>
6293
6155
  </tbody>
6294
6156
  <tbody>
6295
6157
  <tr>
6296
- <td>type</td>
6297
- <td><code>"changePassword" , "confirmResetPassword" , "external" , "forceChangePassword" , "internal" , "mfa" , "requestResetPassword"</code></td>
6158
+ <td>columnOptions</td>
6159
+ <td><code>ColumnOptions</code></td>
6298
6160
  <td>false</td>
6299
- <td><code>external</code></td>
6300
- <td>-</td>
6161
+ <td><code>-</code></td>
6162
+ <td>Options that will be applied to all columns in the Table (some options may be overridden on a per-column basis)</td>
6301
6163
  </tr>
6302
6164
  </tbody>
6303
6165
  <tbody>
6304
6166
  <tr>
6305
- <td>onCancel</td>
6306
- <td><code>() => void</code></td>
6307
- <td>false</td>
6167
+ <td>data</td>
6168
+ <td><code>T[]</code></td>
6169
+ <td>true</td>
6308
6170
  <td><code>-</code></td>
6309
- <td>-</td>
6171
+ <td>The array of data that will be used to populate the table</td>
6310
6172
  </tr>
6311
6173
  </tbody>
6312
6174
  <tbody>
6313
6175
  <tr>
6314
- <td>onChangePassword</td>
6315
- <td><code>(oldPassword: string, newPassword: string) => void</code></td>
6176
+ <td>keyExtractor</td>
6177
+ <td><code>(row: T) => Key</code></td>
6316
6178
  <td>false</td>
6317
- <td><code>-</code></td>
6318
- <td>-</td>
6179
+ <td><code>(row) => data.indexOf(row)</code></td>
6180
+ <td>A function that will be used to return a unique key for each row; required if data contains non-primitive entries</td>
6319
6181
  </tr>
6320
6182
  </tbody>
6321
6183
  <tbody>
6322
6184
  <tr>
6323
- <td>onConfirmResetPassword</td>
6324
- <td><code>(username: string, newPassword: string, code: string) => void</code></td>
6185
+ <td>onPressRow</td>
6186
+ <td><code>(row: T) => void</code></td>
6325
6187
  <td>false</td>
6326
6188
  <td><code>-</code></td>
6327
- <td>-</td>
6189
+ <td>A handler that will be called when a row in the table is pressed</td>
6328
6190
  </tr>
6329
6191
  </tbody>
6330
6192
  <tbody>
6331
6193
  <tr>
6332
- <td>onForceChangePassword</td>
6333
- <td><code>(newPassword: string) => void</code></td>
6194
+ <td>onSort</td>
6195
+ <td><code>(columnName: string, columnIndex: number, direction: SortDirection) => void</code></td>
6334
6196
  <td>false</td>
6335
6197
  <td><code>-</code></td>
6336
- <td>-</td>
6198
+ <td>A handler that will be called whenever the sort order is changed as a result of the Table component's internal algorithm</td>
6337
6199
  </tr>
6338
6200
  </tbody>
6339
6201
  <tbody>
6340
6202
  <tr>
6341
- <td>onForgotPassword</td>
6342
- <td><code>() => void</code></td>
6203
+ <td>rowOptions</td>
6204
+ <td><code>RowOptions<T></code></td>
6343
6205
  <td>false</td>
6344
6206
  <td><code>-</code></td>
6345
- <td>-</td>
6207
+ <td>Options that will be applied to all rows in the Table</td>
6346
6208
  </tr>
6347
6209
  </tbody>
6348
6210
  <tbody>
6349
6211
  <tr>
6350
- <td>onHaveResetCode</td>
6351
- <td><code>() => void</code></td>
6212
+ <td>selectedRow</td>
6213
+ <td><code>unknown</code></td>
6352
6214
  <td>false</td>
6353
6215
  <td><code>-</code></td>
6354
- <td>-</td>
6216
+ <td>Specifies the active row. May be used to trigger visual highlight depending on rowOptions</td>
6355
6217
  </tr>
6356
6218
  </tbody>
6357
6219
  <tbody>
6358
6220
  <tr>
6359
- <td>onRequestResetPassword</td>
6360
- <td><code>(username: string) => void</code></td>
6221
+ <td>sortable</td>
6222
+ <td><code>boolean</code></td>
6361
6223
  <td>false</td>
6362
6224
  <td><code>-</code></td>
6363
- <td>-</td>
6225
+ <td>Determines whether the Table should present sortable controls (may be overridden on a per-column basis)</td>
6364
6226
  </tr>
6365
6227
  </tbody>
6366
6228
  <tbody>
6367
6229
  <tr>
6368
- <td>onSignin</td>
6369
- <td><code>(username?: string, password?: string) => void</code></td>
6230
+ <td>sorted</td>
6231
+ <td><code>boolean</code></td>
6370
6232
  <td>false</td>
6371
6233
  <td><code>-</code></td>
6372
- <td>-</td>
6234
+ <td>Specifies whether the `data` is already sorted. If `true`, the component's sorting algorithm will NOT be used</td>
6373
6235
  </tr>
6374
6236
  </tbody>
6375
6237
  <tbody>
6376
6238
  <tr>
6377
- <td>onSignout</td>
6378
- <td><code>() => void</code></td>
6239
+ <td>sortedColumn</td>
6240
+ <td><code>string , number</code></td>
6379
6241
  <td>false</td>
6380
- <td><code>-</code></td>
6381
- <td>-</td>
6242
+ <td><code>(First sortable column)</code></td>
6243
+ <td>Specifies the sorted column, by index or column name (using column names is strongly recommended)</td>
6382
6244
  </tr>
6383
6245
  </tbody>
6384
6246
  <tbody>
6385
6247
  <tr>
6386
- <td>onSignup</td>
6387
- <td><code>() => void</code></td>
6248
+ <td>sortedDirection</td>
6249
+ <td><code>SortDirection</code></td>
6388
6250
  <td>false</td>
6389
- <td><code>-</code></td>
6390
- <td>-</td>
6251
+ <td><code>ascending</code></td>
6252
+ <td>Specifies the direction of the sort</td>
6391
6253
  </tr>
6392
6254
  </tbody>
6393
6255
  <tbody>
6394
6256
  <tr>
6395
- <td>onSubmitMfa</td>
6396
- <td><code>(code: string) => void</code></td>
6257
+ <td>id</td>
6258
+ <td><code>string</code></td>
6397
6259
  <td>false</td>
6398
6260
  <td><code>-</code></td>
6399
- <td>-</td>
6261
+ <td>The identifier that will be passed through to the underlying HTML element</td>
6400
6262
  </tr>
6401
6263
  </tbody>
6402
- <tbody>
6264
+ </table></details>
6265
+ <details><summary id="tabs">Tabs</summary>No description provided<h3>Props</h3><table><thead>
6266
+ <tr>
6267
+ <th>Name</th>
6268
+ <th>Type</th>
6269
+ <th>Required</th>
6270
+ <th>Default</th>
6271
+ <th>Description</th>
6272
+ </tr>
6273
+ </thead><tbody>
6403
6274
  <tr>
6404
- <td>isSignedIn</td>
6405
- <td><code>boolean</code></td>
6275
+ <td>backgroundStyle</td>
6276
+ <td><code>"filled" , "transparent"</code></td>
6406
6277
  <td>false</td>
6407
- <td><code>false</code></td>
6278
+ <td><code>filled</code></td>
6408
6279
  <td>-</td>
6409
6280
  </tr>
6410
6281
  </tbody>
6411
6282
  <tbody>
6412
6283
  <tr>
6413
- <td>loading</td>
6414
- <td><code>boolean</code></td>
6284
+ <td>disabledTabs</td>
6285
+ <td><code>T[]</code></td>
6415
6286
  <td>false</td>
6416
- <td><code>-</code></td>
6287
+ <td><code>[]</code></td>
6417
6288
  <td>-</td>
6418
6289
  </tr>
6419
6290
  </tbody>
6420
6291
  <tbody>
6421
6292
  <tr>
6422
- <td>username</td>
6423
- <td><code>string</code></td>
6293
+ <td>keyExtractor</td>
6294
+ <td><code>KeyExtractor<T></code></td>
6424
6295
  <td>false</td>
6425
6296
  <td><code>-</code></td>
6426
6297
  <td>-</td>
@@ -6428,8 +6299,8 @@ The identifier that will be passed through to the underlying HTML element</td>
6428
6299
  </tbody>
6429
6300
  <tbody>
6430
6301
  <tr>
6431
- <td>i18n</td>
6432
- <td><code>{ cancel?: FormattedString; code?: FormattedString; forgotPassword?: FormattedString; newPassword?: FormattedString; password?: FormattedString; repeatNewPassword?: FormattedString; username?: FormattedString; changePasswordPrompt?: FormattedString; changePasswordSubmit?: FormattedString; changePasswordTitle?: Forma...</code></td>
6302
+ <td>labelExtractor</td>
6303
+ <td><code>ContentExtractor<T></code></td>
6433
6304
  <td>false</td>
6434
6305
  <td><code>-</code></td>
6435
6306
  <td>-</td>
@@ -6437,545 +6308,13 @@ The identifier that will be passed through to the underlying HTML element</td>
6437
6308
  </tbody>
6438
6309
  <tbody>
6439
6310
  <tr>
6440
- <td>ariaDescription</td>
6441
- <td><code>string</code></td>
6311
+ <td>onSelect</td>
6312
+ <td><code>(tab: T) => void</code></td>
6442
6313
  <td>false</td>
6443
6314
  <td><code>-</code></td>
6444
6315
  <td>-</td>
6445
6316
  </tr>
6446
6317
  </tbody>
6447
- <tbody>
6448
- <tr>
6449
- <td>ariaLabel</td>
6450
- <td><code>string</code></td>
6451
- <td>false</td>
6452
- <td><code>-</code></td>
6453
- <td>-</td>
6454
- </tr>
6455
- </tbody>
6456
- <tbody>
6457
- <tr>
6458
- <td>id</td>
6459
- <td><code>string</code></td>
6460
- <td>false</td>
6461
- <td><code>-</code></td>
6462
- <td>The identifier that will be passed through to the underlying HTML element</td>
6463
- </tr>
6464
- </tbody>
6465
- </table></details>
6466
- <details><summary id="signinmenu">SigninMenu</summary>No description provided<h3>Props</h3><table><thead>
6467
- <tr>
6468
- <th>Name</th>
6469
- <th>Type</th>
6470
- <th>Required</th>
6471
- <th>Default</th>
6472
- <th>Description</th>
6473
- </tr>
6474
- </thead><tbody>
6475
- <tr>
6476
- <td>allowForgotPassword</td>
6477
- <td><code>boolean</code></td>
6478
- <td>false</td>
6479
- <td><code>-</code></td>
6480
- <td>-</td>
6481
- </tr>
6482
- </tbody>
6483
- <tbody>
6484
- <tr>
6485
- <td>allowSignup</td>
6486
- <td><code>boolean</code></td>
6487
- <td>false</td>
6488
- <td><code>-</code></td>
6489
- <td>-</td>
6490
- </tr>
6491
- </tbody>
6492
- <tbody>
6493
- <tr>
6494
- <td>autocomplete</td>
6495
- <td><code>boolean</code></td>
6496
- <td>false</td>
6497
- <td><code>-</code></td>
6498
- <td>-</td>
6499
- </tr>
6500
- </tbody>
6501
- <tbody>
6502
- <tr>
6503
- <td>enforceFormCompletion</td>
6504
- <td><code>boolean</code></td>
6505
- <td>false</td>
6506
- <td><code>-</code></td>
6507
- <td>-</td>
6508
- </tr>
6509
- </tbody>
6510
- <tbody>
6511
- <tr>
6512
- <td>padding</td>
6513
- <td><code>Padding<string , number></code></td>
6514
- <td>false</td>
6515
- <td><code>-</code></td>
6516
- <td>-</td>
6517
- </tr>
6518
- </tbody>
6519
- <tbody>
6520
- <tr>
6521
- <td>passwordValidator</td>
6522
- <td><code>(passwordA: string, passwordB: string) => boolean</code></td>
6523
- <td>false</td>
6524
- <td><code>-</code></td>
6525
- <td>-</td>
6526
- </tr>
6527
- </tbody>
6528
- <tbody>
6529
- <tr>
6530
- <td>profileActions</td>
6531
- <td><code>ProfileAction[]</code></td>
6532
- <td>false</td>
6533
- <td><code>-</code></td>
6534
- <td>-</td>
6535
- </tr>
6536
- </tbody>
6537
- <tbody>
6538
- <tr>
6539
- <td>repeatNewPassword</td>
6540
- <td><code>boolean</code></td>
6541
- <td>false</td>
6542
- <td><code>-</code></td>
6543
- <td>-</td>
6544
- </tr>
6545
- </tbody>
6546
- <tbody>
6547
- <tr>
6548
- <td>type</td>
6549
- <td><code>"changePassword" , "confirmResetPassword" , "external" , "forceChangePassword" , "internal" , "mfa" , "requestResetPassword"</code></td>
6550
- <td>false</td>
6551
- <td><code>-</code></td>
6552
- <td>-</td>
6553
- </tr>
6554
- </tbody>
6555
- <tbody>
6556
- <tr>
6557
- <td>onCancel</td>
6558
- <td><code>() => void</code></td>
6559
- <td>false</td>
6560
- <td><code>-</code></td>
6561
- <td>-</td>
6562
- </tr>
6563
- </tbody>
6564
- <tbody>
6565
- <tr>
6566
- <td>onChangePassword</td>
6567
- <td><code>(oldPassword: string, newPassword: string) => void</code></td>
6568
- <td>false</td>
6569
- <td><code>-</code></td>
6570
- <td>-</td>
6571
- </tr>
6572
- </tbody>
6573
- <tbody>
6574
- <tr>
6575
- <td>onConfirmResetPassword</td>
6576
- <td><code>(username: string, newPassword: string, code: string) => void</code></td>
6577
- <td>false</td>
6578
- <td><code>-</code></td>
6579
- <td>-</td>
6580
- </tr>
6581
- </tbody>
6582
- <tbody>
6583
- <tr>
6584
- <td>onForceChangePassword</td>
6585
- <td><code>(newPassword: string) => void</code></td>
6586
- <td>false</td>
6587
- <td><code>-</code></td>
6588
- <td>-</td>
6589
- </tr>
6590
- </tbody>
6591
- <tbody>
6592
- <tr>
6593
- <td>onForgotPassword</td>
6594
- <td><code>() => void</code></td>
6595
- <td>false</td>
6596
- <td><code>-</code></td>
6597
- <td>-</td>
6598
- </tr>
6599
- </tbody>
6600
- <tbody>
6601
- <tr>
6602
- <td>onHaveResetCode</td>
6603
- <td><code>() => void</code></td>
6604
- <td>false</td>
6605
- <td><code>-</code></td>
6606
- <td>-</td>
6607
- </tr>
6608
- </tbody>
6609
- <tbody>
6610
- <tr>
6611
- <td>onRequestResetPassword</td>
6612
- <td><code>(username: string) => void</code></td>
6613
- <td>false</td>
6614
- <td><code>-</code></td>
6615
- <td>-</td>
6616
- </tr>
6617
- </tbody>
6618
- <tbody>
6619
- <tr>
6620
- <td>onSignin</td>
6621
- <td><code>(username?: string, password?: string) => void</code></td>
6622
- <td>false</td>
6623
- <td><code>-</code></td>
6624
- <td>-</td>
6625
- </tr>
6626
- </tbody>
6627
- <tbody>
6628
- <tr>
6629
- <td>onSignout</td>
6630
- <td><code>() => void</code></td>
6631
- <td>false</td>
6632
- <td><code>-</code></td>
6633
- <td>-</td>
6634
- </tr>
6635
- </tbody>
6636
- <tbody>
6637
- <tr>
6638
- <td>onSignup</td>
6639
- <td><code>() => void</code></td>
6640
- <td>false</td>
6641
- <td><code>-</code></td>
6642
- <td>-</td>
6643
- </tr>
6644
- </tbody>
6645
- <tbody>
6646
- <tr>
6647
- <td>onSubmitMfa</td>
6648
- <td><code>(code: string) => void</code></td>
6649
- <td>false</td>
6650
- <td><code>-</code></td>
6651
- <td>-</td>
6652
- </tr>
6653
- </tbody>
6654
- <tbody>
6655
- <tr>
6656
- <td>isSignedIn</td>
6657
- <td><code>boolean</code></td>
6658
- <td>false</td>
6659
- <td><code>-</code></td>
6660
- <td>-</td>
6661
- </tr>
6662
- </tbody>
6663
- <tbody>
6664
- <tr>
6665
- <td>loading</td>
6666
- <td><code>boolean</code></td>
6667
- <td>false</td>
6668
- <td><code>-</code></td>
6669
- <td>-</td>
6670
- </tr>
6671
- </tbody>
6672
- <tbody>
6673
- <tr>
6674
- <td>username</td>
6675
- <td><code>string</code></td>
6676
- <td>false</td>
6677
- <td><code>-</code></td>
6678
- <td>-</td>
6679
- </tr>
6680
- </tbody>
6681
- <tbody>
6682
- <tr>
6683
- <td>i18n</td>
6684
- <td><code>{ cancel?: FormattedString; code?: FormattedString; forgotPassword?: FormattedString; newPassword?: FormattedString; password?: FormattedString; repeatNewPassword?: FormattedString; username?: FormattedString; changePasswordPrompt?: FormattedString; changePasswordSubmit?: FormattedString; changePasswordTitle?: Forma...</code></td>
6685
- <td>false</td>
6686
- <td><code>-</code></td>
6687
- <td>-</td>
6688
- </tr>
6689
- </tbody>
6690
- <tbody>
6691
- <tr>
6692
- <td>ariaDescription</td>
6693
- <td><code>string</code></td>
6694
- <td>false</td>
6695
- <td><code>-</code></td>
6696
- <td>-</td>
6697
- </tr>
6698
- </tbody>
6699
- <tbody>
6700
- <tr>
6701
- <td>ariaLabel</td>
6702
- <td><code>string</code></td>
6703
- <td>false</td>
6704
- <td><code>-</code></td>
6705
- <td>-</td>
6706
- </tr>
6707
- </tbody>
6708
- <tbody>
6709
- <tr>
6710
- <td>id</td>
6711
- <td><code>string</code></td>
6712
- <td>false</td>
6713
- <td><code>-</code></td>
6714
- <td>The identifier that will be passed through to the underlying HTML element</td>
6715
- </tr>
6716
- </tbody>
6717
- <tbody>
6718
- <tr>
6719
- <td>onClose</td>
6720
- <td><code>() => void</code></td>
6721
- <td>false</td>
6722
- <td><code>-</code></td>
6723
- <td>-</td>
6724
- </tr>
6725
- </tbody>
6726
- <tbody>
6727
- <tr>
6728
- <td>onOpen</td>
6729
- <td><code>() => void</code></td>
6730
- <td>false</td>
6731
- <td><code>-</code></td>
6732
- <td>-</td>
6733
- </tr>
6734
- </tbody>
6735
- <tbody>
6736
- <tr>
6737
- <td>open</td>
6738
- <td><code>boolean</code></td>
6739
- <td>false</td>
6740
- <td><code>false</code></td>
6741
- <td>-</td>
6742
- </tr>
6743
- </tbody>
6744
- </table></details>
6745
- <details><summary id="subparagraph">SubParagraph</summary>No description provided<h3>Props</h3><table><thead>
6746
- <tr>
6747
- <th>Name</th>
6748
- <th>Type</th>
6749
- <th>Required</th>
6750
- <th>Default</th>
6751
- <th>Description</th>
6752
- </tr>
6753
- </thead><tbody>
6754
- <tr>
6755
- <td>color</td>
6756
- <td><code>Color</code></td>
6757
- <td>false</td>
6758
- <td><code>-</code></td>
6759
- <td>-</td>
6760
- </tr>
6761
- </tbody>
6762
- <tbody>
6763
- <tr>
6764
- <td>id</td>
6765
- <td><code>string</code></td>
6766
- <td>false</td>
6767
- <td><code>-</code></td>
6768
- <td>The identifier that will be passed through to the underlying HTML element</td>
6769
- </tr>
6770
- </tbody>
6771
- </table></details>
6772
- <details><summary id="subtitle">SubTitle</summary>No description provided<h3>Props</h3><table><thead>
6773
- <tr>
6774
- <th>Name</th>
6775
- <th>Type</th>
6776
- <th>Required</th>
6777
- <th>Default</th>
6778
- <th>Description</th>
6779
- </tr>
6780
- </thead><tbody>
6781
- <tr>
6782
- <td>id</td>
6783
- <td><code>string</code></td>
6784
- <td>false</td>
6785
- <td><code>-</code></td>
6786
- <td>The identifier that will be passed through to the underlying HTML element</td>
6787
- </tr>
6788
- </tbody>
6789
- </table></details>
6790
- <details><summary id="table">Table</summary>No description provided<h3>Props</h3><table><thead>
6791
- <tr>
6792
- <th>Name</th>
6793
- <th>Type</th>
6794
- <th>Required</th>
6795
- <th>Default</th>
6796
- <th>Description</th>
6797
- </tr>
6798
- </thead><tbody>
6799
- <tr>
6800
- <td>columns</td>
6801
- <td><code>TableColumn<T, N>[]</code></td>
6802
- <td>true</td>
6803
- <td><code>-</code></td>
6804
- <td>A list of column configurations objects used to determine what is displayed by the Table</td>
6805
- </tr>
6806
- </tbody>
6807
- <tbody>
6808
- <tr>
6809
- <td>columnOptions</td>
6810
- <td><code>ColumnOptions</code></td>
6811
- <td>false</td>
6812
- <td><code>-</code></td>
6813
- <td>Options that will be applied to all columns in the Table (some options may be overridden on a per-column basis)</td>
6814
- </tr>
6815
- </tbody>
6816
- <tbody>
6817
- <tr>
6818
- <td>data</td>
6819
- <td><code>T[]</code></td>
6820
- <td>true</td>
6821
- <td><code>-</code></td>
6822
- <td>The array of data that will be used to populate the table</td>
6823
- </tr>
6824
- </tbody>
6825
- <tbody>
6826
- <tr>
6827
- <td>keyExtractor</td>
6828
- <td><code>(row: T) => Key</code></td>
6829
- <td>false</td>
6830
- <td><code>(row) => data.indexOf(row)</code></td>
6831
- <td>A function that will be used to return a unique key for each row; required if data contains non-primitive entries</td>
6832
- </tr>
6833
- </tbody>
6834
- <tbody>
6835
- <tr>
6836
- <td>onPressRow</td>
6837
- <td><code>(row: T) => void</code></td>
6838
- <td>false</td>
6839
- <td><code>-</code></td>
6840
- <td>A handler that will be called when a row in the table is pressed</td>
6841
- </tr>
6842
- </tbody>
6843
- <tbody>
6844
- <tr>
6845
- <td>onSort</td>
6846
- <td><code>(columnName: string, columnIndex: number, direction: SortDirection) => void</code></td>
6847
- <td>false</td>
6848
- <td><code>-</code></td>
6849
- <td>A handler that will be called whenever the sort order is changed as a result of the Table component's internal algorithm</td>
6850
- </tr>
6851
- </tbody>
6852
- <tbody>
6853
- <tr>
6854
- <td>rowOptions</td>
6855
- <td><code>RowOptions<T></code></td>
6856
- <td>false</td>
6857
- <td><code>-</code></td>
6858
- <td>Options that will be applied to all rows in the Table</td>
6859
- </tr>
6860
- </tbody>
6861
- <tbody>
6862
- <tr>
6863
- <td>selectedRow</td>
6864
- <td><code>unknown</code></td>
6865
- <td>false</td>
6866
- <td><code>-</code></td>
6867
- <td>Specifies the active row. May be used to trigger visual highlight depending on rowOptions</td>
6868
- </tr>
6869
- </tbody>
6870
- <tbody>
6871
- <tr>
6872
- <td>sortable</td>
6873
- <td><code>boolean</code></td>
6874
- <td>false</td>
6875
- <td><code>-</code></td>
6876
- <td>Determines whether the Table should present sortable controls (may be overridden on a per-column basis)</td>
6877
- </tr>
6878
- </tbody>
6879
- <tbody>
6880
- <tr>
6881
- <td>sorted</td>
6882
- <td><code>boolean</code></td>
6883
- <td>false</td>
6884
- <td><code>-</code></td>
6885
- <td>Specifies whether the `data` is already sorted. If `true`, the component's sorting algorithm will NOT be used</td>
6886
- </tr>
6887
- </tbody>
6888
- <tbody>
6889
- <tr>
6890
- <td>sortedColumn</td>
6891
- <td><code>string , number</code></td>
6892
- <td>false</td>
6893
- <td><code>(First sortable column)</code></td>
6894
- <td>Specifies the sorted column, by index or column name (using column names is strongly recommended)</td>
6895
- </tr>
6896
- </tbody>
6897
- <tbody>
6898
- <tr>
6899
- <td>sortedDirection</td>
6900
- <td><code>SortDirection</code></td>
6901
- <td>false</td>
6902
- <td><code>ascending</code></td>
6903
- <td>Specifies the direction of the sort</td>
6904
- </tr>
6905
- </tbody>
6906
- <tbody>
6907
- <tr>
6908
- <td>id</td>
6909
- <td><code>string</code></td>
6910
- <td>false</td>
6911
- <td><code>-</code></td>
6912
- <td>The identifier that will be passed through to the underlying HTML element</td>
6913
- </tr>
6914
- </tbody>
6915
- </table></details>
6916
- <details><summary id="tabs">Tabs</summary>No description provided<h3>Props</h3><table><thead>
6917
- <tr>
6918
- <th>Name</th>
6919
- <th>Type</th>
6920
- <th>Required</th>
6921
- <th>Default</th>
6922
- <th>Description</th>
6923
- </tr>
6924
- </thead><tbody>
6925
- <tr>
6926
- <td>backgroundStyle</td>
6927
- <td><code>"filled" , "transparent"</code></td>
6928
- <td>false</td>
6929
- <td><code>filled</code></td>
6930
- <td>-</td>
6931
- </tr>
6932
- </tbody>
6933
- <tbody>
6934
- <tr>
6935
- <td>disabledTabs</td>
6936
- <td><code>T[]</code></td>
6937
- <td>false</td>
6938
- <td><code>[]</code></td>
6939
- <td>-</td>
6940
- </tr>
6941
- </tbody>
6942
- <tbody>
6943
- <tr>
6944
- <td>keyExtractor</td>
6945
- <td><code>KeyExtractor<T></code></td>
6946
- <td>false</td>
6947
- <td><code>-</code></td>
6948
- <td>-</td>
6949
- </tr>
6950
- </tbody>
6951
- <tbody>
6952
- <tr>
6953
- <td>labelExtractor</td>
6954
- <td><code>ContentExtractor<T></code></td>
6955
- <td>false</td>
6956
- <td><code>-</code></td>
6957
- <td>-</td>
6958
- </tr>
6959
- </tbody>
6960
- <tbody>
6961
- <tr>
6962
- <td>onSelect</td>
6963
- <td><code>(tab: T) => void</code></td>
6964
- <td>false</td>
6965
- <td><code>-</code></td>
6966
- <td>-</td>
6967
- </tr>
6968
- </tbody>
6969
- <tbody>
6970
- <tr>
6971
- <td>scrollable</td>
6972
- <td><code>boolean</code></td>
6973
- <td>false</td>
6974
- <td><code>-</code></td>
6975
- <td>@deprecated The "scrollable" prop is now redundant, and the component
6976
- will behave as though scrollable={true} in all cases</td>
6977
- </tr>
6978
- </tbody>
6979
6318
  <tbody>
6980
6319
  <tr>
6981
6320
  <td>selectedTab</td>