open-consul/ui/packages/consul-ui/app/components/empty-state
John Cowen 42a0f204ac Fixup any psuedo elements that don't need currentColor 2022-04-11 10:05:02 +01:00
..
README.mdx ui: Move control of login modal to use JS rather than HTML (label/id) (#9883) 2021-04-06 13:40:40 +01:00
index.hbs ui: Make it hard to not URLEncode DataSource srcs/URIs (#11117) 2021-09-30 15:54:46 +01:00
index.js ui: Move to Workspaced Structure (#8994) 2020-10-21 15:23:16 +01:00
index.scss ui: Colocate remaining CSS components to the app/components folder (#10328) 2021-06-23 09:19:35 +01:00
layout.scss ui: Move control of login modal to use JS rather than HTML (label/id) (#9883) 2021-04-06 13:40:40 +01:00
pageobject.js ui: Move to Workspaced Structure (#8994) 2020-10-21 15:23:16 +01:00
skin.scss Fixup any psuedo elements that don't need currentColor 2022-04-11 10:05:02 +01:00

README.mdx

---
class: ember
---
# EmptyState

Consul UIs default 'empty state' used for when we retrive an empty result set,
whether that set is successful or erroneous. This is mainly used via the
`ErrorState` component, so also consider using that directly instead of this
component if dealing with errors.

## Arguments

| Argument | Type | Default | Description |
| --- | --- | --- | --- |
| `login` | `Function` | `undefined` | A login action to call when the login button is pressed (if not provided no login button will be shown  |

Icons are controlled via a `status-xxx` class. `xxx` should be some sort of
3 digit error code, special icons are used for `404` and `403`, otherwise a
generic icon will be used. To add any further special icons please add to the
component's `skin` file.

If the `@login` attribute is provided, a button will be shown directly
underneath the body text clicking on which will fire the provided `@login`
function.

```hbs preview-template
<EmptyState
  class="status-404"
  @login={{noop}}
>
  <BlockSlot @name="header">
    <h2>
      Header
    </h2>
  </BlockSlot>
  <BlockSlot @name="subheader">
    <h3>
      Subheader
    </h3>
  </BlockSlot>
  <BlockSlot @name="body">
    <p>
      Body text
    </p>
  </BlockSlot>
  <BlockSlot @name="actions">
    <li class="docs-link">
      <a
        href="{{env 'CONSUL_DOCS_URL'}}/agent/kv"
        rel="noopener noreferrer"
        target="_blank"
      >
          Documentation on K/V
      </a>
    </li>
    <li class="learn-link">
      <a
        href="{{env 'CONSUL_DOCS_LEARN_URL'}}/consul/getting-started/kv"
        rel="noopener noreferrer"
        target="_blank"
      >
        Read the guide
      </a>
    </li>
  </BlockSlot>
</EmptyState>
```

The component has four slots for specifying header, subheader, body and
'actions', although the component will show a minimal empty slot if only the
body slot is specified:

```hbs preview-template
<EmptyState>
  <BlockSlot @name="body">
    <p>
      Minimal text
    </p>
  </BlockSlot>
</EmptyState>
```