@oicl/openbridge-webcomponents 2.0.0-next.152 → 2.0.0-next.153
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/bundle/openbridge-webcomponents.bundle.js +4717 -4485
- package/bundle/openbridge-webcomponents.bundle.js.map +1 -1
- package/custom-elements.json +510 -60
- package/dist/alert-severity.d.ts +19 -1
- package/dist/alert-severity.d.ts.map +1 -1
- package/dist/alert-severity.js +48 -2
- package/dist/alert-severity.js.map +1 -1
- package/dist/components/alert-button/alert-button.css.js +7 -1513
- package/dist/components/alert-button/alert-button.css.js.map +1 -1
- package/dist/components/alert-button/alert-button.d.ts +50 -86
- package/dist/components/alert-button/alert-button.d.ts.map +1 -1
- package/dist/components/alert-button/alert-button.js +40 -107
- package/dist/components/alert-button/alert-button.js.map +1 -1
- package/dist/components/alert-button-item/alert-button-item.css.js +1570 -0
- package/dist/components/alert-button-item/alert-button-item.css.js.map +1 -0
- package/dist/components/alert-button-item/alert-button-item.d.ts +162 -0
- package/dist/components/alert-button-item/alert-button-item.d.ts.map +1 -0
- package/dist/components/alert-button-item/alert-button-item.js +210 -0
- package/dist/components/alert-button-item/alert-button-item.js.map +1 -0
- package/dist/components/alert-counter-item/alert-counter-item.css.js +25 -0
- package/dist/components/alert-counter-item/alert-counter-item.css.js.map +1 -0
- package/dist/components/alert-counter-item/alert-counter-item.d.ts +77 -0
- package/dist/components/alert-counter-item/alert-counter-item.d.ts.map +1 -0
- package/dist/components/alert-counter-item/alert-counter-item.js +87 -0
- package/dist/components/alert-counter-item/alert-counter-item.js.map +1 -0
- package/dist/components/alert-frame/alert-frame.css.js +23 -27
- package/dist/components/alert-frame/alert-frame.css.js.map +1 -1
- package/dist/components/alert-frame/alert-frame.d.ts +7 -6
- package/dist/components/alert-frame/alert-frame.d.ts.map +1 -1
- package/dist/components/alert-frame/alert-frame.js +6 -9
- package/dist/components/alert-frame/alert-frame.js.map +1 -1
- package/dist/components/tree-navigation-item/tree-navigation-item.d.ts +7 -34
- package/dist/components/tree-navigation-item/tree-navigation-item.d.ts.map +1 -1
- package/dist/components/tree-navigation-item/tree-navigation-item.js +3 -32
- package/dist/components/tree-navigation-item/tree-navigation-item.js.map +1 -1
- package/dist/generated/locales/es-419.d.ts +11 -3
- package/dist/generated/locales/es-419.d.ts.map +1 -1
- package/dist/generated/locales/es-419.js +11 -3
- package/dist/generated/locales/es-419.js.map +1 -1
- package/dist/generated/locales/fi-FI.d.ts +8 -0
- package/dist/generated/locales/fi-FI.d.ts.map +1 -1
- package/dist/generated/locales/fi-FI.js +8 -0
- package/dist/generated/locales/fi-FI.js.map +1 -1
- package/dist/navigation-instruments/readout/readout.css.js +4 -29
- package/dist/navigation-instruments/readout/readout.css.js.map +1 -1
- package/dist/navigation-instruments/readout/readout.d.ts.map +1 -1
- package/dist/navigation-instruments/readout/readout.js +1 -9
- package/dist/navigation-instruments/readout/readout.js.map +1 -1
- package/dist/navigation-instruments/readout-list-item/readout-list-item.css.js +5 -34
- package/dist/navigation-instruments/readout-list-item/readout-list-item.css.js.map +1 -1
- package/dist/navigation-instruments/readout-list-item/readout-list-item.d.ts.map +1 -1
- package/dist/navigation-instruments/readout-list-item/readout-list-item.js +1 -9
- package/dist/navigation-instruments/readout-list-item/readout-list-item.js.map +1 -1
- package/dist/palettes/blinking.d.ts +6 -2
- package/dist/palettes/blinking.d.ts.map +1 -1
- package/dist/palettes/blinking.js +6 -2
- package/dist/palettes/blinking.js.map +1 -1
- package/dist/types.d.ts +15 -0
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js.map +1 -1
- package/package.json +1 -1
package/custom-elements.json
CHANGED
|
@@ -55396,18 +55396,344 @@
|
|
|
55396
55396
|
},
|
|
55397
55397
|
{
|
|
55398
55398
|
"kind": "javascript-module",
|
|
55399
|
-
"path": "src/components/alert-button/alert-button.ts",
|
|
55399
|
+
"path": "src/components/alert-button-item/alert-button-item.ts",
|
|
55400
55400
|
"declarations": [
|
|
55401
55401
|
{
|
|
55402
55402
|
"kind": "class",
|
|
55403
|
-
"description": "`<obc-alert-button>` –
|
|
55404
|
-
"name": "
|
|
55405
|
-
"
|
|
55403
|
+
"description": "`<obc-alert-button-item>` – The bell button that shows the alert state and count.\n\nShows the alert status as a bell in the style of the given alert type, with\nan optional counter, or as a global counter: one badge per severity, then\nthe bell and the total. `obc-alert-button` renders the item next to its\nsilence button; use the item on its own where no silence button is needed.\n\n---\n\n### Features\n- **Variants (`type`):** `flat` (icon only), `normal` (bordered, icon and\n counter) and `enhanced` (filled in the severity colour).\n- **Alert types:** `alarm`, `warning`, `caution` and the `level-*` family;\n `nAlerts` of 0 shows the idle bell.\n- **Counter:** `counter` shows `nAlerts` next to the bell, except in `flat`.\n- **Global counter:** `globalCounter` shows the per-severity `counts` as\n badges, then the bell and `nAlerts`, always in the normal style.\n- **Flashing:** `blinking` flashes the bell at the tempo `flashingSpeed`\n resolves (#1224).\n- **Fill height:** `fillHeight` stretches the visible button to the host\n height, as the tall `obc-alert-button` does.\n\n---\n\n### Usage Guidelines\n- Keep `nAlerts` and `counts` consistent; the item shows both as given.\n- The generated label reads e.g. \"Alerts, 12, 2 Alarm, 4 Warning,\n 6 Caution\"; an `aria-label` on the host replaces it.\n- A native button, so Enter and Space activate it (APG button pattern).\n- A parent that joins another button to the item's end sets the\n `data-group-item-not-last` attribute on the host.\n- **TODO(designer):** the Figma file draws the flat item's hover, active and\n focused variants at 20 % opacity; the item uses the standard flat states.\n- **TODO(designer):** the Figma file defines no flashing for the global\n counter, so it never flashes.\n\n---\n\n### Example\n\n```html\n<obc-alert-button-item alertType=\"alarm\" nAlerts=\"3\" counter blinking></obc-alert-button-item>\n<obc-alert-button-item\n globalCounter\n nAlerts=\"12\"\n .counts=${{countAlarm: 2, countWarning: 4, countCaution: 6}}\n></obc-alert-button-item>\n```",
|
|
55404
|
+
"name": "ObcAlertButtonItem",
|
|
55405
|
+
"members": [
|
|
55406
55406
|
{
|
|
55407
|
-
"
|
|
55408
|
-
"name": ""
|
|
55407
|
+
"kind": "field",
|
|
55408
|
+
"name": "type",
|
|
55409
|
+
"type": {
|
|
55410
|
+
"text": "ObcAlertButtonType"
|
|
55411
|
+
},
|
|
55412
|
+
"description": "Visual variant: `flat` (icon only), `normal` (default, bordered with the counter) or `enhanced` (filled in the severity colour).\n\nAvailable when `globalCounter==false`.",
|
|
55413
|
+
"attribute": "type",
|
|
55414
|
+
"availableWhen": "globalCounter==false",
|
|
55415
|
+
"availableWhenIf": {
|
|
55416
|
+
"arg": "globalCounter",
|
|
55417
|
+
"truthy": false
|
|
55418
|
+
}
|
|
55419
|
+
},
|
|
55420
|
+
{
|
|
55421
|
+
"kind": "field",
|
|
55422
|
+
"name": "alertType",
|
|
55423
|
+
"type": {
|
|
55424
|
+
"text": "AlertType | undefined"
|
|
55425
|
+
},
|
|
55426
|
+
"description": "Alert type that selects the icon and colours: `alarm`, `warning`, `caution` or a `level-*` severity.\n\nAvailable when `globalCounter==false`.",
|
|
55427
|
+
"attribute": "alertType",
|
|
55428
|
+
"availableWhen": "globalCounter==false",
|
|
55429
|
+
"availableWhenIf": {
|
|
55430
|
+
"arg": "globalCounter",
|
|
55431
|
+
"truthy": false
|
|
55432
|
+
}
|
|
55433
|
+
},
|
|
55434
|
+
{
|
|
55435
|
+
"kind": "field",
|
|
55436
|
+
"name": "nAlerts",
|
|
55437
|
+
"type": {
|
|
55438
|
+
"text": "number"
|
|
55439
|
+
},
|
|
55440
|
+
"default": "0",
|
|
55441
|
+
"description": "Number of active alerts; 0 shows the idle bell and hides the counter.",
|
|
55442
|
+
"attribute": "nAlerts"
|
|
55443
|
+
},
|
|
55444
|
+
{
|
|
55445
|
+
"kind": "field",
|
|
55446
|
+
"name": "counter",
|
|
55447
|
+
"type": {
|
|
55448
|
+
"text": "boolean"
|
|
55449
|
+
},
|
|
55450
|
+
"default": "false",
|
|
55451
|
+
"description": "Shows `nAlerts` next to the bell (not in `flat`).\n\nAvailable when `globalCounter==false`.",
|
|
55452
|
+
"attribute": "counter",
|
|
55453
|
+
"availableWhen": "globalCounter==false",
|
|
55454
|
+
"availableWhenIf": {
|
|
55455
|
+
"arg": "globalCounter",
|
|
55456
|
+
"truthy": false
|
|
55457
|
+
}
|
|
55458
|
+
},
|
|
55459
|
+
{
|
|
55460
|
+
"kind": "field",
|
|
55461
|
+
"name": "globalCounter",
|
|
55462
|
+
"type": {
|
|
55463
|
+
"text": "boolean"
|
|
55464
|
+
},
|
|
55465
|
+
"default": "false",
|
|
55466
|
+
"description": "Shows the per-severity counts, the bell and the total instead of a single alert status.",
|
|
55467
|
+
"attribute": "globalCounter"
|
|
55468
|
+
},
|
|
55469
|
+
{
|
|
55470
|
+
"kind": "field",
|
|
55471
|
+
"name": "counts",
|
|
55472
|
+
"type": {
|
|
55473
|
+
"text": "AlertCounts"
|
|
55474
|
+
},
|
|
55475
|
+
"default": "{}",
|
|
55476
|
+
"description": "Alert count per severity for the global counter badges.\n\nAvailable when `globalCounter==true`.",
|
|
55477
|
+
"availableWhen": "globalCounter==true",
|
|
55478
|
+
"availableWhenIf": {
|
|
55479
|
+
"arg": "globalCounter",
|
|
55480
|
+
"truthy": true
|
|
55481
|
+
}
|
|
55482
|
+
},
|
|
55483
|
+
{
|
|
55484
|
+
"kind": "field",
|
|
55485
|
+
"name": "shelvedCount",
|
|
55486
|
+
"type": {
|
|
55487
|
+
"text": "number"
|
|
55488
|
+
},
|
|
55489
|
+
"default": "0",
|
|
55490
|
+
"description": "Number of shelved alerts, shown after the global counter badges.\n\nAvailable when `globalCounter==true`.",
|
|
55491
|
+
"attribute": "shelvedCount",
|
|
55492
|
+
"availableWhen": "globalCounter==true",
|
|
55493
|
+
"availableWhenIf": {
|
|
55494
|
+
"arg": "globalCounter",
|
|
55495
|
+
"truthy": true
|
|
55496
|
+
}
|
|
55497
|
+
},
|
|
55498
|
+
{
|
|
55499
|
+
"kind": "field",
|
|
55500
|
+
"name": "blinking",
|
|
55501
|
+
"type": {
|
|
55502
|
+
"text": "boolean"
|
|
55503
|
+
},
|
|
55504
|
+
"default": "false",
|
|
55505
|
+
"description": "Flashes the bell while there are active alerts of a flashing alert type.\n\nAvailable when `globalCounter==false`.",
|
|
55506
|
+
"attribute": "blinking",
|
|
55507
|
+
"availableWhen": "globalCounter==false",
|
|
55508
|
+
"availableWhenIf": {
|
|
55509
|
+
"arg": "globalCounter",
|
|
55510
|
+
"truthy": false
|
|
55511
|
+
}
|
|
55512
|
+
},
|
|
55513
|
+
{
|
|
55514
|
+
"kind": "field",
|
|
55515
|
+
"name": "flashingSpeed",
|
|
55516
|
+
"type": {
|
|
55517
|
+
"text": "FlashingSpeed"
|
|
55518
|
+
},
|
|
55519
|
+
"description": "Flash tempo while `blinking` is on: `default` resolves from `alertType`, `fast`, `slow`, `very-slow` force a tempo, `fixed` never flashes.\n\nAvailable when `blinking==true`.",
|
|
55520
|
+
"attribute": "flashingSpeed",
|
|
55521
|
+
"availableWhen": "blinking==true",
|
|
55522
|
+
"availableWhenIf": {
|
|
55523
|
+
"arg": "blinking",
|
|
55524
|
+
"truthy": true
|
|
55525
|
+
}
|
|
55526
|
+
},
|
|
55527
|
+
{
|
|
55528
|
+
"kind": "field",
|
|
55529
|
+
"name": "fillHeight",
|
|
55530
|
+
"type": {
|
|
55531
|
+
"text": "boolean"
|
|
55532
|
+
},
|
|
55533
|
+
"default": "false",
|
|
55534
|
+
"description": "Stretches the visible button to the host height instead of the 32 px visual target.",
|
|
55535
|
+
"attribute": "fillHeight"
|
|
55536
|
+
},
|
|
55537
|
+
{
|
|
55538
|
+
"kind": "field",
|
|
55539
|
+
"name": "ariaLabel",
|
|
55540
|
+
"type": {
|
|
55541
|
+
"text": "string | null"
|
|
55542
|
+
},
|
|
55543
|
+
"default": "null",
|
|
55544
|
+
"description": "Accessible name forwarded to the inner `<button>`, mapped to the `aria-label` attribute; replaces the generated label. `aria-labelledby` is not supported: ID references cannot cross the shadow boundary.",
|
|
55545
|
+
"attribute": "aria-label"
|
|
55546
|
+
},
|
|
55547
|
+
{
|
|
55548
|
+
"kind": "field",
|
|
55549
|
+
"name": "flashing",
|
|
55550
|
+
"privacy": "protected",
|
|
55551
|
+
"readonly": true,
|
|
55552
|
+
"default": "new FlashingController( this, () => this.resolvedFlashingSpeed )"
|
|
55553
|
+
},
|
|
55554
|
+
{
|
|
55555
|
+
"kind": "field",
|
|
55556
|
+
"name": "resolvedFlashingSpeed",
|
|
55557
|
+
"type": {
|
|
55558
|
+
"text": "ResolvedFlashingSpeed"
|
|
55559
|
+
},
|
|
55560
|
+
"readonly": true
|
|
55561
|
+
},
|
|
55562
|
+
{
|
|
55563
|
+
"kind": "field",
|
|
55564
|
+
"name": "accessibleName",
|
|
55565
|
+
"type": {
|
|
55566
|
+
"text": "string"
|
|
55567
|
+
},
|
|
55568
|
+
"privacy": "private",
|
|
55569
|
+
"readonly": true
|
|
55570
|
+
},
|
|
55571
|
+
{
|
|
55572
|
+
"kind": "method",
|
|
55573
|
+
"name": "renderTwotoneIcon",
|
|
55574
|
+
"privacy": "private"
|
|
55575
|
+
},
|
|
55576
|
+
{
|
|
55577
|
+
"kind": "method",
|
|
55578
|
+
"name": "renderIcon",
|
|
55579
|
+
"privacy": "private",
|
|
55580
|
+
"parameters": [
|
|
55581
|
+
{
|
|
55582
|
+
"name": "styleType",
|
|
55583
|
+
"type": {
|
|
55584
|
+
"text": "ObcAlertButtonType"
|
|
55585
|
+
}
|
|
55586
|
+
},
|
|
55587
|
+
{
|
|
55588
|
+
"name": "blinkLayer",
|
|
55589
|
+
"type": {
|
|
55590
|
+
"text": "boolean"
|
|
55591
|
+
}
|
|
55592
|
+
}
|
|
55593
|
+
],
|
|
55594
|
+
"description": "The blink layer shows the opposite of the steady layer in each flash."
|
|
55595
|
+
},
|
|
55596
|
+
{
|
|
55597
|
+
"kind": "method",
|
|
55598
|
+
"name": "renderCount",
|
|
55599
|
+
"privacy": "private"
|
|
55600
|
+
},
|
|
55601
|
+
{
|
|
55602
|
+
"kind": "method",
|
|
55603
|
+
"name": "renderCounts",
|
|
55604
|
+
"privacy": "private"
|
|
55605
|
+
}
|
|
55606
|
+
],
|
|
55607
|
+
"events": [
|
|
55608
|
+
{
|
|
55609
|
+
"description": "Fired when the button is clicked.",
|
|
55610
|
+
"name": "click"
|
|
55611
|
+
}
|
|
55612
|
+
],
|
|
55613
|
+
"attributes": [
|
|
55614
|
+
{
|
|
55615
|
+
"name": "type",
|
|
55616
|
+
"type": {
|
|
55617
|
+
"text": "ObcAlertButtonType"
|
|
55618
|
+
},
|
|
55619
|
+
"description": "Visual variant: `flat` (icon only), `normal` (default, bordered with the counter) or `enhanced` (filled in the severity colour).\n\nAvailable when `globalCounter==false`.",
|
|
55620
|
+
"fieldName": "type"
|
|
55621
|
+
},
|
|
55622
|
+
{
|
|
55623
|
+
"name": "alertType",
|
|
55624
|
+
"type": {
|
|
55625
|
+
"text": "AlertType | undefined"
|
|
55626
|
+
},
|
|
55627
|
+
"description": "Alert type that selects the icon and colours: `alarm`, `warning`, `caution` or a `level-*` severity.\n\nAvailable when `globalCounter==false`.",
|
|
55628
|
+
"fieldName": "alertType"
|
|
55629
|
+
},
|
|
55630
|
+
{
|
|
55631
|
+
"name": "nAlerts",
|
|
55632
|
+
"type": {
|
|
55633
|
+
"text": "number"
|
|
55634
|
+
},
|
|
55635
|
+
"default": "0",
|
|
55636
|
+
"description": "Number of active alerts; 0 shows the idle bell and hides the counter.",
|
|
55637
|
+
"fieldName": "nAlerts"
|
|
55638
|
+
},
|
|
55639
|
+
{
|
|
55640
|
+
"name": "counter",
|
|
55641
|
+
"type": {
|
|
55642
|
+
"text": "boolean"
|
|
55643
|
+
},
|
|
55644
|
+
"default": "false",
|
|
55645
|
+
"description": "Shows `nAlerts` next to the bell (not in `flat`).\n\nAvailable when `globalCounter==false`.",
|
|
55646
|
+
"fieldName": "counter"
|
|
55647
|
+
},
|
|
55648
|
+
{
|
|
55649
|
+
"name": "globalCounter",
|
|
55650
|
+
"type": {
|
|
55651
|
+
"text": "boolean"
|
|
55652
|
+
},
|
|
55653
|
+
"default": "false",
|
|
55654
|
+
"description": "Shows the per-severity counts, the bell and the total instead of a single alert status.",
|
|
55655
|
+
"fieldName": "globalCounter"
|
|
55656
|
+
},
|
|
55657
|
+
{
|
|
55658
|
+
"name": "shelvedCount",
|
|
55659
|
+
"type": {
|
|
55660
|
+
"text": "number"
|
|
55661
|
+
},
|
|
55662
|
+
"default": "0",
|
|
55663
|
+
"description": "Number of shelved alerts, shown after the global counter badges.\n\nAvailable when `globalCounter==true`.",
|
|
55664
|
+
"fieldName": "shelvedCount"
|
|
55665
|
+
},
|
|
55666
|
+
{
|
|
55667
|
+
"name": "blinking",
|
|
55668
|
+
"type": {
|
|
55669
|
+
"text": "boolean"
|
|
55670
|
+
},
|
|
55671
|
+
"default": "false",
|
|
55672
|
+
"description": "Flashes the bell while there are active alerts of a flashing alert type.\n\nAvailable when `globalCounter==false`.",
|
|
55673
|
+
"fieldName": "blinking"
|
|
55674
|
+
},
|
|
55675
|
+
{
|
|
55676
|
+
"name": "flashingSpeed",
|
|
55677
|
+
"type": {
|
|
55678
|
+
"text": "FlashingSpeed"
|
|
55679
|
+
},
|
|
55680
|
+
"description": "Flash tempo while `blinking` is on: `default` resolves from `alertType`, `fast`, `slow`, `very-slow` force a tempo, `fixed` never flashes.\n\nAvailable when `blinking==true`.",
|
|
55681
|
+
"fieldName": "flashingSpeed"
|
|
55682
|
+
},
|
|
55683
|
+
{
|
|
55684
|
+
"name": "fillHeight",
|
|
55685
|
+
"type": {
|
|
55686
|
+
"text": "boolean"
|
|
55687
|
+
},
|
|
55688
|
+
"default": "false",
|
|
55689
|
+
"description": "Stretches the visible button to the host height instead of the 32 px visual target.",
|
|
55690
|
+
"fieldName": "fillHeight"
|
|
55691
|
+
},
|
|
55692
|
+
{
|
|
55693
|
+
"name": "aria-label",
|
|
55694
|
+
"type": {
|
|
55695
|
+
"text": "string | null"
|
|
55696
|
+
},
|
|
55697
|
+
"default": "null",
|
|
55698
|
+
"description": "Accessible name forwarded to the inner `<button>`, mapped to the `aria-label` attribute; replaces the generated label. `aria-labelledby` is not supported: ID references cannot cross the shadow boundary.",
|
|
55699
|
+
"fieldName": "ariaLabel"
|
|
55409
55700
|
}
|
|
55410
55701
|
],
|
|
55702
|
+
"superclass": {
|
|
55703
|
+
"name": "LitElement",
|
|
55704
|
+
"package": "lit"
|
|
55705
|
+
},
|
|
55706
|
+
"tagName": "obc-alert-button-item",
|
|
55707
|
+
"customElement": true
|
|
55708
|
+
}
|
|
55709
|
+
],
|
|
55710
|
+
"exports": [
|
|
55711
|
+
{
|
|
55712
|
+
"kind": "js",
|
|
55713
|
+
"name": "ObcAlertButtonItem",
|
|
55714
|
+
"declaration": {
|
|
55715
|
+
"name": "ObcAlertButtonItem",
|
|
55716
|
+
"module": "src/components/alert-button-item/alert-button-item.ts"
|
|
55717
|
+
}
|
|
55718
|
+
},
|
|
55719
|
+
{
|
|
55720
|
+
"kind": "custom-element-definition",
|
|
55721
|
+
"name": "obc-alert-button-item",
|
|
55722
|
+
"declaration": {
|
|
55723
|
+
"name": "ObcAlertButtonItem",
|
|
55724
|
+
"module": "src/components/alert-button-item/alert-button-item.ts"
|
|
55725
|
+
}
|
|
55726
|
+
}
|
|
55727
|
+
]
|
|
55728
|
+
},
|
|
55729
|
+
{
|
|
55730
|
+
"kind": "javascript-module",
|
|
55731
|
+
"path": "src/components/alert-button/alert-button.ts",
|
|
55732
|
+
"declarations": [
|
|
55733
|
+
{
|
|
55734
|
+
"kind": "class",
|
|
55735
|
+
"description": "`<obc-alert-button>` – A compact, icon-based button for displaying alert or notification status and count.\n\nThis component provides a visual indicator for active alerts or notifications, supporting different alert types (such as alarm, warning, or caution) and an optional counter badge. It can also include a secondary \"silence\" action button for muting alerts, adapting its layout responsively for different screen widths.\n\nAppears in toolbars or notification areas to give users a quick overview of alert status and provide direct access to alert-related actions. The bell itself is an `obc-alert-button-item`; use the item directly where no silence button or breakpoints are needed, or for its global counter.\n\n## Features\n\n- **Variants:**\n - **Flat:** Minimal, icon-only button for space-constrained layouts.\n - **Normal:** Standard button with icon and optional alert counter.\n - **Enhanced:** Visually prominent button for high-priority alerts, with accent styling.\n- **Alert Types:** Supports `alarm`, `warning`, `caution`, or no alert (idle). Icon and color adapt to the alert type.\n- **Alert Counter:** Optional badge displays the number of active alerts (except in flat mode).\n- **Global Counter:** `globalCounter` shows the per-severity `counts` and an optional `shelvedCount` before the bell and the total, as `obc-alert-button-item` draws them.\n- **Silence Button:** Optional secondary button to mute or silence alerts, shown when enabled and at sufficient width.\n- **Blinking Animation:** Can animate (blink) to draw attention to active alerts (except for caution type).\n- **Responsive Layout:** Automatically switches to flat mode below a configurable width, and hides the silence button below another configurable width.\n- **Large Size Option:** Increases button height and padding for touch-friendly or prominent use.\n\n## Usage Guidelines\n\nUse `<obc-alert-button>` to provide a persistent, easily accessible indicator of alert or notification status. Ideal for toolbars, headers, or notification panels where users need to be aware of active alerts and may need to silence them quickly.\n\n- Use the counter to show the number of active alerts when relevant.\n- Use the silence button to provide a quick mute action, but only when space allows.\n- Choose the variant (`flat`, `normal`, `enhanced`) based on available space and the importance of the alert.\n- The blinking feature should be reserved for urgent or high-priority alerts to avoid unnecessary distraction.\n\n**TODO(designer):** Confirm if there are recommended default behaviors for auto-blinking, and if there are any design constraints for when to use each variant.\n\n**TODO(designer):** The Figma Alert button has no flat Global counter, so below `flatMaxBreakpointPx` the button shows the flat bell without the counts.\n\n## Events\n\n- `click-alert` – Fired when the main alert button is clicked.\n- `click-silence` – Fired when the silence button is clicked.\n\n## Best Practices & Constraints\n\n- Only show the counter when there are active alerts and the button is not in flat mode.\n- The silence button is only visible if enabled, the width is above the minimum breakpoint, and the button is not flat.\n- Blinking should be used sparingly to avoid overwhelming the user.\n- Use the large variant for touch interfaces or when the button needs to stand out.\n\n## Example\n\n```html\n<obc-alert-button\n nAlerts=\"3\"\n alertType=\"alarm\"\n type=\"enhanced\"\n counter\n showSilenceButton\n blinking\n large\n flatMaxBreakpointPx=\"600\"\n silenceButtonMinBreakpointPx=\"600\"\n></obc-alert-button>\n```\n\nIn this example, the button shows an alarm icon, a counter badge with \"3\", is styled as enhanced, blinks to indicate urgency, and includes a silence button if the width allows.",
|
|
55736
|
+
"name": "ObcAlertButton",
|
|
55411
55737
|
"members": [
|
|
55412
55738
|
{
|
|
55413
55739
|
"kind": "field",
|
|
@@ -55416,7 +55742,7 @@
|
|
|
55416
55742
|
"text": "number"
|
|
55417
55743
|
},
|
|
55418
55744
|
"default": "0",
|
|
55419
|
-
"description": "Number of active alerts
|
|
55745
|
+
"description": "Number of active alerts shown in the counter; 0 shows the idle state.",
|
|
55420
55746
|
"attribute": "nAlerts"
|
|
55421
55747
|
},
|
|
55422
55748
|
{
|
|
@@ -55425,13 +55751,13 @@
|
|
|
55425
55751
|
"type": {
|
|
55426
55752
|
"text": "AlertType | undefined"
|
|
55427
55753
|
},
|
|
55428
|
-
"description": "
|
|
55754
|
+
"description": "Alert type that selects the icon and colours: `alarm`, `warning`, `caution`, a `level-*` severity, or unset for the idle state.",
|
|
55429
55755
|
"attribute": "alertType"
|
|
55430
55756
|
},
|
|
55431
55757
|
{
|
|
55432
55758
|
"kind": "field",
|
|
55433
55759
|
"name": "type",
|
|
55434
|
-
"description": "Visual variant
|
|
55760
|
+
"description": "Visual variant: `flat` (icon only), `normal` (default, icon and optional counter) or `enhanced` (emphasized for high-priority alerts).",
|
|
55435
55761
|
"attribute": "type"
|
|
55436
55762
|
},
|
|
55437
55763
|
{
|
|
@@ -55441,7 +55767,7 @@
|
|
|
55441
55767
|
"text": "boolean"
|
|
55442
55768
|
},
|
|
55443
55769
|
"default": "false",
|
|
55444
|
-
"description": "Increases button
|
|
55770
|
+
"description": "Increases the button height and padding for touch-friendly or prominent use.",
|
|
55445
55771
|
"attribute": "large"
|
|
55446
55772
|
},
|
|
55447
55773
|
{
|
|
@@ -55451,7 +55777,7 @@
|
|
|
55451
55777
|
"text": "boolean"
|
|
55452
55778
|
},
|
|
55453
55779
|
"default": "false",
|
|
55454
|
-
"description": "
|
|
55780
|
+
"description": "Shows the silence button when the width is at least `silenceButtonMinBreakpointPx` and the button is not flat.",
|
|
55455
55781
|
"attribute": "showSilenceButton"
|
|
55456
55782
|
},
|
|
55457
55783
|
{
|
|
@@ -55476,42 +55802,71 @@
|
|
|
55476
55802
|
"text": "boolean"
|
|
55477
55803
|
},
|
|
55478
55804
|
"default": "false",
|
|
55479
|
-
"description": "
|
|
55805
|
+
"description": "Shows the alert counter when there are active alerts and the button is not flat.",
|
|
55480
55806
|
"attribute": "counter"
|
|
55481
55807
|
},
|
|
55482
55808
|
{
|
|
55483
55809
|
"kind": "field",
|
|
55484
|
-
"name": "
|
|
55810
|
+
"name": "globalCounter",
|
|
55485
55811
|
"type": {
|
|
55486
55812
|
"text": "boolean"
|
|
55487
55813
|
},
|
|
55488
55814
|
"default": "false",
|
|
55489
|
-
"description": "
|
|
55490
|
-
"attribute": "
|
|
55815
|
+
"description": "Shows the per-severity counts and the shelved count before the bell and the total (the item's global counter); a flat button shows the plain bell.",
|
|
55816
|
+
"attribute": "globalCounter"
|
|
55491
55817
|
},
|
|
55492
55818
|
{
|
|
55493
55819
|
"kind": "field",
|
|
55494
|
-
"name": "
|
|
55820
|
+
"name": "counts",
|
|
55495
55821
|
"type": {
|
|
55496
|
-
"text": "
|
|
55822
|
+
"text": "AlertCounts"
|
|
55497
55823
|
},
|
|
55498
|
-
"
|
|
55499
|
-
"
|
|
55824
|
+
"default": "{}",
|
|
55825
|
+
"description": "Alert count per severity for the global counter badges (`countAlarm`, `countWarning`, `countCaution` and the `level-*` counts).\n\nAvailable when `globalCounter==true`.",
|
|
55826
|
+
"availableWhen": "globalCounter==true",
|
|
55827
|
+
"availableWhenIf": {
|
|
55828
|
+
"arg": "globalCounter",
|
|
55829
|
+
"truthy": true
|
|
55830
|
+
}
|
|
55500
55831
|
},
|
|
55501
55832
|
{
|
|
55502
55833
|
"kind": "field",
|
|
55503
|
-
"name": "
|
|
55504
|
-
"
|
|
55505
|
-
|
|
55506
|
-
|
|
55834
|
+
"name": "shelvedCount",
|
|
55835
|
+
"type": {
|
|
55836
|
+
"text": "number"
|
|
55837
|
+
},
|
|
55838
|
+
"default": "0",
|
|
55839
|
+
"description": "Number of shelved alerts, shown after the global counter badges; hidden at zero.\n\nAvailable when `globalCounter==true`.",
|
|
55840
|
+
"attribute": "shelvedCount",
|
|
55841
|
+
"availableWhen": "globalCounter==true",
|
|
55842
|
+
"availableWhenIf": {
|
|
55843
|
+
"arg": "globalCounter",
|
|
55844
|
+
"truthy": true
|
|
55845
|
+
}
|
|
55507
55846
|
},
|
|
55508
55847
|
{
|
|
55509
55848
|
"kind": "field",
|
|
55510
|
-
"name": "
|
|
55849
|
+
"name": "blinking",
|
|
55511
55850
|
"type": {
|
|
55512
|
-
"text": "
|
|
55851
|
+
"text": "boolean"
|
|
55513
55852
|
},
|
|
55514
|
-
"
|
|
55853
|
+
"default": "false",
|
|
55854
|
+
"description": "Flashes the bell for active alerts of a flashing alert type (never for caution).",
|
|
55855
|
+
"attribute": "blinking"
|
|
55856
|
+
},
|
|
55857
|
+
{
|
|
55858
|
+
"kind": "field",
|
|
55859
|
+
"name": "flashingSpeed",
|
|
55860
|
+
"type": {
|
|
55861
|
+
"text": "FlashingSpeed"
|
|
55862
|
+
},
|
|
55863
|
+
"description": "Flash tempo while `blinking` is on: `default` resolves from `alertType`, `fast`, `slow`, `very-slow` force a tempo, `fixed` never flashes.\n\nAvailable when `blinking==true`.",
|
|
55864
|
+
"attribute": "flashingSpeed",
|
|
55865
|
+
"availableWhen": "blinking==true",
|
|
55866
|
+
"availableWhenIf": {
|
|
55867
|
+
"arg": "blinking",
|
|
55868
|
+
"truthy": true
|
|
55869
|
+
}
|
|
55515
55870
|
},
|
|
55516
55871
|
{
|
|
55517
55872
|
"kind": "field",
|
|
@@ -55520,7 +55875,7 @@
|
|
|
55520
55875
|
"text": "number"
|
|
55521
55876
|
},
|
|
55522
55877
|
"default": "0",
|
|
55523
|
-
"description": "
|
|
55878
|
+
"description": "Window width in px below which a `normal` or `enhanced` button switches to flat mode.\n\nAvailable when `type!=flat`.",
|
|
55524
55879
|
"attribute": "flatMaxBreakpointPx",
|
|
55525
55880
|
"availableWhen": "type!=flat",
|
|
55526
55881
|
"availableWhenIf": {
|
|
@@ -55535,7 +55890,7 @@
|
|
|
55535
55890
|
"text": "number"
|
|
55536
55891
|
},
|
|
55537
55892
|
"default": "0",
|
|
55538
|
-
"description": "Minimum width
|
|
55893
|
+
"description": "Minimum window width in px for showing the silence button.\n\nAvailable when `showSilenceButton==true`.",
|
|
55539
55894
|
"attribute": "silenceButtonMinBreakpointPx",
|
|
55540
55895
|
"availableWhen": "showSilenceButton==true",
|
|
55541
55896
|
"availableWhenIf": {
|
|
@@ -55553,21 +55908,6 @@
|
|
|
55553
55908
|
"name": "resizeListener",
|
|
55554
55909
|
"privacy": "private"
|
|
55555
55910
|
},
|
|
55556
|
-
{
|
|
55557
|
-
"kind": "method",
|
|
55558
|
-
"name": "renderAlertTwotoneIcon",
|
|
55559
|
-
"privacy": "private"
|
|
55560
|
-
},
|
|
55561
|
-
{
|
|
55562
|
-
"kind": "method",
|
|
55563
|
-
"name": "alertIcon",
|
|
55564
|
-
"privacy": "private"
|
|
55565
|
-
},
|
|
55566
|
-
{
|
|
55567
|
-
"kind": "method",
|
|
55568
|
-
"name": "alertIconNegative",
|
|
55569
|
-
"privacy": "private"
|
|
55570
|
-
},
|
|
55571
55911
|
{
|
|
55572
55912
|
"kind": "field",
|
|
55573
55913
|
"name": "activeType",
|
|
@@ -55610,7 +55950,7 @@
|
|
|
55610
55950
|
"text": "number"
|
|
55611
55951
|
},
|
|
55612
55952
|
"default": "0",
|
|
55613
|
-
"description": "Number of active alerts
|
|
55953
|
+
"description": "Number of active alerts shown in the counter; 0 shows the idle state.",
|
|
55614
55954
|
"fieldName": "nAlerts"
|
|
55615
55955
|
},
|
|
55616
55956
|
{
|
|
@@ -55618,12 +55958,12 @@
|
|
|
55618
55958
|
"type": {
|
|
55619
55959
|
"text": "AlertType | undefined"
|
|
55620
55960
|
},
|
|
55621
|
-
"description": "
|
|
55961
|
+
"description": "Alert type that selects the icon and colours: `alarm`, `warning`, `caution`, a `level-*` severity, or unset for the idle state.",
|
|
55622
55962
|
"fieldName": "alertType"
|
|
55623
55963
|
},
|
|
55624
55964
|
{
|
|
55625
55965
|
"name": "type",
|
|
55626
|
-
"description": "Visual variant
|
|
55966
|
+
"description": "Visual variant: `flat` (icon only), `normal` (default, icon and optional counter) or `enhanced` (emphasized for high-priority alerts).",
|
|
55627
55967
|
"fieldName": "type"
|
|
55628
55968
|
},
|
|
55629
55969
|
{
|
|
@@ -55632,7 +55972,7 @@
|
|
|
55632
55972
|
"text": "boolean"
|
|
55633
55973
|
},
|
|
55634
55974
|
"default": "false",
|
|
55635
|
-
"description": "Increases button
|
|
55975
|
+
"description": "Increases the button height and padding for touch-friendly or prominent use.",
|
|
55636
55976
|
"fieldName": "large"
|
|
55637
55977
|
},
|
|
55638
55978
|
{
|
|
@@ -55641,7 +55981,7 @@
|
|
|
55641
55981
|
"text": "boolean"
|
|
55642
55982
|
},
|
|
55643
55983
|
"default": "false",
|
|
55644
|
-
"description": "
|
|
55984
|
+
"description": "Shows the silence button when the width is at least `silenceButtonMinBreakpointPx` and the button is not flat.",
|
|
55645
55985
|
"fieldName": "showSilenceButton"
|
|
55646
55986
|
},
|
|
55647
55987
|
{
|
|
@@ -55659,16 +55999,34 @@
|
|
|
55659
55999
|
"text": "boolean"
|
|
55660
56000
|
},
|
|
55661
56001
|
"default": "false",
|
|
55662
|
-
"description": "
|
|
56002
|
+
"description": "Shows the alert counter when there are active alerts and the button is not flat.",
|
|
55663
56003
|
"fieldName": "counter"
|
|
55664
56004
|
},
|
|
56005
|
+
{
|
|
56006
|
+
"name": "globalCounter",
|
|
56007
|
+
"type": {
|
|
56008
|
+
"text": "boolean"
|
|
56009
|
+
},
|
|
56010
|
+
"default": "false",
|
|
56011
|
+
"description": "Shows the per-severity counts and the shelved count before the bell and the total (the item's global counter); a flat button shows the plain bell.",
|
|
56012
|
+
"fieldName": "globalCounter"
|
|
56013
|
+
},
|
|
56014
|
+
{
|
|
56015
|
+
"name": "shelvedCount",
|
|
56016
|
+
"type": {
|
|
56017
|
+
"text": "number"
|
|
56018
|
+
},
|
|
56019
|
+
"default": "0",
|
|
56020
|
+
"description": "Number of shelved alerts, shown after the global counter badges; hidden at zero.\n\nAvailable when `globalCounter==true`.",
|
|
56021
|
+
"fieldName": "shelvedCount"
|
|
56022
|
+
},
|
|
55665
56023
|
{
|
|
55666
56024
|
"name": "blinking",
|
|
55667
56025
|
"type": {
|
|
55668
56026
|
"text": "boolean"
|
|
55669
56027
|
},
|
|
55670
56028
|
"default": "false",
|
|
55671
|
-
"description": "
|
|
56029
|
+
"description": "Flashes the bell for active alerts of a flashing alert type (never for caution).",
|
|
55672
56030
|
"fieldName": "blinking"
|
|
55673
56031
|
},
|
|
55674
56032
|
{
|
|
@@ -55676,7 +56034,7 @@
|
|
|
55676
56034
|
"type": {
|
|
55677
56035
|
"text": "FlashingSpeed"
|
|
55678
56036
|
},
|
|
55679
|
-
"description": "Flash tempo while `blinking` is on: `default` resolves from `alertType`, `fast`, `slow`, `very-slow` force a tempo, `fixed` never flashes
|
|
56037
|
+
"description": "Flash tempo while `blinking` is on: `default` resolves from `alertType`, `fast`, `slow`, `very-slow` force a tempo, `fixed` never flashes.\n\nAvailable when `blinking==true`.",
|
|
55680
56038
|
"fieldName": "flashingSpeed"
|
|
55681
56039
|
},
|
|
55682
56040
|
{
|
|
@@ -55685,7 +56043,7 @@
|
|
|
55685
56043
|
"text": "number"
|
|
55686
56044
|
},
|
|
55687
56045
|
"default": "0",
|
|
55688
|
-
"description": "
|
|
56046
|
+
"description": "Window width in px below which a `normal` or `enhanced` button switches to flat mode.\n\nAvailable when `type!=flat`.",
|
|
55689
56047
|
"fieldName": "flatMaxBreakpointPx"
|
|
55690
56048
|
},
|
|
55691
56049
|
{
|
|
@@ -55694,7 +56052,7 @@
|
|
|
55694
56052
|
"text": "number"
|
|
55695
56053
|
},
|
|
55696
56054
|
"default": "0",
|
|
55697
|
-
"description": "Minimum width
|
|
56055
|
+
"description": "Minimum window width in px for showing the silence button.\n\nAvailable when `showSilenceButton==true`.",
|
|
55698
56056
|
"fieldName": "silenceButtonMinBreakpointPx"
|
|
55699
56057
|
}
|
|
55700
56058
|
],
|
|
@@ -55707,6 +56065,14 @@
|
|
|
55707
56065
|
}
|
|
55708
56066
|
],
|
|
55709
56067
|
"exports": [
|
|
56068
|
+
{
|
|
56069
|
+
"kind": "js",
|
|
56070
|
+
"name": "ObcAlertButtonType",
|
|
56071
|
+
"declaration": {
|
|
56072
|
+
"name": "ObcAlertButtonType",
|
|
56073
|
+
"module": "src/components/alert-button/alert-button.ts"
|
|
56074
|
+
}
|
|
56075
|
+
},
|
|
55710
56076
|
{
|
|
55711
56077
|
"kind": "js",
|
|
55712
56078
|
"name": "ObcAlertButton",
|
|
@@ -55725,6 +56091,90 @@
|
|
|
55725
56091
|
}
|
|
55726
56092
|
]
|
|
55727
56093
|
},
|
|
56094
|
+
{
|
|
56095
|
+
"kind": "javascript-module",
|
|
56096
|
+
"path": "src/components/alert-counter-item/alert-counter-item.ts",
|
|
56097
|
+
"declarations": [
|
|
56098
|
+
{
|
|
56099
|
+
"kind": "class",
|
|
56100
|
+
"description": "`<obc-alert-counter-item>` – A row of alert counts, one badge per severity.\n\nRenders a large `obc-badge` for every severity with a count above zero, most\nsevere first, followed by an optional shelved count. Nothing renders when\nnothing is counted.\n\n---\n\n### Features\n- **Two types:** `badges` draws filled badges in the severity colour;\n `alert-level` draws flat badges with the severity glyph.\n- **Every severity:** `counts` takes the whole `AlertType` vocabulary,\n including the `level-*` family, ordered by `ALERT_SEVERITY_PRIORITY`.\n- **Shelved count:** `shelvedCount` adds a neutral badge at the end, with\n the shelf icon in `alert-level`.\n- **Accessible summary:** the row is announced as one image labelled with\n the counts, e.g. \"2 Alarm, 4 Warning, 6 Caution\".\n\n---\n\n### Usage Guidelines\n- Show how many alerts are outstanding per severity in a compact space;\n `obc-alert-button-item` nests the counter for its global counter.\n- Pass the counts as one object: `.counts=${{countAlarm: 2, countWarning: 4}}`.\n- The counter is display-only: it renders no button and fires no events.\n- For a framed per-subsystem summary with a label, see\n `obc-alert-subsystem-counter`.\n- **TODO(designer):** the Figma component also has an Unacked counter type;\n how its icons map to counts is not defined yet.\n\n---\n\n### Example\n\n```html\n<obc-alert-counter-item\n .counts=${{countAlarm: 2, countWarning: 4, countCaution: 6}}\n shelvedCount=\"9\"\n></obc-alert-counter-item>\n```",
|
|
56101
|
+
"name": "ObcAlertCounterItem",
|
|
56102
|
+
"members": [
|
|
56103
|
+
{
|
|
56104
|
+
"kind": "field",
|
|
56105
|
+
"name": "type",
|
|
56106
|
+
"type": {
|
|
56107
|
+
"text": "ObcAlertCounterItemType"
|
|
56108
|
+
},
|
|
56109
|
+
"description": "How each count is drawn: `badges` (filled severity badges, default) or `alert-level` (flat badges with the severity glyph).",
|
|
56110
|
+
"attribute": "type"
|
|
56111
|
+
},
|
|
56112
|
+
{
|
|
56113
|
+
"kind": "field",
|
|
56114
|
+
"name": "counts",
|
|
56115
|
+
"type": {
|
|
56116
|
+
"text": "AlertCounts"
|
|
56117
|
+
},
|
|
56118
|
+
"default": "{}",
|
|
56119
|
+
"description": "Alert count per severity (`countAlarm`, `countWarning`, `countCaution` and the `level-*` counts); counts of zero or less are not shown."
|
|
56120
|
+
},
|
|
56121
|
+
{
|
|
56122
|
+
"kind": "field",
|
|
56123
|
+
"name": "shelvedCount",
|
|
56124
|
+
"type": {
|
|
56125
|
+
"text": "number"
|
|
56126
|
+
},
|
|
56127
|
+
"default": "0",
|
|
56128
|
+
"description": "Number of shelved alerts, shown as a neutral badge after the severities; hidden at zero.",
|
|
56129
|
+
"attribute": "shelvedCount"
|
|
56130
|
+
}
|
|
56131
|
+
],
|
|
56132
|
+
"attributes": [
|
|
56133
|
+
{
|
|
56134
|
+
"name": "type",
|
|
56135
|
+
"type": {
|
|
56136
|
+
"text": "ObcAlertCounterItemType"
|
|
56137
|
+
},
|
|
56138
|
+
"description": "How each count is drawn: `badges` (filled severity badges, default) or `alert-level` (flat badges with the severity glyph).",
|
|
56139
|
+
"fieldName": "type"
|
|
56140
|
+
},
|
|
56141
|
+
{
|
|
56142
|
+
"name": "shelvedCount",
|
|
56143
|
+
"type": {
|
|
56144
|
+
"text": "number"
|
|
56145
|
+
},
|
|
56146
|
+
"default": "0",
|
|
56147
|
+
"description": "Number of shelved alerts, shown as a neutral badge after the severities; hidden at zero.",
|
|
56148
|
+
"fieldName": "shelvedCount"
|
|
56149
|
+
}
|
|
56150
|
+
],
|
|
56151
|
+
"superclass": {
|
|
56152
|
+
"name": "LitElement",
|
|
56153
|
+
"package": "lit"
|
|
56154
|
+
},
|
|
56155
|
+
"tagName": "obc-alert-counter-item",
|
|
56156
|
+
"customElement": true
|
|
56157
|
+
}
|
|
56158
|
+
],
|
|
56159
|
+
"exports": [
|
|
56160
|
+
{
|
|
56161
|
+
"kind": "js",
|
|
56162
|
+
"name": "ObcAlertCounterItem",
|
|
56163
|
+
"declaration": {
|
|
56164
|
+
"name": "ObcAlertCounterItem",
|
|
56165
|
+
"module": "src/components/alert-counter-item/alert-counter-item.ts"
|
|
56166
|
+
}
|
|
56167
|
+
},
|
|
56168
|
+
{
|
|
56169
|
+
"kind": "custom-element-definition",
|
|
56170
|
+
"name": "obc-alert-counter-item",
|
|
56171
|
+
"declaration": {
|
|
56172
|
+
"name": "ObcAlertCounterItem",
|
|
56173
|
+
"module": "src/components/alert-counter-item/alert-counter-item.ts"
|
|
56174
|
+
}
|
|
56175
|
+
}
|
|
56176
|
+
]
|
|
56177
|
+
},
|
|
55728
56178
|
{
|
|
55729
56179
|
"kind": "javascript-module",
|
|
55730
56180
|
"path": "src/components/alert-floating-item/alert-floating-item.ts",
|
|
@@ -55918,7 +56368,7 @@
|
|
|
55918
56368
|
"declarations": [
|
|
55919
56369
|
{
|
|
55920
56370
|
"kind": "class",
|
|
55921
|
-
"description": "`<obc-alert-frame>` – A bordered frame component for visually emphasizing alert or status messages.\n\nThe alert frame provides a prominent outline and optional \"flap\" with status icon to draw attention to critical information or UI regions. It supports multiple visual variants and thicknesses, and can be configured to indicate different alert statuses (alarm, warning, caution). The component is designed to wrap content and visually distinguish it from the surrounding UI.\n\n### Features\n- **Variants (type):**\n - `regular`: Standard outlined frame with no flap or icon.\n - `small-side-flip`: Adds a small side flap with a status icon at the top right.\n - `large-side-flip`: Adds a larger, vertical side flap with a status icon and optional custom icon.\n - `bottom-flip`: Adds a bottom flap with a status icon, label, and timer slots.\n- **Thickness options:** Choose between `small` (thin border) and `large` (thick border) for visual emphasis.\n- **Status indication:** Displays different color schemes and icons for the legacy statuses (`alarm`, `warning`, `caution`) and the level statuses (`level-critical`, `level-high`, `level-medium`, `level-low`, `level-diagnostic`).\n- **Acknowledgement mode:** The `mode` property reflects the alert lifecycle state — `acked-active` (default, steady), `unacked-active` (flashes) and `unacked-rectified` (dashed, flashes) — and `flashingSpeed` picks the tempo.\n- **Content wrapping:** When `wrapContent` is true, the frame wraps and sizes itself to its slotted content rather than overlaying a fixed region.\n- **Customizable corners:** Each corner can be set to a sharp (non-rounded) edge for integration with other UI elements.\n- **Slot-based content:** Supports custom icons, labels, and timers in flap variants via named slots.\n\n### Usage Guidelines\nUse `obc-alert-frame` to highlight important content, such as alerts, warnings, or status panels. The flap variants are ideal for drawing extra attention to urgent or time-sensitive information, while the regular type provides a subtle but clear border. Choose the status to match the severity of the message (alarm, warning, caution). Adjust thickness for visual hierarchy—use large for high-priority alerts and small for less critical notices.\n\n**TODO(designer):** Provide guidance on when to use each flap type (small-side-flip, large-side-flip, bottom-flip) and recommended scenarios for sharp edge usage.\n\n### Features/Variants\n- **Type (Visual Variant):**\n - `regular`: Simple outlined frame, no flap or icon.\n - `small-side-flip`: Small right-side flap with status icon.\n - `large-side-flip`: Large vertical right-side flap with status icon and optional custom icon.\n - `bottom-flip`: Bottom flap with status icon, label, and timer.\n- **Thickness:** `small` (default) or `large` for border width.\n- **Status:** `alarm`, `warning`, `caution`, or the level severities (`level-critical`, `level-high`, `level-medium`, `level-low`, `level-diagnostic`)—affects color and icon.\n- **Mode:** `acked-active` (default), `unacked-active`, or `unacked-rectified`—affects blinking/animation.\n- **Corner Customization:** Each corner can be made sharp (not rounded) via boolean properties.\n\n### Slots and Content Structure\n\n| Slot Name | Renders When... | Purpose |\n|-----------|-----------------|---------|\n| (default) | Always | Main content inside the alert frame. |\n| icon | `large-side-flip` or `bottom-flip` | Custom icon displayed in the flap (in addition to status icon). |\n| label | `bottom-flip` only | Label text shown in the bottom flap. |\n| timer | `bottom-flip` only | Timer or time label in the bottom flap. |\n\n### Properties and Attributes\n- `type`: Selects the visual variant/flap style. Default is `small-side-flip`.\n- `thickness`: Controls border thickness (`small` or `large`). Default is `small`.\n- `status`: Sets the alert status and color/icon (`alarm`, `warning`, `caution`, or the `level-*` severities). Default is `alarm`.\n- `mode`: Acknowledgement lifecycle state (`acked-active`, `unacked-active`, `unacked-rectified`) controlling blinking/animation. Default is `acked-active`.\n- `wrapContent`: When true, the frame wraps and sizes to its slotted content instead of overlaying a fixed region. Default is `false`.\n- `sharpEdgeTopLeft`, `sharpEdgeTopRight`, `sharpEdgeBottomLeft`, `sharpEdgeBottomRight`: Boolean flags to make each corner sharp instead of rounded.\n\n### Best Practices and Constraints\n- Use the status property to match the severity of the alert.\n- Only use the bottom-flip variant when both label and timer are relevant.\n- For visual consistency, align sharp edge settings with adjacent UI elements.\n- The default slot is for the main content; use named slots for icons, labels, and timers as needed.\n\n### Example:\n```\n<obc-alert-frame\n type=\"bottom-flip\"\n thickness=\"large\"\n status=\"warning\"\n sharpEdgeTopLeft\n>\n <obi-placeholder slot=\"icon\"></obi-placeholder>\n <div slot=\"label\">Low Battery</div>\n <div slot=\"timer\">00:15</div>\n <div>Critical system message goes here.</div>\n</obc-alert-frame>\n```",
|
|
56371
|
+
"description": "`<obc-alert-frame>` – A bordered frame component for visually emphasizing alert or status messages.\n\nThe alert frame provides a prominent outline and optional \"flap\" with status icon to draw attention to critical information or UI regions. It supports multiple visual variants and thicknesses, and can be configured to indicate different alert statuses (alarm, warning, caution). The component is designed to wrap content and visually distinguish it from the surrounding UI.\n\n### Features\n- **Variants (type):**\n - `regular`: Standard outlined frame with no flap or icon.\n - `small-side-flip`: Adds a small side flap with a status icon at the top right.\n - `large-side-flip`: Adds a larger, vertical side flap with a status icon and optional custom icon.\n - `bottom-flip`: Adds a bottom flap with a status icon, label, and timer slots.\n- **Thickness options:** Choose between `small` (thin border) and `large` (thick border) for visual emphasis.\n- **Centred stroke:** The stroke straddles the frame edge, half over the content and half outside, so frames on touching components share one edge. While flashing it grows by 1 px on each side.\n- **Status indication:** Displays different color schemes and icons for the legacy statuses (`alarm`, `warning`, `caution`) and the level statuses (`level-critical`, `level-high`, `level-medium`, `level-low`, `level-diagnostic`).\n- **Acknowledgement mode:** The `mode` property reflects the alert lifecycle state — `acked-active` (default, steady), `unacked-active` (flashes) and `unacked-rectified` (dashed, flashes) — and `flashingSpeed` picks the tempo.\n- **Content wrapping:** When `wrapContent` is true, the frame wraps and sizes itself to its slotted content rather than overlaying a fixed region.\n- **Customizable corners:** Each corner can be set to a sharp (non-rounded) edge for integration with other UI elements.\n- **Slot-based content:** Supports custom icons, labels, and timers in flap variants via named slots.\n\n### Usage Guidelines\nUse `obc-alert-frame` to highlight important content, such as alerts, warnings, or status panels. The flap variants are ideal for drawing extra attention to urgent or time-sensitive information, while the regular type provides a subtle but clear border. Choose the status to match the severity of the message (alarm, warning, caution). Adjust thickness for visual hierarchy—use large for high-priority alerts and small for less critical notices.\n\n**TODO(designer):** Provide guidance on when to use each flap type (small-side-flip, large-side-flip, bottom-flip) and recommended scenarios for sharp edge usage.\n\n### Features/Variants\n- **Type (Visual Variant):**\n - `regular`: Simple outlined frame, no flap or icon.\n - `small-side-flip`: Small right-side flap with status icon.\n - `large-side-flip`: Large vertical right-side flap with status icon and optional custom icon.\n - `bottom-flip`: Bottom flap with status icon, label, and timer.\n- **Thickness:** `small` (default) or `large` for border width.\n- **Status:** `alarm`, `warning`, `caution`, or the level severities (`level-critical`, `level-high`, `level-medium`, `level-low`, `level-diagnostic`)—affects color and icon.\n- **Mode:** `acked-active` (default), `unacked-active`, or `unacked-rectified`—affects blinking/animation.\n- **Corner Customization:** Each corner can be made sharp (not rounded) via boolean properties.\n\n### Slots and Content Structure\n\n| Slot Name | Renders When... | Purpose |\n|-----------|-----------------|---------|\n| (default) | Always | Main content inside the alert frame. |\n| icon | `large-side-flip` or `bottom-flip` | Custom icon displayed in the flap (in addition to status icon). |\n| label | `bottom-flip` only | Label text shown in the bottom flap. |\n| timer | `bottom-flip` only | Timer or time label in the bottom flap. |\n\n### Properties and Attributes\n- `type`: Selects the visual variant/flap style. Default is `small-side-flip`.\n- `thickness`: Controls border thickness (`small` or `large`). Default is `small`.\n- `status`: Sets the alert status and color/icon (`alarm`, `warning`, `caution`, or the `level-*` severities). Default is `alarm`.\n- `mode`: Acknowledgement lifecycle state (`acked-active`, `unacked-active`, `unacked-rectified`) controlling blinking/animation. Default is `acked-active`.\n- `wrapContent`: When true, the frame wraps and sizes to its slotted content instead of overlaying a fixed region. Default is `false`.\n- `sharpEdgeTopLeft`, `sharpEdgeTopRight`, `sharpEdgeBottomLeft`, `sharpEdgeBottomRight`: Boolean flags to make each corner sharp instead of rounded.\n\n### Best Practices and Constraints\n- Use the status property to match the severity of the alert.\n- Only use the bottom-flip variant when both label and timer are relevant.\n- For visual consistency, align sharp edge settings with adjacent UI elements.\n- The default slot is for the main content; use named slots for icons, labels, and timers as needed.\n\n### Example:\n```\n<obc-alert-frame\n type=\"bottom-flip\"\n thickness=\"large\"\n status=\"warning\"\n sharpEdgeTopLeft\n>\n <obi-placeholder slot=\"icon\"></obi-placeholder>\n <div slot=\"label\">Low Battery</div>\n <div slot=\"timer\">00:15</div>\n <div>Critical system message goes here.</div>\n</obc-alert-frame>\n```",
|
|
55922
56372
|
"name": "ObcAlertFrame",
|
|
55923
56373
|
"slots": [
|
|
55924
56374
|
{
|
|
@@ -55990,7 +56440,7 @@
|
|
|
55990
56440
|
"type": {
|
|
55991
56441
|
"text": "ObcAlertFrameFlashEffect"
|
|
55992
56442
|
},
|
|
55993
|
-
"description": "`outline` (default) grows the outline by 2 px while on in one step; `outline-eased` grows it over a 50 ms transition, a design-evaluation option.",
|
|
56443
|
+
"description": "`outline` (default) grows the outline by 2 px, 1 px each side, while on in one step; `outline-eased` grows it over a 50 ms transition, a design-evaluation option.",
|
|
55994
56444
|
"attribute": "flashEffect"
|
|
55995
56445
|
},
|
|
55996
56446
|
{
|
|
@@ -56196,7 +56646,7 @@
|
|
|
56196
56646
|
"type": {
|
|
56197
56647
|
"text": "ObcAlertFrameFlashEffect"
|
|
56198
56648
|
},
|
|
56199
|
-
"description": "`outline` (default) grows the outline by 2 px while on in one step; `outline-eased` grows it over a 50 ms transition, a design-evaluation option.",
|
|
56649
|
+
"description": "`outline` (default) grows the outline by 2 px, 1 px each side, while on in one step; `outline-eased` grows it over a 50 ms transition, a design-evaluation option.",
|
|
56200
56650
|
"fieldName": "flashEffect"
|
|
56201
56651
|
},
|
|
56202
56652
|
{
|
|
@@ -86111,7 +86561,7 @@
|
|
|
86111
86561
|
"type": {
|
|
86112
86562
|
"text": "TreeNavigationItemAlerts | undefined"
|
|
86113
86563
|
},
|
|
86114
|
-
"description": "Per-severity alert counts for the row's trailing badge(s). Omit (or leave\nevery count at 0) for a row with no alerts. See TreeNavigationItemAlerts.\n\n- When `combine` is true, a single badge is shown: its number is the sum\n of all counts and its severity is the highest category present\n
|
|
86564
|
+
"description": "Per-severity alert counts for the row's trailing badge(s). Omit (or leave\nevery count at 0) for a row with no alerts. See TreeNavigationItemAlerts.\n\n- When `combine` is true, a single badge is shown: its number is the sum\n of all counts and its severity is the highest category present, ranked\n by `ALERT_SEVERITY_PRIORITY`.\n- Otherwise one badge is shown per count greater than 0, ordered most to\n least severe and spaced by the alert-counter spacing token.",
|
|
86115
86565
|
"attribute": "alerts"
|
|
86116
86566
|
},
|
|
86117
86567
|
{
|
|
@@ -86155,10 +86605,10 @@
|
|
|
86155
86605
|
"kind": "field",
|
|
86156
86606
|
"name": "alertBadges",
|
|
86157
86607
|
"type": {
|
|
86158
|
-
"text": "
|
|
86608
|
+
"text": "RankedAlertCount[]"
|
|
86159
86609
|
},
|
|
86160
86610
|
"privacy": "private",
|
|
86161
|
-
"description": "The badge(s) to render from `alerts`,
|
|
86611
|
+
"description": "The badge(s) to render from `alerts`, ranked by `rankAlertCounts`.",
|
|
86162
86612
|
"readonly": true
|
|
86163
86613
|
},
|
|
86164
86614
|
{
|
|
@@ -86302,7 +86752,7 @@
|
|
|
86302
86752
|
"type": {
|
|
86303
86753
|
"text": "TreeNavigationItemAlerts | undefined"
|
|
86304
86754
|
},
|
|
86305
|
-
"description": "Per-severity alert counts for the row's trailing badge(s). Omit (or leave\nevery count at 0) for a row with no alerts. See TreeNavigationItemAlerts.\n\n- When `combine` is true, a single badge is shown: its number is the sum\n of all counts and its severity is the highest category present\n
|
|
86755
|
+
"description": "Per-severity alert counts for the row's trailing badge(s). Omit (or leave\nevery count at 0) for a row with no alerts. See TreeNavigationItemAlerts.\n\n- When `combine` is true, a single badge is shown: its number is the sum\n of all counts and its severity is the highest category present, ranked\n by `ALERT_SEVERITY_PRIORITY`.\n- Otherwise one badge is shown per count greater than 0, ordered most to\n least severe and spaced by the alert-counter spacing token.",
|
|
86306
86756
|
"fieldName": "alerts"
|
|
86307
86757
|
},
|
|
86308
86758
|
{
|