@warp-ds/elements 2.9.1 → 2.10.0-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.
- package/dist/custom-elements.json +347 -284
- package/dist/docs/button/accessibility.md +42 -0
- package/dist/docs/button/api.md +63 -39
- package/dist/docs/button/button.md +322 -40
- package/dist/docs/button/examples.md +126 -0
- package/dist/docs/button/usage.md +89 -0
- package/dist/docs/modal/accessibility.md +1 -0
- package/dist/docs/modal/api.md +51 -0
- package/dist/docs/modal/examples.md +67 -0
- package/dist/docs/modal/modal.md +238 -0
- package/dist/docs/modal/usage.md +110 -0
- package/dist/docs/modal-footer/accessibility.md +1 -0
- package/dist/docs/modal-footer/api.md +11 -0
- package/dist/docs/modal-footer/examples.md +1 -0
- package/dist/docs/modal-footer/modal-footer.md +23 -0
- package/dist/docs/modal-footer/usage.md +1 -0
- package/dist/docs/modal-header/accessibility.md +1 -0
- package/dist/docs/modal-header/api.md +42 -0
- package/dist/docs/modal-header/examples.md +1 -0
- package/dist/docs/modal-header/modal-header.md +54 -0
- package/dist/docs/modal-header/usage.md +1 -0
- package/dist/docs/page-indicator/api.md +6 -6
- package/dist/docs/page-indicator/examples.md +8 -0
- package/dist/docs/page-indicator/page-indicator.md +23 -6
- package/dist/docs/page-indicator/usage.md +8 -0
- package/dist/docs/pagination/api.md +12 -10
- package/dist/docs/pagination/examples.md +20 -0
- package/dist/docs/pagination/pagination.md +50 -12
- package/dist/docs/pagination/usage.md +18 -0
- package/dist/docs/pill/accessibility.md +2 -0
- package/dist/docs/pill/api.md +10 -26
- package/dist/docs/pill/examples.md +23 -0
- package/dist/docs/pill/pill.md +43 -28
- package/dist/docs/pill/usage.md +8 -0
- package/dist/docs/radio/accessibility.md +1 -0
- package/dist/docs/radio/api.md +57 -0
- package/dist/docs/radio/examples.md +1 -0
- package/dist/docs/radio/radio.md +69 -0
- package/dist/docs/radio/usage.md +1 -0
- package/dist/docs/radio-group/accessibility.md +1 -0
- package/dist/docs/radio-group/api.md +69 -0
- package/dist/docs/radio-group/examples.md +68 -0
- package/dist/docs/radio-group/radio-group.md +311 -0
- package/dist/docs/radio-group/styling.md +118 -0
- package/dist/docs/radio-group/usage.md +44 -0
- package/dist/docs/select/accessibility.md +2 -0
- package/dist/docs/select/api.md +20 -16
- package/dist/docs/select/examples.md +116 -0
- package/dist/docs/select/select.md +168 -18
- package/dist/docs/select/usage.md +30 -0
- package/dist/index.d.ts +441 -474
- package/dist/packages/attention/attention.js +23 -21
- package/dist/packages/attention/attention.js.map +3 -3
- package/dist/packages/button/button.d.ts +54 -37
- package/dist/packages/button/button.js +17 -15
- package/dist/packages/button/button.js.map +3 -3
- package/dist/packages/button/button.react.stories.d.ts +2 -2
- package/dist/packages/button/react.d.ts +1 -1
- package/dist/packages/modal/index.d.ts +4 -4
- package/dist/packages/modal/index.js +4 -4
- package/dist/packages/modal/modal.d.ts +21 -12
- package/dist/packages/modal/modal.js +4 -4
- package/dist/packages/modal/modal.js.map +3 -3
- package/dist/packages/modal/modal.react.stories.d.ts +3 -3
- package/dist/packages/modal/modal.stories.d.ts +2 -1
- package/dist/packages/modal/modal.stories.js +85 -3
- package/dist/packages/modal/react.d.ts +2 -2
- package/dist/packages/modal-footer/modal-footer.d.ts +5 -3
- package/dist/packages/modal-footer/modal-footer.js +4 -4
- package/dist/packages/modal-footer/modal-footer.js.map +3 -3
- package/dist/packages/modal-footer/react.d.ts +1 -1
- package/dist/packages/modal-header/modal-header.d.ts +21 -11
- package/dist/packages/modal-header/modal-header.js +1 -1
- package/dist/packages/modal-header/modal-header.js.map +3 -3
- package/dist/packages/modal-header/react.d.ts +2 -2
- package/dist/packages/page-indicator/page-indicator.d.ts +9 -14
- package/dist/packages/page-indicator/page-indicator.js.map +2 -2
- package/dist/packages/pagination/pagination.d.ts +11 -11
- package/dist/packages/pagination/pagination.js.map +2 -2
- package/dist/packages/pill/pill.d.ts +14 -29
- package/dist/packages/pill/pill.js.map +2 -2
- package/dist/packages/pill/pill.react.stories.d.ts +2 -2
- package/dist/packages/pill/react.d.ts +1 -1
- package/dist/packages/radio/radio.d.ts +51 -13
- package/dist/packages/radio/radio.js +3 -3
- package/dist/packages/radio/radio.js.map +3 -3
- package/dist/packages/radio/radio.react.stories.d.ts +1 -1
- package/dist/packages/radio/radio.stories.d.ts +2 -2
- package/dist/packages/radio/react.d.ts +2 -2
- package/dist/packages/radio-group/radio-group.d.ts +43 -5
- package/dist/packages/radio-group/radio-group.js +7 -7
- package/dist/packages/radio-group/radio-group.js.map +3 -3
- package/dist/packages/radio-group/react.d.ts +4 -4
- package/dist/packages/select/select.d.ts +32 -48
- package/dist/packages/select/select.js.map +2 -2
- package/dist/web-types.json +349 -115
- package/package.json +5 -5
package/dist/web-types.json
CHANGED
|
@@ -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.
|
|
4
|
+
"version": "2.9.2-next.1",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
@@ -397,76 +397,185 @@
|
|
|
397
397
|
},
|
|
398
398
|
{
|
|
399
399
|
"name": "w-button",
|
|
400
|
-
"description": "
|
|
400
|
+
"description": "Performs an action or renders a link with button styling.\nUse button variants to match action priority, risk, and context.\n\n[See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/buttons-button--docs)\n---\n",
|
|
401
401
|
"doc-url": "",
|
|
402
402
|
"attributes": [
|
|
403
403
|
{
|
|
404
404
|
"name": "type",
|
|
405
|
+
"description": "Native button type.\nControls whether the internal button behaves as a regular button, submits a form, or resets a form. Defaults to `button`.",
|
|
405
406
|
"value": { "type": "'button' | 'submit' | 'reset'" }
|
|
406
407
|
},
|
|
407
408
|
{
|
|
408
409
|
"name": "autofocus",
|
|
410
|
+
"description": "Focuses the button when it is first rendered.\nApplies only when the component renders a native button. Link buttons with `href` do not autofocus through this component.",
|
|
409
411
|
"value": { "type": "boolean", "default": "false" }
|
|
410
412
|
},
|
|
411
413
|
{
|
|
412
414
|
"name": "variant",
|
|
415
|
+
"description": "Visual style of the button.\nDefaults to `secondary`. Use the variant that matches the action priority, risk, and placement.",
|
|
413
416
|
"value": {
|
|
414
417
|
"type": "'negative' | 'primary' | 'secondary' | 'negativeQuiet' | 'utility' | 'quiet' | 'utilityQuiet' | 'overlay' | 'overlayInverted' | 'overlayQuiet' | 'overlayInvertedQuiet' | 'pill' | 'link'"
|
|
415
418
|
}
|
|
416
419
|
},
|
|
417
420
|
{
|
|
418
421
|
"name": "quiet",
|
|
422
|
+
"description": "Deprecated quiet visual treatment flag\nUse `variant=\"quiet\"` instead.",
|
|
419
423
|
"value": { "type": "boolean", "default": "false" }
|
|
420
424
|
},
|
|
421
425
|
{
|
|
422
426
|
"name": "icon-only",
|
|
427
|
+
"description": "Marks the button as icon-only.\nUse this when the button has no visible text. Include accessible text in the slotted content so the internal button has a name.",
|
|
423
428
|
"value": { "type": "boolean", "default": "false" }
|
|
424
429
|
},
|
|
425
430
|
{
|
|
426
431
|
"name": "small",
|
|
432
|
+
"description": "Renders the compact button size.\nUse this in dense layouts where the default button size is too large.",
|
|
427
433
|
"value": { "type": "boolean", "default": "false" }
|
|
428
434
|
},
|
|
429
435
|
{
|
|
430
436
|
"name": "loading",
|
|
437
|
+
"description": "Shows the loading state.\nUse after the user has triggered an action and the action is in progress.",
|
|
431
438
|
"value": { "type": "boolean", "default": "false" }
|
|
432
439
|
},
|
|
433
|
-
{
|
|
434
|
-
|
|
440
|
+
{
|
|
441
|
+
"name": "href",
|
|
442
|
+
"description": "URL for rendering the button as a link.\nWhen set, the component renders `w-link` instead of a native `button`.",
|
|
443
|
+
"value": { "type": "string" }
|
|
444
|
+
},
|
|
445
|
+
{
|
|
446
|
+
"name": "target",
|
|
447
|
+
"description": "Link browsing context.\nPassed to the rendered link when `href` is set.",
|
|
448
|
+
"value": { "type": "string" }
|
|
449
|
+
},
|
|
435
450
|
{
|
|
436
451
|
"name": "disabled",
|
|
452
|
+
"description": "Visually disables the button.\nDisabled buttons are discouraged because they can hide the reason an action is unavailable.",
|
|
437
453
|
"value": { "type": "boolean", "default": "false" }
|
|
438
454
|
},
|
|
439
|
-
{
|
|
455
|
+
{
|
|
456
|
+
"name": "rel",
|
|
457
|
+
"description": "Link relationship.\nPassed to the rendered link when `href` is set. If `target=\"_blank\"` is set and `rel` is omitted, `noopener` is used.",
|
|
458
|
+
"value": { "type": "string" }
|
|
459
|
+
},
|
|
440
460
|
{
|
|
441
461
|
"name": "full-width",
|
|
462
|
+
"description": "Makes the button fill its parent width.\nUseful in narrow layouts where the button should span the available inline space.",
|
|
442
463
|
"value": { "type": "boolean", "default": "false" }
|
|
443
464
|
},
|
|
444
|
-
{
|
|
445
|
-
|
|
446
|
-
|
|
465
|
+
{
|
|
466
|
+
"name": "button-class",
|
|
467
|
+
"description": "Deprecated class applied to the internal control\nThis class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the button appearance.",
|
|
468
|
+
"value": { "type": "string" }
|
|
469
|
+
},
|
|
470
|
+
{
|
|
471
|
+
"name": "name",
|
|
472
|
+
"description": "Form control name.\nUsed when the button participates in form handling.",
|
|
473
|
+
"value": { "type": "string" }
|
|
474
|
+
},
|
|
475
|
+
{
|
|
476
|
+
"name": "value",
|
|
477
|
+
"description": "Form control value.\nUsed with `name` when the button participates in form handling. Resets to its initial value when the form is reset.",
|
|
478
|
+
"value": { "type": "string" }
|
|
479
|
+
},
|
|
480
|
+
{
|
|
481
|
+
"name": "commandfor",
|
|
482
|
+
"description": "The [commandfor HTML attribute](https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Commands_API#html_attributes) for Invoker Commands.",
|
|
483
|
+
"value": { "type": "string" }
|
|
484
|
+
},
|
|
485
|
+
{
|
|
486
|
+
"name": "command",
|
|
487
|
+
"description": "The [command HTML attribute](https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Commands_API#html_attributes) for Invoker Commands.",
|
|
488
|
+
"value": { "type": "string" }
|
|
489
|
+
}
|
|
447
490
|
],
|
|
448
491
|
"events": [],
|
|
449
492
|
"js": {
|
|
450
493
|
"properties": [
|
|
451
|
-
{
|
|
452
|
-
|
|
494
|
+
{
|
|
495
|
+
"name": "type",
|
|
496
|
+
"description": "Native button type.\nControls whether the internal button behaves as a regular button, submits a form, or resets a form. Defaults to `button`.",
|
|
497
|
+
"type": "'button' | 'submit' | 'reset'"
|
|
498
|
+
},
|
|
499
|
+
{
|
|
500
|
+
"name": "autofocus",
|
|
501
|
+
"description": "Focuses the button when it is first rendered.\nApplies only when the component renders a native button. Link buttons with `href` do not autofocus through this component.",
|
|
502
|
+
"type": "boolean"
|
|
503
|
+
},
|
|
453
504
|
{
|
|
454
505
|
"name": "variant",
|
|
506
|
+
"description": "Visual style of the button.\nDefaults to `secondary`. Use the variant that matches the action priority, risk, and placement.",
|
|
455
507
|
"type": "'negative' | 'primary' | 'secondary' | 'negativeQuiet' | 'utility' | 'quiet' | 'utilityQuiet' | 'overlay' | 'overlayInverted' | 'overlayQuiet' | 'overlayInvertedQuiet' | 'pill' | 'link'"
|
|
456
508
|
},
|
|
457
|
-
{
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
{
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
{
|
|
468
|
-
|
|
469
|
-
|
|
509
|
+
{
|
|
510
|
+
"name": "quiet",
|
|
511
|
+
"description": "Deprecated quiet visual treatment flag\nUse `variant=\"quiet\"` instead.",
|
|
512
|
+
"type": "boolean"
|
|
513
|
+
},
|
|
514
|
+
{
|
|
515
|
+
"name": "iconOnly",
|
|
516
|
+
"description": "Marks the button as icon-only.\nUse this when the button has no visible text. Include accessible text in the slotted content so the internal button has a name.",
|
|
517
|
+
"type": "boolean"
|
|
518
|
+
},
|
|
519
|
+
{
|
|
520
|
+
"name": "small",
|
|
521
|
+
"description": "Renders the compact button size.\nUse this in dense layouts where the default button size is too large.",
|
|
522
|
+
"type": "boolean"
|
|
523
|
+
},
|
|
524
|
+
{
|
|
525
|
+
"name": "loading",
|
|
526
|
+
"description": "Shows the loading state.\nUse after the user has triggered an action and the action is in progress.",
|
|
527
|
+
"type": "boolean"
|
|
528
|
+
},
|
|
529
|
+
{
|
|
530
|
+
"name": "href",
|
|
531
|
+
"description": "URL for rendering the button as a link.\nWhen set, the component renders `w-link` instead of a native `button`.",
|
|
532
|
+
"type": "string"
|
|
533
|
+
},
|
|
534
|
+
{
|
|
535
|
+
"name": "target",
|
|
536
|
+
"description": "Link browsing context.\nPassed to the rendered link when `href` is set.",
|
|
537
|
+
"type": "string"
|
|
538
|
+
},
|
|
539
|
+
{
|
|
540
|
+
"name": "disabled",
|
|
541
|
+
"description": "Visually disables the button.\nDisabled buttons are discouraged because they can hide the reason an action is unavailable.",
|
|
542
|
+
"type": "boolean"
|
|
543
|
+
},
|
|
544
|
+
{
|
|
545
|
+
"name": "rel",
|
|
546
|
+
"description": "Link relationship.\nPassed to the rendered link when `href` is set. If `target=\"_blank\"` is set and `rel` is omitted, `noopener` is used.",
|
|
547
|
+
"type": "string"
|
|
548
|
+
},
|
|
549
|
+
{
|
|
550
|
+
"name": "fullWidth",
|
|
551
|
+
"description": "Makes the button fill its parent width.\nUseful in narrow layouts where the button should span the available inline space.",
|
|
552
|
+
"type": "boolean"
|
|
553
|
+
},
|
|
554
|
+
{
|
|
555
|
+
"name": "buttonClass",
|
|
556
|
+
"description": "Deprecated class applied to the internal control\nThis class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the button appearance.",
|
|
557
|
+
"type": "string"
|
|
558
|
+
},
|
|
559
|
+
{
|
|
560
|
+
"name": "name",
|
|
561
|
+
"description": "Form control name.\nUsed when the button participates in form handling.",
|
|
562
|
+
"type": "string"
|
|
563
|
+
},
|
|
564
|
+
{
|
|
565
|
+
"name": "value",
|
|
566
|
+
"description": "Form control value.\nUsed with `name` when the button participates in form handling. Resets to its initial value when the form is reset.",
|
|
567
|
+
"type": "string"
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
"name": "commandfor",
|
|
571
|
+
"description": "The [commandfor HTML attribute](https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Commands_API#html_attributes) for Invoker Commands.",
|
|
572
|
+
"type": "string"
|
|
573
|
+
},
|
|
574
|
+
{
|
|
575
|
+
"name": "command",
|
|
576
|
+
"description": "The [command HTML attribute](https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Commands_API#html_attributes) for Invoker Commands.",
|
|
577
|
+
"type": "string"
|
|
578
|
+
}
|
|
470
579
|
],
|
|
471
580
|
"events": []
|
|
472
581
|
}
|
|
@@ -1242,16 +1351,18 @@
|
|
|
1242
1351
|
},
|
|
1243
1352
|
{
|
|
1244
1353
|
"name": "w-modal",
|
|
1245
|
-
"description": "Modals (or dialogs) display important information that users need to acknowledge.\n
|
|
1354
|
+
"description": "Modals (or dialogs) display important information that users need to acknowledge.\n---\n\n\n### **Events:**\n - **shown**\n- **hidden**\n\n### **Slots:**\n - **header** - Typically where you would use the `w-modal-header` component.\n- **content** - The main content of the modal.\n- **footer** - Typically where you would use the `w-modal-footer` component, for things like actions.",
|
|
1246
1355
|
"doc-url": "",
|
|
1247
1356
|
"attributes": [
|
|
1248
1357
|
{
|
|
1249
1358
|
"name": "show",
|
|
1359
|
+
"description": "Controls if the modal should show or hide.\n\nYou can also call the `open()` and `close()` methods.",
|
|
1250
1360
|
"value": { "type": "boolean", "default": "false" }
|
|
1251
1361
|
},
|
|
1252
1362
|
{ "name": "content-id", "value": { "type": "string" } },
|
|
1253
1363
|
{
|
|
1254
1364
|
"name": "ignore-backdrop-clicks",
|
|
1365
|
+
"description": "Ignores clicks to the backdrop when set",
|
|
1255
1366
|
"value": { "type": "boolean", "default": "false" }
|
|
1256
1367
|
}
|
|
1257
1368
|
],
|
|
@@ -1275,12 +1386,17 @@
|
|
|
1275
1386
|
],
|
|
1276
1387
|
"js": {
|
|
1277
1388
|
"properties": [
|
|
1278
|
-
{
|
|
1389
|
+
{
|
|
1390
|
+
"name": "show",
|
|
1391
|
+
"description": "Controls if the modal should show or hide.\n\nYou can also call the `open()` and `close()` methods.",
|
|
1392
|
+
"type": "boolean"
|
|
1393
|
+
},
|
|
1279
1394
|
{ "name": "contentId", "type": "string" },
|
|
1280
|
-
{
|
|
1281
|
-
|
|
1282
|
-
|
|
1283
|
-
|
|
1395
|
+
{
|
|
1396
|
+
"name": "ignoreBackdropClicks",
|
|
1397
|
+
"description": "Ignores clicks to the backdrop when set",
|
|
1398
|
+
"type": "boolean"
|
|
1399
|
+
}
|
|
1284
1400
|
],
|
|
1285
1401
|
"events": [
|
|
1286
1402
|
{ "name": "shown", "type": "CustomEvent" },
|
|
@@ -1290,7 +1406,7 @@
|
|
|
1290
1406
|
},
|
|
1291
1407
|
{
|
|
1292
1408
|
"name": "w-modal-footer",
|
|
1293
|
-
"description": "The footer section of a modal, typically where you place actions.\n
|
|
1409
|
+
"description": "The footer section of a modal, typically where you place actions.\n---\n",
|
|
1294
1410
|
"doc-url": "",
|
|
1295
1411
|
"attributes": [],
|
|
1296
1412
|
"events": [],
|
|
@@ -1298,16 +1414,22 @@
|
|
|
1298
1414
|
},
|
|
1299
1415
|
{
|
|
1300
1416
|
"name": "w-modal-header",
|
|
1301
|
-
"description": "The header section of a modal, typically where you place the title and a close button.\n
|
|
1417
|
+
"description": "The header section of a modal, typically where you place the title and a close button.\n---\n\n\n### **Events:**\n - **backClicked**\n\n### **Slots:**\n - **top** - Customize the title bar, for example to have a header image that reaches the modal's edges. See the With Image story for an example.",
|
|
1302
1418
|
"doc-url": "",
|
|
1303
1419
|
"attributes": [
|
|
1304
|
-
{
|
|
1420
|
+
{
|
|
1421
|
+
"name": "title",
|
|
1422
|
+
"description": "A short but descriptive title for the modal",
|
|
1423
|
+
"value": { "type": "string" }
|
|
1424
|
+
},
|
|
1305
1425
|
{
|
|
1306
1426
|
"name": "back",
|
|
1427
|
+
"description": "Whether the modal header should have a back button",
|
|
1307
1428
|
"value": { "type": "boolean", "default": "false" }
|
|
1308
1429
|
},
|
|
1309
1430
|
{
|
|
1310
1431
|
"name": "no-close",
|
|
1432
|
+
"description": "Lets you hide the close button in the header",
|
|
1311
1433
|
"value": { "type": "boolean", "default": "false" }
|
|
1312
1434
|
}
|
|
1313
1435
|
],
|
|
@@ -1320,31 +1442,39 @@
|
|
|
1320
1442
|
"events": [{ "name": "backClicked", "type": "CustomEvent" }],
|
|
1321
1443
|
"js": {
|
|
1322
1444
|
"properties": [
|
|
1323
|
-
{
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
{
|
|
1329
|
-
|
|
1445
|
+
{
|
|
1446
|
+
"name": "title",
|
|
1447
|
+
"description": "A short but descriptive title for the modal",
|
|
1448
|
+
"type": "string"
|
|
1449
|
+
},
|
|
1450
|
+
{
|
|
1451
|
+
"name": "back",
|
|
1452
|
+
"description": "Whether the modal header should have a back button",
|
|
1453
|
+
"type": "boolean"
|
|
1454
|
+
},
|
|
1455
|
+
{
|
|
1456
|
+
"name": "noClose",
|
|
1457
|
+
"description": "Lets you hide the close button in the header",
|
|
1458
|
+
"type": "boolean"
|
|
1459
|
+
}
|
|
1330
1460
|
],
|
|
1331
1461
|
"events": [{ "name": "backClicked", "type": "CustomEvent" }]
|
|
1332
1462
|
}
|
|
1333
1463
|
},
|
|
1334
1464
|
{
|
|
1335
1465
|
"name": "w-page-indicator",
|
|
1336
|
-
"description": "A page indicator component that displays a series of dots representing pages.\nOne dot is highlighted to indicate the currently selected page.\n---\n",
|
|
1466
|
+
"description": "A page indicator component that displays a series of dots representing pages.\n\nOne dot is highlighted to indicate the currently selected page.\n---\n",
|
|
1337
1467
|
"doc-url": "",
|
|
1338
1468
|
"attributes": [
|
|
1339
1469
|
{
|
|
1340
1470
|
"name": "selected-page",
|
|
1341
|
-
"description": "Currently selected page (1-based index
|
|
1342
|
-
"value": { "type": "number" }
|
|
1471
|
+
"description": "Currently selected page (1-based index)",
|
|
1472
|
+
"value": { "type": "number", "default": "1" }
|
|
1343
1473
|
},
|
|
1344
1474
|
{
|
|
1345
1475
|
"name": "page-count",
|
|
1346
|
-
"description": "Total number of pages
|
|
1347
|
-
"value": { "type": "number" }
|
|
1476
|
+
"description": "Total number of pages",
|
|
1477
|
+
"value": { "type": "number", "default": "1" }
|
|
1348
1478
|
}
|
|
1349
1479
|
],
|
|
1350
1480
|
"events": [],
|
|
@@ -1352,12 +1482,12 @@
|
|
|
1352
1482
|
"properties": [
|
|
1353
1483
|
{
|
|
1354
1484
|
"name": "selectedPage",
|
|
1355
|
-
"description": "Currently selected page (1-based index
|
|
1485
|
+
"description": "Currently selected page (1-based index)",
|
|
1356
1486
|
"type": "number"
|
|
1357
1487
|
},
|
|
1358
1488
|
{
|
|
1359
1489
|
"name": "pageCount",
|
|
1360
|
-
"description": "Total number of pages
|
|
1490
|
+
"description": "Total number of pages",
|
|
1361
1491
|
"type": "number"
|
|
1362
1492
|
}
|
|
1363
1493
|
],
|
|
@@ -1366,79 +1496,151 @@
|
|
|
1366
1496
|
},
|
|
1367
1497
|
{
|
|
1368
1498
|
"name": "w-pagination",
|
|
1369
|
-
"description": "Pagination allows users to navigate through multiple pages of content by providing navigation controls with page numbers and directional arrows.\n
|
|
1499
|
+
"description": "Pagination allows users to navigate through multiple pages of content by providing navigation controls with page numbers and directional arrows.\n---\n\n\n### **Events:**\n - **page-click** - Triggered when a link in the pagination is clicked. Contains the page number in `string` form.",
|
|
1370
1500
|
"doc-url": "",
|
|
1371
1501
|
"attributes": [
|
|
1372
|
-
{
|
|
1373
|
-
|
|
1374
|
-
|
|
1375
|
-
|
|
1502
|
+
{
|
|
1503
|
+
"name": "base-url",
|
|
1504
|
+
"description": "The base URL used to construct page links, for example `/search?page=`.\n\nThe page number is appended to this URL.",
|
|
1505
|
+
"value": { "type": "string" }
|
|
1506
|
+
},
|
|
1507
|
+
{
|
|
1508
|
+
"name": "pages",
|
|
1509
|
+
"description": "The total number of pages.",
|
|
1510
|
+
"value": { "type": "number" }
|
|
1511
|
+
},
|
|
1512
|
+
{
|
|
1513
|
+
"name": "current-page",
|
|
1514
|
+
"description": "The currently active page number.",
|
|
1515
|
+
"value": { "type": "number", "default": "1" }
|
|
1516
|
+
},
|
|
1517
|
+
{
|
|
1518
|
+
"name": "visible-pages",
|
|
1519
|
+
"description": "The maximum number of page numbers visible.",
|
|
1520
|
+
"value": { "type": "number", "default": "7" }
|
|
1521
|
+
}
|
|
1376
1522
|
],
|
|
1377
1523
|
"events": [
|
|
1378
1524
|
{
|
|
1379
1525
|
"name": "page-click",
|
|
1380
1526
|
"type": "CustomEvent",
|
|
1381
|
-
"description": "Triggered when a link
|
|
1527
|
+
"description": "Triggered when a link in the pagination is clicked. Contains the page number in `string` form."
|
|
1382
1528
|
}
|
|
1383
1529
|
],
|
|
1384
1530
|
"js": {
|
|
1385
1531
|
"properties": [
|
|
1386
|
-
{
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
|
|
1532
|
+
{
|
|
1533
|
+
"name": "baseUrl",
|
|
1534
|
+
"description": "The base URL used to construct page links, for example `/search?page=`.\n\nThe page number is appended to this URL.",
|
|
1535
|
+
"type": "string"
|
|
1536
|
+
},
|
|
1537
|
+
{
|
|
1538
|
+
"name": "pages",
|
|
1539
|
+
"description": "The total number of pages.",
|
|
1540
|
+
"type": "number"
|
|
1541
|
+
},
|
|
1542
|
+
{
|
|
1543
|
+
"name": "currentPageNumber",
|
|
1544
|
+
"description": "The currently active page number.",
|
|
1545
|
+
"type": "number"
|
|
1546
|
+
},
|
|
1547
|
+
{
|
|
1548
|
+
"name": "visiblePages",
|
|
1549
|
+
"description": "The maximum number of page numbers visible.",
|
|
1550
|
+
"type": "number"
|
|
1551
|
+
}
|
|
1390
1552
|
],
|
|
1391
1553
|
"events": [
|
|
1392
1554
|
{
|
|
1393
1555
|
"name": "page-click",
|
|
1394
1556
|
"type": "CustomEvent",
|
|
1395
|
-
"description": "Triggered when a link
|
|
1557
|
+
"description": "Triggered when a link in the pagination is clicked. Contains the page number in `string` form."
|
|
1396
1558
|
}
|
|
1397
1559
|
]
|
|
1398
1560
|
}
|
|
1399
1561
|
},
|
|
1400
1562
|
{
|
|
1401
1563
|
"name": "w-pill",
|
|
1402
|
-
"description": "Pill is a type of button that is often used as a filter, but can also be used as a rounded button for overlays, etc.\n
|
|
1564
|
+
"description": "Pill is a type of button that is often used as a filter, but can also be used as a rounded button for overlays, etc.\n---\n\n\n### **Events:**\n - **w-pill-click** - Fires when the pill itself is clicked.\n- **w-pill-close** - Fires when the pill's close button is clicked.",
|
|
1403
1565
|
"doc-url": "",
|
|
1404
1566
|
"attributes": [
|
|
1405
1567
|
{
|
|
1406
1568
|
"name": "can-close",
|
|
1569
|
+
"description": "Whether the pill should be removable via a close button.",
|
|
1407
1570
|
"value": { "type": "boolean", "default": "false" }
|
|
1408
1571
|
},
|
|
1409
1572
|
{
|
|
1410
1573
|
"name": "suggestion",
|
|
1574
|
+
"description": "Whether the pill should be rendered as a suggestion.",
|
|
1411
1575
|
"value": { "type": "boolean", "default": "false" }
|
|
1412
1576
|
},
|
|
1413
1577
|
{ "name": "open-sr-label", "value": { "type": "string" } },
|
|
1414
|
-
{
|
|
1578
|
+
{
|
|
1579
|
+
"name": "open-aria-label",
|
|
1580
|
+
"description": "Label read by screen readers when targeting the pill.",
|
|
1581
|
+
"value": { "type": "string" }
|
|
1582
|
+
},
|
|
1415
1583
|
{ "name": "close-sr-label", "value": { "type": "string" } },
|
|
1416
|
-
{
|
|
1584
|
+
{
|
|
1585
|
+
"name": "close-aria-label",
|
|
1586
|
+
"description": "Label read by screen readers when targeting the close button.",
|
|
1587
|
+
"value": { "type": "string" }
|
|
1588
|
+
}
|
|
1417
1589
|
],
|
|
1418
1590
|
"events": [
|
|
1419
|
-
{
|
|
1420
|
-
|
|
1591
|
+
{
|
|
1592
|
+
"name": "w-pill-click",
|
|
1593
|
+
"type": "CustomEvent",
|
|
1594
|
+
"description": "Fires when the pill itself is clicked."
|
|
1595
|
+
},
|
|
1596
|
+
{
|
|
1597
|
+
"name": "w-pill-close",
|
|
1598
|
+
"type": "CustomEvent",
|
|
1599
|
+
"description": "Fires when the pill's close button is clicked."
|
|
1600
|
+
}
|
|
1421
1601
|
],
|
|
1422
1602
|
"js": {
|
|
1423
1603
|
"properties": [
|
|
1424
|
-
{
|
|
1425
|
-
|
|
1604
|
+
{
|
|
1605
|
+
"name": "canClose",
|
|
1606
|
+
"description": "Whether the pill should be removable via a close button.",
|
|
1607
|
+
"type": "boolean"
|
|
1608
|
+
},
|
|
1609
|
+
{
|
|
1610
|
+
"name": "suggestion",
|
|
1611
|
+
"description": "Whether the pill should be rendered as a suggestion.",
|
|
1612
|
+
"type": "boolean"
|
|
1613
|
+
},
|
|
1426
1614
|
{ "name": "openSrLabel", "type": "string" },
|
|
1427
|
-
{
|
|
1615
|
+
{
|
|
1616
|
+
"name": "openAriaLabel",
|
|
1617
|
+
"description": "Label read by screen readers when targeting the pill.",
|
|
1618
|
+
"type": "string"
|
|
1619
|
+
},
|
|
1428
1620
|
{ "name": "closeSrLabel", "type": "string" },
|
|
1429
|
-
{
|
|
1430
|
-
|
|
1431
|
-
|
|
1621
|
+
{
|
|
1622
|
+
"name": "closeAriaLabel",
|
|
1623
|
+
"description": "Label read by screen readers when targeting the close button.",
|
|
1624
|
+
"type": "string"
|
|
1625
|
+
}
|
|
1432
1626
|
],
|
|
1433
1627
|
"events": [
|
|
1434
|
-
{
|
|
1435
|
-
|
|
1628
|
+
{
|
|
1629
|
+
"name": "w-pill-click",
|
|
1630
|
+
"type": "CustomEvent",
|
|
1631
|
+
"description": "Fires when the pill itself is clicked."
|
|
1632
|
+
},
|
|
1633
|
+
{
|
|
1634
|
+
"name": "w-pill-close",
|
|
1635
|
+
"type": "CustomEvent",
|
|
1636
|
+
"description": "Fires when the pill's close button is clicked."
|
|
1637
|
+
}
|
|
1436
1638
|
]
|
|
1437
1639
|
}
|
|
1438
1640
|
},
|
|
1439
1641
|
{
|
|
1440
1642
|
"name": "w-radio",
|
|
1441
|
-
"description": "\n---\n
|
|
1643
|
+
"description": "\n---\n",
|
|
1442
1644
|
"doc-url": "",
|
|
1443
1645
|
"attributes": [
|
|
1444
1646
|
{
|
|
@@ -1504,26 +1706,6 @@
|
|
|
1504
1706
|
"name": "invalid",
|
|
1505
1707
|
"description": "Draws the radio in an invalid state.",
|
|
1506
1708
|
"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
1709
|
}
|
|
1528
1710
|
],
|
|
1529
1711
|
"events": []
|
|
@@ -1531,32 +1713,42 @@
|
|
|
1531
1713
|
},
|
|
1532
1714
|
{
|
|
1533
1715
|
"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.",
|
|
1716
|
+
"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
1717
|
"doc-url": "",
|
|
1536
1718
|
"attributes": [
|
|
1537
|
-
{
|
|
1719
|
+
{
|
|
1720
|
+
"name": "label",
|
|
1721
|
+
"description": "Label for the radio group.",
|
|
1722
|
+
"value": { "type": "string", "default": "''" }
|
|
1723
|
+
},
|
|
1538
1724
|
{
|
|
1539
1725
|
"name": "help-text",
|
|
1726
|
+
"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
1727
|
"value": { "type": "string", "default": "''" }
|
|
1541
1728
|
},
|
|
1542
1729
|
{
|
|
1543
1730
|
"name": "optional",
|
|
1731
|
+
"description": "Whether to show optional text next to the label.",
|
|
1544
1732
|
"value": { "type": "boolean", "default": "false" }
|
|
1545
1733
|
},
|
|
1546
1734
|
{
|
|
1547
1735
|
"name": "invalid",
|
|
1736
|
+
"description": "Marks the radio group as invalid.",
|
|
1548
1737
|
"value": { "type": "boolean", "default": "false" }
|
|
1549
1738
|
},
|
|
1550
1739
|
{
|
|
1551
1740
|
"name": "name",
|
|
1741
|
+
"description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form.",
|
|
1552
1742
|
"value": { "type": "string | null", "default": "null" }
|
|
1553
1743
|
},
|
|
1554
1744
|
{
|
|
1555
1745
|
"name": "disabled",
|
|
1746
|
+
"description": "Disables the radio group and all child radios.",
|
|
1556
1747
|
"value": { "type": "boolean", "default": "false" }
|
|
1557
1748
|
},
|
|
1558
1749
|
{
|
|
1559
1750
|
"name": "required",
|
|
1751
|
+
"description": "Makes selecting a radio in the the group required.",
|
|
1560
1752
|
"value": { "type": "boolean", "default": "false" }
|
|
1561
1753
|
}
|
|
1562
1754
|
],
|
|
@@ -1573,22 +1765,48 @@
|
|
|
1573
1765
|
"events": [],
|
|
1574
1766
|
"js": {
|
|
1575
1767
|
"properties": [
|
|
1576
|
-
{
|
|
1577
|
-
|
|
1578
|
-
|
|
1579
|
-
|
|
1580
|
-
|
|
1581
|
-
{
|
|
1582
|
-
|
|
1583
|
-
|
|
1584
|
-
|
|
1768
|
+
{
|
|
1769
|
+
"name": "label",
|
|
1770
|
+
"description": "Label for the radio group.",
|
|
1771
|
+
"type": "string"
|
|
1772
|
+
},
|
|
1773
|
+
{
|
|
1774
|
+
"name": "helpText",
|
|
1775
|
+
"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.",
|
|
1776
|
+
"type": "string"
|
|
1777
|
+
},
|
|
1778
|
+
{
|
|
1779
|
+
"name": "optional",
|
|
1780
|
+
"description": "Whether to show optional text next to the label.",
|
|
1781
|
+
"type": "boolean"
|
|
1782
|
+
},
|
|
1783
|
+
{
|
|
1784
|
+
"name": "invalid",
|
|
1785
|
+
"description": "Marks the radio group as invalid.",
|
|
1786
|
+
"type": "boolean"
|
|
1787
|
+
},
|
|
1788
|
+
{
|
|
1789
|
+
"name": "name",
|
|
1790
|
+
"description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form.",
|
|
1791
|
+
"type": "string | null"
|
|
1792
|
+
},
|
|
1793
|
+
{
|
|
1794
|
+
"name": "disabled",
|
|
1795
|
+
"description": "Disables the radio group and all child radios.",
|
|
1796
|
+
"type": "boolean"
|
|
1797
|
+
},
|
|
1798
|
+
{
|
|
1799
|
+
"name": "required",
|
|
1800
|
+
"description": "Makes selecting a radio in the the group required.",
|
|
1801
|
+
"type": "boolean"
|
|
1802
|
+
}
|
|
1585
1803
|
],
|
|
1586
1804
|
"events": []
|
|
1587
1805
|
}
|
|
1588
1806
|
},
|
|
1589
1807
|
{
|
|
1590
1808
|
"name": "w-select",
|
|
1591
|
-
"description": "A dropdown component for selecting a single value.\n
|
|
1809
|
+
"description": "A dropdown component for selecting a single value.\n---\n\n\n### **Events:**\n - **change**",
|
|
1592
1810
|
"doc-url": "",
|
|
1593
1811
|
"attributes": [
|
|
1594
1812
|
{
|
|
@@ -1603,12 +1821,12 @@
|
|
|
1603
1821
|
},
|
|
1604
1822
|
{
|
|
1605
1823
|
"name": "help-text",
|
|
1606
|
-
"description": "The content displayed as the help text
|
|
1824
|
+
"description": "The content displayed as the help text.\n\nPaired with `invalid` to show the text as a validation error.",
|
|
1607
1825
|
"value": { "type": "string" }
|
|
1608
1826
|
},
|
|
1609
1827
|
{
|
|
1610
1828
|
"name": "invalid",
|
|
1611
|
-
"description": "Renders the field in an invalid state
|
|
1829
|
+
"description": "Renders the field in an invalid state.\n\nPaired with `help-text` to provide feedback about the error.",
|
|
1612
1830
|
"value": { "type": "boolean", "default": "false" }
|
|
1613
1831
|
},
|
|
1614
1832
|
{
|
|
@@ -1623,12 +1841,12 @@
|
|
|
1623
1841
|
},
|
|
1624
1842
|
{
|
|
1625
1843
|
"name": "label",
|
|
1626
|
-
"description": "The content to
|
|
1844
|
+
"description": "The content to display as the label.",
|
|
1627
1845
|
"value": { "type": "string" }
|
|
1628
1846
|
},
|
|
1629
1847
|
{
|
|
1630
1848
|
"name": "optional",
|
|
1631
|
-
"description": "Whether to show optional
|
|
1849
|
+
"description": "Whether to show the optional indicator after the label.",
|
|
1632
1850
|
"value": { "type": "boolean", "default": "false" }
|
|
1633
1851
|
},
|
|
1634
1852
|
{
|
|
@@ -1646,8 +1864,16 @@
|
|
|
1646
1864
|
"description": "Renders the field in a readonly state.",
|
|
1647
1865
|
"value": { "type": "boolean", "default": "false" }
|
|
1648
1866
|
},
|
|
1649
|
-
{
|
|
1650
|
-
|
|
1867
|
+
{
|
|
1868
|
+
"name": "name",
|
|
1869
|
+
"description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form.",
|
|
1870
|
+
"value": { "type": "string" }
|
|
1871
|
+
},
|
|
1872
|
+
{
|
|
1873
|
+
"name": "value",
|
|
1874
|
+
"description": "Lets you set the current value.",
|
|
1875
|
+
"value": { "type": "string" }
|
|
1876
|
+
}
|
|
1651
1877
|
],
|
|
1652
1878
|
"events": [{ "name": "change", "type": "CustomEvent" }],
|
|
1653
1879
|
"js": {
|
|
@@ -1664,12 +1890,12 @@
|
|
|
1664
1890
|
},
|
|
1665
1891
|
{
|
|
1666
1892
|
"name": "helpText",
|
|
1667
|
-
"description": "The content displayed as the help text
|
|
1893
|
+
"description": "The content displayed as the help text.\n\nPaired with `invalid` to show the text as a validation error.",
|
|
1668
1894
|
"type": "string"
|
|
1669
1895
|
},
|
|
1670
1896
|
{
|
|
1671
1897
|
"name": "invalid",
|
|
1672
|
-
"description": "Renders the field in an invalid state
|
|
1898
|
+
"description": "Renders the field in an invalid state.\n\nPaired with `help-text` to provide feedback about the error.",
|
|
1673
1899
|
"type": "boolean"
|
|
1674
1900
|
},
|
|
1675
1901
|
{
|
|
@@ -1684,12 +1910,12 @@
|
|
|
1684
1910
|
},
|
|
1685
1911
|
{
|
|
1686
1912
|
"name": "label",
|
|
1687
|
-
"description": "The content to
|
|
1913
|
+
"description": "The content to display as the label.",
|
|
1688
1914
|
"type": "string"
|
|
1689
1915
|
},
|
|
1690
1916
|
{
|
|
1691
1917
|
"name": "optional",
|
|
1692
|
-
"description": "Whether to show optional
|
|
1918
|
+
"description": "Whether to show the optional indicator after the label.",
|
|
1693
1919
|
"type": "boolean"
|
|
1694
1920
|
},
|
|
1695
1921
|
{
|
|
@@ -1707,8 +1933,16 @@
|
|
|
1707
1933
|
"description": "Renders the field in a readonly state.",
|
|
1708
1934
|
"type": "boolean"
|
|
1709
1935
|
},
|
|
1710
|
-
{
|
|
1711
|
-
|
|
1936
|
+
{
|
|
1937
|
+
"name": "name",
|
|
1938
|
+
"description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form.",
|
|
1939
|
+
"type": "string"
|
|
1940
|
+
},
|
|
1941
|
+
{
|
|
1942
|
+
"name": "value",
|
|
1943
|
+
"description": "Lets you set the current value.",
|
|
1944
|
+
"type": "string"
|
|
1945
|
+
}
|
|
1712
1946
|
],
|
|
1713
1947
|
"events": [{ "name": "change", "type": "CustomEvent" }]
|
|
1714
1948
|
}
|