@fvc/empty 1.1.1 → 1.1.2-next-ec65dfb844e6183b3d7f417eee613cfe5ecfd997

package/README.md

@@ -0,0 +1,131 @@
+# @fvc/empty
+
+`@fvc/empty` provides a FE-VIS empty state primitive on top of Ant Design Empty. It exposes the full Ant Design Empty API with a consistent CSS prefix and `testId` support, and re-exports the preset image constants for use in consuming applications.
+
+## Installation
+
+```bash
+bun add @fvc/empty
+```
+
+## Peer Dependencies
+
+```bash
+bun add react antd
+```
+
+## Import
+
+```tsx
+import { Empty } from '@fvc/empty';
+```
+
+## Quick Start
+
+```tsx
+import { Empty } from '@fvc/empty';
+
+export function NoResults() {
+  return <Empty description="No records found" />;
+}
+```
+
+## Common Usage
+
+### Default Empty State
+
+```tsx
+<Empty />
+```
+
+### Custom Description
+
+```tsx
+<Empty description="No data available for the selected period" />
+```
+
+### Simple Image
+
+```tsx
+<Empty image={Empty.PRESENTED_IMAGE_SIMPLE} description="Nothing here" />
+```
+
+### With Action
+
+```tsx
+<Empty description="No records found">
+  <Button type="primary" onClick={handleCreate}>
+    Create record
+  </Button>
+</Empty>
+```
+
+### No Description
+
+```tsx
+<Empty description={false} />
+```
+
+### Custom Image
+
+```tsx
+<Empty
+  image="https://example.com/custom-empty.svg"
+  imageStyle={{ height: 80 }}
+  description="No results"
+/>
+```
+
+## Props
+
+| Prop | Type | Description |
+| --- | --- | --- |
+| `testId` | `string` | Maps to `data-testid`. |
+| *All `EmptyProps`* | — | All Ant Design Empty props (`description`, `image`, `imageStyle`, `children`, etc.). |
+
+### Static Properties
+
+| Property | Description |
+| --- | --- |
+| `Empty.PRESENTED_IMAGE_DEFAULT` | Default Ant Design empty illustration. |
+| `Empty.PRESENTED_IMAGE_SIMPLE` | Simplified Ant Design empty illustration. |
+
+## Consumer Example
+
+```tsx
+import { Empty } from '@fvc/empty';
+import { Button } from '@fvc/button';
+
+export function EmptyTable({ onAdd }: { onAdd: () => void }) {
+  return (
+    <Empty
+      image={Empty.PRESENTED_IMAGE_SIMPLE}
+      description="No records found"
+      testId="table-empty-state"
+    >
+      <Button type="primary" onClick={onAdd}>
+        Add record
+      </Button>
+    </Empty>
+  );
+}
+```
+
+## Testing
+
+```tsx
+<Empty description="No data" testId="empty-state" />
+```
+
+```tsx
+screen.getByTestId('empty-state');
+```
+
+## Development
+
+```bash
+bun run lint
+bun run type-check
+bun run test
+bun run build
+```

package/package.json

@@ -1,6 +1,16 @@
 {
   "name": "@fvc/empty",
-  "version": "1.1.1",
+  "version": "1.1.2-next-ec65dfb844e6183b3d7f417eee613cfe5ecfd997",
+  "keywords": [
+    "react",
+    "react-component",
+    "fvc",
+    "fe-vis-core",
+    "ui",
+    "empty",
+    "design-system",
+    "antd"
+  ],
   "main": "./dist/lib/index.js",
   "types": "./dist/lib/empty/src/index.d.ts",
   "files": [