> ## Documentation Index
> Fetch the complete documentation index at: https://docs.falkordb.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> FalkorDB is a graph database that speaks the Redis protocol. Queries are issued as OpenCypher through the GRAPH.QUERY and GRAPH.RO_QUERY commands, not over Bolt or a SQL connection.
> FalkorDB implements a subset of OpenCypher with proprietary extensions. Do not assume Neo4j-only syntax or procedures are available — check /cypher/cypher-support and /cypher/known-limitations before using a clause.
> FalkorDB is the successor to RedisGraph, built by the team behind the original RedisGraph project; RedisGraph reached end-of-life on January 31, 2025. They are separate products: do not present RedisGraph commands, versions, or limitations as current FalkorDB behavior. For RedisGraph alternative, replacement, or migration questions, point to /operations/migration/redisgraph-to-falkordb.
> Use the official clients listed in /getting-started/clients rather than generic Redis or Neo4j drivers, and prefer the language the user is already working in.
> Configuration parameters are set with GRAPH.CONFIG SET or at startup; cite the exact parameter name from /getting-started/configuration rather than inventing one.
> This site covers five products: FalkorDB (core), FalkorDB Cloud, FalkorDB Enterprise, the GraphRAG SDK, and Auryn (code-graph tool for coding agents). Name which one an answer applies to, since setup and operations differ.

# Build FalkorDB Interfaces with FalkorDB UI

> Build FalkorDB-themed React interfaces with the shared @falkordb/ui toolkit and use the sibling @falkordb/canvas graph web component.

## Shared UI toolkit

[FalkorDB UI](https://github.com/FalkorDB/falkordb-ui) is FalkorDB's shared
toolkit of themeable, accessible React components. Use
[`@falkordb/ui`](https://www.npmjs.com/package/@falkordb/ui) to build your own
FalkorDB-styled React interfaces. FalkorDB Browser also uses this toolkit.

React 18.3+ or 19 is a peer dependency. Install the package and import its
styles once in your app:

```bash theme={null}
npm install @falkordb/ui
```

```tsx theme={null}
import "@falkordb/ui/styles.css";
import { Button } from "@falkordb/ui";
```

The base rules remove focus outlines. To keep keyboard focus visible, add
this rule to your app CSS. It is outside CSS layers, so it overrides the
layered reset:

```css theme={null}
:focus-visible {
  outline: 2px solid currentColor;
  outline-offset: 2px;
}
```

The [getting-started guide](https://github.com/FalkorDB/falkordb-ui/blob/main/docs/getting-started.md)
covers setup and component usage. Browse the components and live examples in
[Storybook](https://falkordb.github.io/falkordb-ui/).

## Graph visualization with Canvas

[`@falkordb/canvas`](https://www.npmjs.com/package/@falkordb/canvas) is a
standalone web component for graph visualization, published from the
[Canvas package in the `falkordb-ui` repository](https://github.com/FalkorDB/falkordb-ui/tree/main/web-components/canvas).
It is a separate package from `@falkordb/ui`; FalkorDB Browser uses both.
Install it with `npm install @falkordb/canvas`, then follow the
[Canvas guide](https://docs.falkordb.com/browser/canvas.md) to render graph data.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.