Installation

Get started with Plexus UI components in your React project.

Prerequisites

  • React 18 or higher
  • A modern browser with WebGPU support (Chrome 113+, Edge 113+)
  • Node.js 18 or higher

Quick Start

Initialize Plexus UI in your project with a single command:

npx plexus-ui init

This will set up the necessary configuration and directory structure for Plexus UI components.

Adding Components

Add individual components to your project:

npx plexus-ui add [component-name]

For example, to add the GPU-accelerated line chart:

npx plexus-ui add line-chart

Available Components

View all available components:

npx plexus-ui list

Filter by category:

npx plexus-ui list --category charts

Categories: charts, instruments, 3d, data-display, timeline, interactive

Check for Updates

See if a component has been updated:

npx plexus-ui diff [component-name]

Usage Example

Once installed, import and use components in your React application:

import { LineChart } from "@plexusui/components/charts/line-chart";

export function TelemetryDashboard() {
  const [data, setData] = useState<{ x: number; y: number }[]>([]);

  return (
    <LineChart.Root
      series={[{ name: "Signal", data, color: "#22c55e" }]}
      width={800}
      height={400}
      preferWebGPU
    >
      <LineChart.Canvas showGrid />
      <LineChart.Axes />
      <LineChart.Tooltip />
    </LineChart.Root>
  );
}

Resources