open-consul/ui/packages/consul-ui/app/components/badge
John Cowen 2200cde988
ui: Replaces almost all remaining instances of SASS variables with CSS (#11200)
From an engineers perspective, whenever specifying colors from now on we should use the form:

```
color: rgb(var(--tone-red-500));
```

Please note:

- Use rgb. This lets us do this like rgb(var(--tone-red-500) / 10%) so we can use a 10% opacity red-500 if we ever need to whilst still making use of our color tokens.
- Use --tone-colorName-000 (so the prefix tone). Previously we could use a mix of --gray-500: $gray-500 (note the left hand CSS prop and right hand SASS var) for the things we need to theme currently. As we no longer use SASS we can't do --gray-500: --gray-500, so we now do --tone-gray-500: --gray-500.

Just for clarity after that, whenever specifying a color anywhere, use rgb and --tone. There is only one reason where you might not use tone, and that is if you never want a color to be affected by a theme (for example a background shadow probably always should use --black)

There are a 2 or 3 left for the code editor, plus our custom-query values
2021-10-07 19:21:11 +01:00
..
debug.scss
index.scss ui: Replaces almost all remaining instances of SASS variables with CSS (#11200) 2021-10-07 19:21:11 +01:00
README.mdx

---
class: css
---
# badge

`%badge` is a slightly rounded pill (also `%badge-with-icon` for badges that need icons), made to easily fit inside a `%horizontal-kv-list` along with other key/values, or on its own as a single badge. Colors default to grays, but can be overridden via selectors.

```hbs preview-template
<figure>
  <figcaption>Can be used as part of a horizontal-kv-list</figcaption>

  <dl>
    <dt class="kind-terminating-gateway">Kind</dt>
    <dd>
      Terminating Gateway
    </dd>
    <dt class="service-identity">
      Service Identity
    </dt>
    <dd>service-0</dd>
    <dt class>Something</dt>
    <dd>else, here</dd>
  </dl>

</figure>
<figure>
  <figcaption>...or as a single `dl` element on its own</figcaption>

  <dl class="kind-terminating-gateway">
    <dt>Kind</dt>
    <dd>
      Terminating Gateway
    </dd>
  </dl><!--
    Collapse the whitespace whilst maintaining indentation
--><dl>
    <dt
      class="service-identity"
    >
      Service Identity
    </dt>
    <dd>service-0</dd>
  </dl>
</figure>
```


```css
/* part of a kv list */
dl {
  @extend %horizontal-kv-list;
}
dt.service-identity {
  @extend %badge;
}
dt.kind-terminating-gateway {
  @extend %badge, %badge-with-icon;
}
dt.kind-terminating-gateway::before {
  @extend %with-gateway-mask, %as-pseudo;
}
/* element on its own */
dl.service-identity,
dl.kind-terminating-gateway {
  @extend %horizontal-kv-list;
}
dl.service-identity dt {
  @extend %badge;
}
dl.kind-terminating-gateway dt {
  @extend %badge, %badge-with-icon;
}
dl.kind-terminating-gateway dt::before {
  @extend %with-gateway-mask, %as-pseudo;
}
```