@warp-ds/elements 2.9.1 → 2.9.2-next.1

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.
Files changed (32) hide show
  1. package/dist/custom-elements.json +72 -226
  2. package/dist/docs/radio/accessibility.md +1 -0
  3. package/dist/docs/radio/api.md +57 -0
  4. package/dist/docs/radio/examples.md +1 -0
  5. package/dist/docs/radio/radio.md +69 -0
  6. package/dist/docs/radio/usage.md +1 -0
  7. package/dist/docs/radio-group/accessibility.md +1 -0
  8. package/dist/docs/radio-group/api.md +69 -0
  9. package/dist/docs/radio-group/examples.md +68 -0
  10. package/dist/docs/radio-group/radio-group.md +311 -0
  11. package/dist/docs/radio-group/styling.md +118 -0
  12. package/dist/docs/radio-group/usage.md +44 -0
  13. package/dist/docs/select/accessibility.md +2 -0
  14. package/dist/docs/select/api.md +20 -16
  15. package/dist/docs/select/examples.md +116 -0
  16. package/dist/docs/select/select.md +168 -18
  17. package/dist/docs/select/usage.md +30 -0
  18. package/dist/index.d.ts +136 -185
  19. package/dist/packages/radio/radio.d.ts +51 -13
  20. package/dist/packages/radio/radio.js +3 -3
  21. package/dist/packages/radio/radio.js.map +3 -3
  22. package/dist/packages/radio/radio.react.stories.d.ts +1 -1
  23. package/dist/packages/radio/radio.stories.d.ts +2 -2
  24. package/dist/packages/radio/react.d.ts +2 -2
  25. package/dist/packages/radio-group/radio-group.d.ts +43 -5
  26. package/dist/packages/radio-group/radio-group.js +7 -7
  27. package/dist/packages/radio-group/radio-group.js.map +3 -3
  28. package/dist/packages/radio-group/react.d.ts +4 -4
  29. package/dist/packages/select/select.d.ts +32 -48
  30. package/dist/packages/select/select.js.map +2 -2
  31. package/dist/web-types.json +78 -46
  32. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
3
3
  "name": "@warp-ds/elements",
4
- "version": "2.9.1-next.6",
4
+ "version": "2.9.1",
5
5
  "description-markup": "markdown",
