-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b50dc3e
commit f4e96bd
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# `DisplayTable` Component Specification | ||
|
||
## Overview | ||
|
||
A `DisplayTable` is used for presenting information displayed across columns and rows. | ||
|
||
--- | ||
|
||
## Design | ||
|
||
`DisplayTable` is only for presentational concerns. It doesn't support advanced capabilities such as selection, sorting, and row expansion. With that in mind, complexities are primarily shifted to surfacing a simple component API, structuring the table properly to support the style requirements, and ensuring that accessibility markup is applied correctly. | ||
|
||
Even though `DisplayTable` doesn't do much in terms of functionality, because accessibility concerns can be non-trivial, we will use `useTable` from React Aria to ensure that we have our accessibility bases covered. | ||
|
||
### API | ||
|
||
```ts | ||
|
||
``` | ||
|
||
### Example Usage | ||
|
||
_Simple_: | ||
|
||
```tsx | ||
import { Modal } from "@easypost/easy-ui/Modal"; | ||
|
||
function PageWithModal() { | ||
return <DisplayTable />; | ||
} | ||
``` |