Skip to content

feat: default EmptyTableState elevation to overlay #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tmccoy14 merged 2 commits into from
Jun 30, 2026
Merged

feat: default EmptyTableState elevation to overlay #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
837bf30
feat: default EmptyTableState elevation to overlay
tmccoy14 Jun 30, 2026
c749af2
docs: clarify EmptyTableState elevation example overrides default
tmccoy14 Jun 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions packages/demo/src/content/components/empty-table-state.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,13 @@ When an empty result is the consequence of active filters, set `showClearButton`

### Elevation

Use the `elevation` prop to control the elevation of the icon's background so it sits correctly against the surface it's placed on. It accepts the same elevation values as the rest of the design system and defaults to `raised`.
Use the `elevation` prop to control the elevation of the icon's background so it sits correctly against the surface it's placed on. It accepts the same elevation values as the rest of the design system and defaults to `overlay` (the example below sets `elevation="raised"` to demonstrate overriding the default).

<EmptyTableState
icon="SearchX"
title="No Members Available"
description="Members will appear here once they are available to be added."
elevation="overlay"
elevation="raised"
/>

#### Usage
Expand All @@ -92,19 +92,19 @@ import { ELEVATION } from "@eqtylab/equality";
<EmptyTableState
icon="SearchX"
title="No Members Available"
elevation={ELEVATION.OVERLAY}
elevation={ELEVATION.RAISED}
/>;
```

## Props

---

| Name | Description | Type | Default | Required |
| ----------------- | --------------------------------------------------------- | ------------------------------------- | -------- | -------- |
| `icon` | Lucide icon name or a React element shown above the title | `string`, `React.ReactElement` | — | ✅ |
| `title` | Heading text describing the empty state | `string` | — | ✅ |
| `description` | Supporting text shown below the title | `string` | — | ❌ |
| `elevation` | Elevation applied to the icon's background | `sunken`, `base`, `raised`, `overlay` | `raised` | ❌ |
| `showClearButton` | Shows the "Clear Filters" button (requires `onClear`) | `boolean` | `false` | ❌ |
| `onClear` | Callback fired when the "Clear Filters" button is clicked | `() => void` | — | ❌ |
| Name | Description | Type | Default | Required |
| ----------------- | --------------------------------------------------------- | ------------------------------------- | --------- | -------- |
| `icon` | Lucide icon name or a React element shown above the title | `string`, `React.ReactElement` | — | ✅ |
| `title` | Heading text describing the empty state | `string` | — | ✅ |
| `description` | Supporting text shown below the title | `string` | — | ❌ |
| `elevation` | Elevation applied to the icon's background | `sunken`, `base`, `raised`, `overlay` | `overlay` | ❌ |
| `showClearButton` | Shows the "Clear Filters" button (requires `onClear`) | `boolean` | `false` | ❌ |
| `onClear` | Callback fired when the "Clear Filters" button is clicked | `() => void` | — | ❌ |
2 changes: 1 addition & 1 deletion packages/ui/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@eqtylab/equality",
"description": "EQTYLab's component and token-based design system",
"homepage": "https://equality.eqtylab.io/",
"version": "2.1.4",
"version": "2.1.5",
"license": "Apache-2.0",
"keywords": [
"component library",
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/components/empty-table-state/empty-table-state.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ const EmptyTableState = ({
icon,
title,
description,
elevation = ELEVATION.RAISED,
elevation = ELEVATION.OVERLAY,
showClearButton = false,
onClear,
className,
Expand Down
Loading