@graphysdk/react

中文文档
1.9.0-beta.1794847602792发布于 2026/11/17SEE LICENSE IN LICENSE.mdTypeScriptESM + CJS近 30 天下载 2.9万

Graphy charting SDK for React

原始使用文档
文档目录11 节
  1. Install
  2. Usage
  3. Docs
  4. Editable charts
  5. Hiding the mark
  6. Chart count
  7. Custom geoms
  8. Other packages
  9. Agent skills
  10. Licence
  11. Support

@graphysdk/react

The Graphy charting SDK for React. Build a chart spec and render it from one package. The "Powered by Graphy" mark is on by default.

Learn more at graphy.dev.

Install

npm install @graphysdk/react

Requires React 19. There is no stylesheet to import.

Usage

import { GraphProvider, GraphRenderer, createSpec, pipe, geom, scale } from '@graphysdk/react';

const spec = pipe(createSpec({ x: 'month', y: 'revenue' }), geom.bar(), scale.x(), scale.y());

export function Chart({ data }) {
  return (
    <GraphProvider data={data} spec={spec}>
      <GraphRenderer />
    </GraphProvider>
  );
}

Docs

Editable charts

import { GraphProvider } from '@graphysdk/react';
import { EditableGraphRenderer } from '@graphysdk/react/editable';

export function EditableChart({ data, spec, isEditing }) {
  return (
    <GraphProvider data={data} spec={spec} mode={isEditing ? 'annotate' : 'readonly'}>
      <EditableGraphRenderer />
    </GraphProvider>
  );
}

Import commands from the same entry to edit charts from code:

import { useGraphCommands } from '@graphysdk/react';
import { SetContentTitleCommand } from '@graphysdk/react/editable';

const { dispatch } = useGraphCommands();
dispatch(new SetContentTitleCommand({ title: 'Revenue by quarter' }));

Hiding the mark

import { config, createSpec, geom, pipe } from '@graphysdk/react';

const spec = pipe(
  createSpec({ x: 'month', y: 'revenue' }),
  geom.bar(),
  config({ content: { graphyBadge: { visible: false } } })
);

Chart count

Production browser builds send one anonymous count the first time a chart appears. The count includes the chart type and similar flags. It does not include cell values, column names, or labels. Development builds print one console line and send nothing.

<GraphProvider data={data} spec={spec} telemetry={false}>
  <GraphRenderer />
</GraphProvider>

Custom geoms

Plugin authoring uses the same package. Geom, the value readers, defineGeomRenderer, and createGraphyKit are all exported from @graphysdk/react — there is no need to add @graphysdk/viz-engine or @graphysdk/react-renderer as direct dependencies.

import { Geom, createGraphyKit, defineGeomRenderer } from '@graphysdk/react';

Other packages

An explicit setting always wins over this package's default.

Agent skills

Install the Graphy agent skills from github.com/graphysdk/skills to set up the SDK and author charts from Cursor, Claude Code, and other coding agents.

Licence

This package is available under PolyForm Noncommercial, Small Business, or a 32-day Free Trial. Free Trial is local or internal evaluation only — it does not cover a public page. See what you can do under the trial.

For a commercial licence, talk to us.

Support

Questions and community help: Discord.

版本与发布记录

@graphysdk/react 共发布 380 个版本,首次发布于 2026/04/14;过去 12 个月发布了 380 个版本。

版本发布日期距今
1.9.0-beta.1794847602792latest2026/11/17今天
1.9.0-beta.17948408135452026/11/16今天
1.9.0-beta.17948401073962026/11/16今天
1.9.0-beta.17948274193392026/11/16今天
1.9.0-beta.17945866913282026/11/143 天前
1.9.0-beta.17945823311012026/11/133 天前

关于 @graphysdk/react 的常见问题

@graphysdk/react 是什么?

Graphy charting SDK for React

如何安装 @graphysdk/react?

在项目目录运行 npm install @graphysdk/react,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^19.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@graphysdk/react 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@graphysdk/react 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@graphysdk/react 可以商用吗?

@graphysdk/react 使用 SEE LICENSE IN LICENSE.md 许可。许可条款写在包内的独立文件中,请阅读该文件确认可否商用。以上为概括,不构成法律意见,请以许可原文为准。

@graphysdk/react 的下载量有多少?

根据 npm 官方下载统计,@graphysdk/react 在 2026/10/17 – 2026/11/15 这 30 天内被下载 29,298 次,日均约 977 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@graphysdk/react 还在维护吗?

最新版本 1.9.0-beta.1794847602792 发布于 2026/11/17(今天);至今共发布 380 个版本,其中过去 12 个月发布了 380 个;首次发布于 2026/04/14。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。