Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ router: apps pass their own link component in through `UiProvider`.
Install a release by URL. No registry account or token is needed:

```sh
npm install --save-exact https://github.com/project-graphite/graphite-ui/releases/download/v0.1.0/project-graphite-ui-0.1.0.tgz
npm install --save-exact https://github.com/project-graphite/graphite-ui/releases/download/v0.2.0/project-graphite-ui-0.2.0.tgz
```

Load the theme after Tailwind. `@source` lets Tailwind see the classes the components use, and its
Expand Down Expand Up @@ -51,10 +51,14 @@ import { AppShell, Dialog, TextField, Toggle } from '@project-graphite/ui';
- motion that only runs when reduced motion isn't requested;
- the `shell`, `page-title`, `mono-sm` and `rule-link` utilities;
- generic component classes such as `primary-button`, `tab-link`, `popover-panel` and `tab-bar`.
- **Components**: `AppShell`, `Dialog`, `ConfirmDialog`, `TextField`, `TextAreaField`, `Toggle`,
`EmptyState`, `Pagination`, `SmoothImage`, the skeletons, `Popover`, `Menu`, `SnackbarProvider`,
`OutageGate`, `GridListbox` and `Icon`.
- **Helpers**: `errorMessage`, `isAbortError`, `timeAgo` and `useDismiss`.
- **Components**:
- layout: `AppShell` (with an optional `Sidebar`), `Tabs`;
- dialogs and popups: `Dialog`, `ConfirmDialog`, `CommandPalette`, `Popover`, `Menu`;
- forms: `TextField`, `TextAreaField`, `CodeInput`, `Toggle`, `GridListbox`;
- display: `TagChip`, `Avatar`, `EmptyState`, `Pagination`, `SmoothImage`, the skeletons, `Icon`;
- feedback: `SnackbarProvider`, `OutageGate`.
- **Helpers**: `errorMessage`, `isAbortError`, `timeAgo`, `useDismiss`, and `useCommandShortcut`
(opens the command palette on Ctrl+K or Cmd+K).

The phone layouts are built in. Dialogs become bottom sheets, and the tab bar and popovers account
for the header and the safe area.
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@project-graphite/ui",
"version": "0.1.0",
"version": "0.2.0",
"description": "Project Graphite design tokens, theme and React components.",
"license": "MIT",
"repository": {
Expand Down
Loading