@datarecce/ui
v1.37.0
Published
Recce UI Components Library - Reusable React components for data validation and review
Downloads
2,213
Readme
@datarecce/ui
Shared UI library for Recce OSS and Recce Cloud.
Quick Start
Install (workspace):
cd js
pnpm installBasic usage with RecceProvider:
import { RecceProvider } from "@datarecce/ui/providers";
import { LineageView } from "@datarecce/ui/components/lineage";
export function App() {
return (
<RecceProvider api={{ baseUrl: "/api" }}>
<LineageView />
</RecceProvider>
);
}Primitives and advanced exports:
import { DiffText, HSplit } from "@datarecce/ui/primitives";
import { LineageCanvas, useThemeColors } from "@datarecce/ui/advanced";API Reference
Generate API reference via TypeDoc:
cd js/packages/ui
pnpm docs:apiThe generated output lives in js/packages/ui/docs/api/.
TypeScript Types
All exports ship with TypeScript definitions. Use the exported types from the same module path as the component or hook you import.
Environment overrides
@datarecce/ui ships defaults for public URLs, but you can override them via Next.js env vars:
NEXT_PUBLIC_API_URL- overrides the default API base URL.NEXT_PUBLIC_RECCE_SUPPORT_CALENDAR_URL- overrides the support calendar URL.
These values are read from process.env at runtime in the host app.