6
6
  "contributions": {
7
7
  "html": {
@@ -1438,7 +1438,7 @@
1438
1438
  },
1439
1439
  {
1440
1440
  "name": "w-radio",
1441
- "description": "\n---\n\n\n### **Methods:**\n - **checkValidity(): _boolean_** - Checks whether the radio passes constraint validation\n- **reportValidity(): _boolean_** - Checks validity and shows the browser's validation message if invalid",
1441
+ "description": "\n---\n",
1442
1442
  "doc-url": "",
1443
1443
  "attributes": [
1444
1444
  {
@@ -1504,26 +1504,6 @@
1504
1504
  "name": "invalid",
1505
1505
  "description": "Draws the radio in an invalid state.",
1506
1506
  "type": "boolean"
1507
- },
1508
- {
1509
- "name": "tabIndex",
1510
- "description": "Override tabIndex setter to set _groupTabIndex (for backwards compatibility).\nRadio-group should use _groupTabIndex directly for clarity.",
1511
- "type": "number"
1512
- },
1513
- {
1514
- "name": "validationMessage",
1515
- "description": "Returns the validation message if the radio is invalid, otherwise an empty string",
1516
- "type": "string"
1517
- },
1518
- {
1519
- "name": "validity",
1520
- "description": "Returns the validity state of the radio",
1521
- "type": "ValidityState"
1522
- },
1523
- {
1524
- "name": "_standaloneTabIndex",
1525
- "description": "Internal tabindex for standalone radios (not in a group).\nNon-reflecting to avoid DOM changes during hydration.",
1526
- "type": "number | undefined"
1527
1507
  }
1528
1508
  ],
1529
1509
  "events": []
@@ -1531,32 +1511,42 @@
1531
1511
  },
1532
1512
  {
1533
1513
  "name": "w-radio-group",
1534
- "description": "\n---\n\n\n### **Slots:**\n - **label** - Alternative to the `label` attribute should you need custom HTML.\n- **help-text** - Alternative to the `help-text` attribute should you need custom HTML.",
1514
+ "description": "Radios allow users to select a single option from a list of choices.\n\nUse with `w-radio`.\n---\n\n\n### **Slots:**\n - **label** - Alternative to the `label` attribute should you need custom HTML.\n- **help-text** - Alternative to the `help-text` attribute should you need custom HTML.",
1535
1515
  "doc-url": "",
1536
1516
  "attributes": [
1537
- { "name": "label", "value": { "type": "string", "default": "''" } },
1517
+ {
1518
+ "name": "label",
1519
+ "description": "Label for the radio group.",
1520
+ "value": { "type": "string", "default": "''" }
1521
+ },
1538
1522
  {
1539
1523
  "name": "help-text",
1524
+ "description": "Help text for the radio group.\n\nIf you set `required` and `invalid` the group gets a default error message, but you can override it with this attribute.",
1540
1525
  "value": { "type": "string", "default": "''" }
1541
1526
  },
1542
1527
  {
1543
1528
  "name": "optional",
1529
+ "description": "Whether to show optional text next to the label.",
1544
1530
  "value": { "type": "boolean", "default": "false" }
1545
1531
  },
1546
1532
  {
1547
1533
  "name": "invalid",
1534
+ "description": "Marks the radio group as invalid.",
1548
1535
  "value": { "type": "boolean", "default": "false" }
1549
1536
  },
1550
1537
  {
1551
1538
  "name": "name",
1539
+ "description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form.",
1552
1540
  "value": { "type": "string | null", "default": "null" }
1553
1541
  },
1554
1542
  {
1555
1543
  "name": "disabled",
1544
+ "description": "Disables the radio group and all child radios.",
1556
1545
  "value": { "type": "boolean", "default": "false" }
1557
1546
  },
1558
1547
  {
1559
1548
  "name": "required",
1549
+ "description": "Makes selecting a radio in the the group required.",
1560
1550
  "value": { "type": "boolean", "default": "false" }
1561
1551
  }
1562
1552
  ],
@@ -1573,22 +1563,48 @@
1573
1563
  "events": [],
1574
1564
  "js": {
1575
1565
  "properties": [
1576
- { "name": "hasInteracted", "type": "boolean" },
1577
- { "name": "label", "type": "string" },
1578
- { "name": "helpText", "type": "string" },
1579
- { "name": "optional", "type": "boolean" },
1580
- { "name": "invalid", "type": "boolean" },
1581
- { "name": "name", "type": "string | null" },
1582
- { "name": "disabled", "type": "boolean" },
1583
- { "name": "required", "type": "boolean" },
1584
- { "name": "validationTarget" }
1566
+ {
1567
+ "name": "label",
1568
+ "description": "Label for the radio group.",
1569
+ "type": "string"
1570
+ },
1571
+ {
1572
+ "name": "helpText",
1573
+ "description": "Help text for the radio group.\n\nIf you set `required` and `invalid` the group gets a default error message, but you can override it with this attribute.",
1574
+ "type": "string"
1575
+ },
1576
+ {
1577
+ "name": "optional",
1578
+ "description": "Whether to show optional text next to the label.",
1579
+ "type": "boolean"
1580
+ },
1581
+ {
1582
+ "name": "invalid",
1583
+ "description": "Marks the radio group as invalid.",
1584
+ "type": "boolean"
1585
+ },
1586
+ {
1587
+ "name": "name",
1588
+ "description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form.",
1589
+ "type": "string | null"
1590
+ },
1591
+ {
1592
+ "name": "disabled",
1593
+ "description": "Disables the radio group and all child radios.",
1594
+ "type": "boolean"
1595
+ },
1596
+ {
1597
+ "name": "required",
1598
+ "description": "Makes selecting a radio in the the group required.",
1599
+ "type": "boolean"
1600
+ }
1585
1601
  ],
1586
1602
  "events": []
1587
1603
  }
1588
1604
  },
1589
1605
  {
1590
1606
  "name": "w-select",
1591
- "description": "A dropdown component for selecting a single value.\n\n[See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/forms-select--docs)\n---\n\n\n### **Events:**\n - **change**",
1607
+ "description": "A dropdown component for selecting a single value.\n---\n\n\n### **Events:**\n - **change**",
1592
1608
  "doc-url": "",
1593
1609
  "attributes": [
1594
1610
  {
@@ -1603,12 +1619,12 @@
1603
1619
  },
1604
1620
  {
1605
1621
  "name": "help-text",
1606
- "description": "The content displayed as the help text. Paired with `invalid` to show the text as a validation error.",
1622
+ "description": "The content displayed as the help text.\n\nPaired with `invalid` to show the text as a validation error.",
1607
1623
  "value": { "type": "string" }
1608
1624
  },
1609
1625
  {
1610
1626
  "name": "invalid",
1611
- "description": "Renders the field in an invalid state. Paired with `help-text` to provide feedback about the error.",
1627
+ "description": "Renders the field in an invalid state.\n\nPaired with `help-text` to provide feedback about the error.",
1612
1628
  "value": { "type": "boolean", "default": "false" }
1613
1629
  },
1614
1630
  {
@@ -1623,12 +1639,12 @@
1623
1639
  },
1624
1640
  {
1625
1641
  "name": "label",
1626
- "description": "The content to disply as the label",
1642
+ "description": "The content to display as the label.",
1627
1643
  "value": { "type": "string" }
1628
1644
  },
1629
1645
  {
1630
1646
  "name": "optional",
1631
- "description": "Whether to show optional text",
1647
+ "description": "Whether to show the optional indicator after the label.",
1632
1648
  "value": { "type": "boolean", "default": "false" }
1633
1649
  },
1634
1650
  {
@@ -1646,8 +1662,16 @@
1646
1662
  "description": "Renders the field in a readonly state.",
1647
1663
  "value": { "type": "boolean", "default": "false" }
1648
1664
  },
1649
- { "name": "name", "value": { "type": "string" } },
1650
- { "name": "value", "value": { "type": "string" } }
1665
+ {
1666
+ "name": "name",
1667
+ "description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form.",
1668
+ "value": { "type": "string" }
1669
+ },
1670
+ {
1671
+ "name": "value",
1672
+ "description": "Lets you set the current value.",
1673
+ "value": { "type": "string" }
1674
+ }
1651
1675
  ],
1652
1676
  "events": [{ "name": "change", "type": "CustomEvent" }],
1653
1677
  "js": {
@@ -1664,12 +1688,12 @@
1664
1688
  },
1665
1689
  {
1666
1690
  "name": "helpText",
1667
- "description": "The content displayed as the help text. Paired with `invalid` to show the text as a validation error.",
1691
+ "description": "The content displayed as the help text.\n\nPaired with `invalid` to show the text as a validation error.",
1668
1692
  "type": "string"
1669
1693
  },
1670
1694
  {
1671
1695
  "name": "invalid",
1672
- "description": "Renders the field in an invalid state. Paired with `help-text` to provide feedback about the error.",
1696
+ "description": "Renders the field in an invalid state.\n\nPaired with `help-text` to provide feedback about the error.",
1673
1697
  "type": "boolean"
1674
1698
  },
1675
1699
  {
@@ -1684,12 +1708,12 @@
1684
1708
  },
1685
1709
  {
1686
1710
  "name": "label",
1687
- "description": "The content to disply as the label",
1711
+ "description": "The content to display as the label.",
1688
1712
  "type": "string"
1689
1713
  },
1690
1714
  {
1691
1715
  "name": "optional",
1692
- "description": "Whether to show optional text",
1716
+ "description": "Whether to show the optional indicator after the label.",
1693
1717
  "type": "boolean"
1694
1718
  },
1695
1719
  {
@@ -1707,8 +1731,16 @@
1707
1731
  "description": "Renders the field in a readonly state.",
1708
1732
  "type": "boolean"
1709
1733
  },
1710
- { "name": "name", "type": "string" },
1711
- { "name": "value", "type": "string" }
1734
+ {
1735
+ "name": "name",
1736
+ "description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form.",
1737
+ "type": "string"
1738
+ },
1739
+ {
1740
+ "name": "value",
1741
+ "description": "Lets you set the current value.",
1742
+ "type": "string"
1743
+ }
1712
1744
  ],
1713
1745
  "events": [{ "name": "change", "type": "CustomEvent" }]
1714
1746
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@warp-ds/elements",
3
3
  "type": "module",
4
- "version": "2.9.1",
4
+ "version": "2.9.2-next.1",
5
5
  "packageManager": "pnpm@10.33.2",
6
6
  "description": "Custom elements for Warp",
7
7
  "exports": {