open-consul/ui/packages/consul-ui/app/components/notice
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
..
README.mdx ui: Rename icons for consistency and remove unused icons (#10311) 2021-06-22 18:56:17 +01:00
index.hbs ui: Serf Health Check warning notice (#10194) 2021-05-13 11:36:51 +01:00
index.scss ui: Fixup prettier for scss files and run (#10296) 2021-05-27 13:23:54 +01:00
layout.scss ui: Upgrade the rest of the UI to use the new Notice component (#9035) 2020-10-26 16:51:53 +00:00
skin.scss ui: Replaces almost all remaining instances of SASS variables with CSS (#11200) 2021-10-07 19:21:11 +01:00

README.mdx

# Notice

Presentational component for informational/warning/error banners/notices.


```hbs preview-template
<Notice
  @type={{this.type}}
as |notice|>
  <notice.Header>
    <h3>Header</h3>
  </notice.Header>
  <notice.Body>
    <p>
      Body
    </p>
  </notice.Body>
  <notice.Footer>
    <p>
      <a href="">Footer link</a>
    </p>
  </notice.Footer>
</Notice>

<figure>
  <figcaption>Provide a widget to change the <code>@type</code></figcaption>

  <select
    onchange={{action (mut this.type) value="target.value"}}
  >
    <option>info</option>
    <option>success</option>
    <option>warning</option>
    <option>error</option>
  </select>

</figure>
```

## Arguments

| Argument/Attribute | Type | Default | Description |
| --- | --- | --- | --- |
| `type` | `String` | `info` | Type of notice [info\|warning\|error] |

## See

- [Template Source Code](./index.hbs)

---