@kubex/zinc 1.1.18 → 1.1.19

package/docs/pages/components/status-indicator.md

@@ -24,13 +24,41 @@ A basic status indicator displays as a small circular dot with the default info
 
 ### Types
 
-Use the `type` attribute to set the semantic meaning and color of the status indicator. Available types are: `info` (default), `success`, `warning`, and `error`.
+Use the `type` attribute to set the semantic meaning and color of the status indicator. Available types are: `info` (default), `success`, `warning`, `error`, and `disabled`.
 
 ```html:preview
 <zn-status-indicator type="info"></zn-status-indicator>
 <zn-status-indicator type="success"></zn-status-indicator>
 <zn-status-indicator type="warning"></zn-status-indicator>
 <zn-status-indicator type="error"></zn-status-indicator>
+<zn-status-indicator type="disabled"></zn-status-indicator>
+```
+
+### Glow
+
+Add the `glow` attribute to animate a throbbing glow effect around the indicator, useful for drawing attention to a live or active status.
+
+```html:preview
+<zn-status-indicator type="info" glow></zn-status-indicator>
+<zn-status-indicator type="success" glow></zn-status-indicator>
+<zn-status-indicator type="warning" glow></zn-status-indicator>
+<zn-status-indicator type="error" glow></zn-status-indicator>
+```
+
+### Alternating Status
+
+Use the `alt-type` attribute to animate the indicator between two statuses. This is useful for representing a status that is transitioning or flapping between two states, e.g. a service moving between `warning` and offline (`disabled`).
+
+```html:preview
+<zn-status-indicator type="warning" alt-type="disabled"></zn-status-indicator>
+<zn-status-indicator type="success" alt-type="warning"></zn-status-indicator>
+<zn-status-indicator type="error" alt-type="info"></zn-status-indicator>
+```
+
+The `alt-type` attribute accepts the same values as `type`: `info`, `success`, `warning`, `error`, and `disabled`. Combine it with `glow` for a pulsing, colour-switching effect.
+
+```html:preview
+<zn-status-indicator type="warning" alt-type="disabled" glow></zn-status-indicator>
 ```
 
 ### With Labels

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubex/zinc",
-  "version": "1.1.18",
+  "version": "1.1.19",
   "description": "A collection of web components for building web applications based off of @shoelace-style/Shoelace",
   "keywords": [
     "web components",

package/src/components/status-indicator/status-indicator.component.ts

@@ -14,7 +14,17 @@ import styles from './status-indicator.scss';
 export default class ZnStatusIndicator extends ZincElement {
   static styles: CSSResultGroup = unsafeCSS(styles);
 
-  @property() type: 'success' | 'error' | 'warning' | 'info' = 'info';
+  @property() type: 'success' | 'error' | 'warning' | 'info' | 'disabled' = 'info';
+
+  /**
+   * A secondary status type. When set, the indicator animates between `type`
+   * and this colour to represent a status transitioning between two states
+   * (e.g. `warning` and `disabled`).
+   */
+  @property({attribute: 'alt-type'}) altType?: 'success' | 'error' | 'warning' | 'info' | 'disabled';
+
+  /** Animates a throbbing glow effect around the indicator. */
+  @property({type: Boolean, reflect: true}) glow = false;
 
   render() {
     return html`
@@ -24,6 +34,14 @@ export default class ZnStatusIndicator extends ZincElement {
         'indicator--error': this.type === 'error',
         'indicator--success': this.type === 'success',
         'indicator--info': this.type === 'info',
+        'indicator--disabled': this.type === 'disabled',
+        'indicator--alt-warning': this.altType === 'warning',
+        'indicator--alt-error': this.altType === 'error',
+        'indicator--alt-success': this.altType === 'success',
+        'indicator--alt-info': this.altType === 'info',
+        'indicator--alt-disabled': this.altType === 'disabled',
+        'indicator--alternate': !!this.altType,
+        'indicator--glow': this.glow,
       })}>
       </div>
     `;

package/src/components/status-indicator/status-indicator.scss

@@ -8,6 +8,7 @@
   --zn-indicator-disabled: 220, 220, 220;
 
   --indicator-color: var(--zn-indicator-disabled);
+  --indicator-alt-color: var(--zn-indicator-disabled);
   white-space: nowrap;
   display: inline-block;
 }
@@ -35,4 +36,103 @@
   &--success {
     --indicator-color: var(--zn-indicator-success);
   }
+
+  &--disabled {
+    --indicator-color: var(--zn-indicator-disabled);
+  }
+
+  // Alternate (secondary) colour, used by the alternating animation.
+  &--alt-info {
+    --indicator-alt-color: var(--zn-indicator-info);
+  }
+
+  &--alt-error {
+    --indicator-alt-color: var(--zn-indicator-error);
+  }
+
+  &--alt-warning {
+    --indicator-alt-color: var(--zn-indicator-warning);
+  }
+
+  &--alt-success {
+    --indicator-alt-color: var(--zn-indicator-success);
+  }
+
+  &--alt-disabled {
+    --indicator-alt-color: var(--zn-indicator-disabled);
+  }
+
+  &--glow {
+    animation: indicator-glow 2s ease-in-out infinite;
+  }
+
+  // Animates between the primary colour and the alternate colour to
+  // represent a status transitioning between two states.
+  &--alternate {
+    animation: indicator-alternate 2s ease-in-out infinite;
+  }
+
+  // When both glow and alternate are set, a single animation switches
+  // colour while pulsing the glow.
+  &--alternate#{&}--glow {
+    animation: indicator-alternate-glow 2s ease-in-out infinite;
+  }
+}
+
+@keyframes indicator-glow {
+  0%,
+  100% {
+    background-color: rgba(var(--indicator-color), 0.5);
+    box-shadow: 0 0 1px 0 rgba(var(--indicator-color), 0.1);
+  }
+
+  50% {
+    background-color: rgba(var(--indicator-color), 0.8);
+    box-shadow: 0 0 3px 1px rgba(var(--indicator-color), 0.5);
+  }
+}
+
+@keyframes indicator-alternate {
+  0%,
+  100% {
+    background-color: rgba(var(--indicator-color), 0.7);
+    border-color: rgb(var(--indicator-color));
+  }
+
+  50% {
+    background-color: rgba(var(--indicator-alt-color), 0.7);
+    border-color: rgb(var(--indicator-alt-color));
+  }
+}
+
+@keyframes indicator-alternate-glow {
+  0%,
+  100% {
+    background-color: rgba(var(--indicator-color), 0.5);
+    border-color: rgb(var(--indicator-color));
+    box-shadow: 0 0 1px 0 rgba(var(--indicator-color), 0.1);
+  }
+
+  50% {
+    background-color: rgba(var(--indicator-alt-color), 0.8);
+    border-color: rgb(var(--indicator-alt-color));
+    box-shadow: 0 0 3px 1px rgba(var(--indicator-alt-color), 0.5);
+  }
+}
+
+@media (prefers-reduced-motion: reduce) {
+  .indicator--glow {
+    animation: none;
+    box-shadow: 0 0 4px 1px rgba(var(--indicator-color), 0.6);
+  }
+
+  // Without motion, fall back to a static split between the two colours.
+  .indicator--alternate {
+    animation: none;
+    background: linear-gradient(
+      90deg,
+      rgb(var(--indicator-color)) 0 50%,
+      rgb(var(--indicator-alt-color)) 50% 100%
+    );
+  }
 }