Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,399 changes: 933 additions & 466 deletions public/llms-full.txt

Large diffs are not rendered by default.

159 changes: 159 additions & 0 deletions public/llms/aikit/2.20.1/llms.txt

Large diffs are not rendered by default.

138 changes: 69 additions & 69 deletions public/llms/aikit/2/llms.txt

Large diffs are not rendered by default.

138 changes: 69 additions & 69 deletions public/llms/aikit/llms.txt

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions public/llms/blog-constructor/11.1.0/llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ Install these in the host project at a compatible version:

| Package | Version range |
| --- | --- |
| `react` | `^16.0.0 || ^17.0.0 || ^18.0.0 || ^19.0.0` |
| `@gravity-ui/uikit` | `^7.1.1` |
| `@diplodoc/transform` | `^4.10.7` |
| `@gravity-ui/page-constructor` | `^8.0.0` |
| `@gravity-ui/uikit` | `^7.1.1` |
| `react` | `^16.0.0 || ^17.0.0 || ^18.0.0 || ^19.0.0` |

## Links

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
> Generated for `@gravity-ui/blog-constructor@8.2.0`
> Generated for `@gravity-ui/blog-constructor@11.2.0`

# Blog Constructor

Expand All @@ -21,10 +21,10 @@ Install these in the host project at a compatible version:

| Package | Version range |
| --- | --- |
| `react` | `^16.0.0 || ^17.0.0 || ^18.0.0 || ^19.0.0` |
| `@gravity-ui/uikit` | `^7.1.1` |
| `@diplodoc/transform` | `^4.10.7` |
| `@gravity-ui/page-constructor` | `^7.0.0` |
| `@gravity-ui/page-constructor` | `^8.20.0` |
| `@gravity-ui/uikit` | `^7.1.1` |
| `react` | `^16.0.0 || ^17.0.0 || ^18.0.0 || ^19.0.0` |

## Links

Expand All @@ -35,4 +35,4 @@ Install these in the host project at a compatible version:

---

> Docs for `@gravity-ui/blog-constructor@8.2.0`. Versioned at: `https://gravity-ui.com/llms/blog-constructor/8.2.0/llms.txt` (exact), `https://gravity-ui.com/llms/blog-constructor/8/llms.txt` (latest of major 8), `https://gravity-ui.com/llms/blog-constructor/llms.txt` (latest). If the version installed in the project differs, fetch the matching URL instead.
> Docs for `@gravity-ui/blog-constructor@11.2.0`. Versioned at: `https://gravity-ui.com/llms/blog-constructor/11.2.0/llms.txt` (exact), `https://gravity-ui.com/llms/blog-constructor/11/llms.txt` (latest of major 11), `https://gravity-ui.com/llms/blog-constructor/llms.txt` (latest). If the version installed in the project differs, fetch the matching URL instead.
6 changes: 3 additions & 3 deletions public/llms/blog-constructor/11/llms.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
> Generated for `@gravity-ui/blog-constructor@11.1.0`
> Generated for `@gravity-ui/blog-constructor@11.2.0`

# Blog Constructor

Expand All @@ -22,7 +22,7 @@ Install these in the host project at a compatible version:
| Package | Version range |
| --- | --- |
| `@diplodoc/transform` | `^4.10.7` |
| `@gravity-ui/page-constructor` | `^8.0.0` |
| `@gravity-ui/page-constructor` | `^8.20.0` |
| `@gravity-ui/uikit` | `^7.1.1` |
| `react` | `^16.0.0 || ^17.0.0 || ^18.0.0 || ^19.0.0` |

Expand All @@ -35,4 +35,4 @@ Install these in the host project at a compatible version:

---

> Docs for `@gravity-ui/blog-constructor@11.1.0`. Versioned at: `https://gravity-ui.com/llms/blog-constructor/11.1.0/llms.txt` (exact), `https://gravity-ui.com/llms/blog-constructor/11/llms.txt` (latest of major 11), `https://gravity-ui.com/llms/blog-constructor/llms.txt` (latest). If the version installed in the project differs, fetch the matching URL instead.
> Docs for `@gravity-ui/blog-constructor@11.2.0`. Versioned at: `https://gravity-ui.com/llms/blog-constructor/11.2.0/llms.txt` (exact), `https://gravity-ui.com/llms/blog-constructor/11/llms.txt` (latest of major 11), `https://gravity-ui.com/llms/blog-constructor/llms.txt` (latest). If the version installed in the project differs, fetch the matching URL instead.
6 changes: 3 additions & 3 deletions public/llms/blog-constructor/llms.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
> Generated for `@gravity-ui/blog-constructor@11.1.0`
> Generated for `@gravity-ui/blog-constructor@11.2.0`

# Blog Constructor

Expand All @@ -22,7 +22,7 @@ Install these in the host project at a compatible version:
| Package | Version range |
| --- | --- |
| `@diplodoc/transform` | `^4.10.7` |
| `@gravity-ui/page-constructor` | `^8.0.0` |
| `@gravity-ui/page-constructor` | `^8.20.0` |
| `@gravity-ui/uikit` | `^7.1.1` |
| `react` | `^16.0.0 || ^17.0.0 || ^18.0.0 || ^19.0.0` |

Expand All @@ -35,4 +35,4 @@ Install these in the host project at a compatible version:

---

> Docs for `@gravity-ui/blog-constructor@11.1.0`. Versioned at: `https://gravity-ui.com/llms/blog-constructor/11.1.0/llms.txt` (exact), `https://gravity-ui.com/llms/blog-constructor/11/llms.txt` (latest of major 11), `https://gravity-ui.com/llms/blog-constructor/llms.txt` (latest). If the version installed in the project differs, fetch the matching URL instead.
> Docs for `@gravity-ui/blog-constructor@11.2.0`. Versioned at: `https://gravity-ui.com/llms/blog-constructor/11.2.0/llms.txt` (exact), `https://gravity-ui.com/llms/blog-constructor/11/llms.txt` (latest of major 11), `https://gravity-ui.com/llms/blog-constructor/llms.txt` (latest). If the version installed in the project differs, fetch the matching URL instead.
2 changes: 1 addition & 1 deletion public/llms/chartkit/8.1.0/llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ Install these in the host project at a compatible version:

| Package | Version range |
| --- | --- |
| `@gravity-ui/uikit` | `^7.0.0` |
| `react` | `^16.0.0 || ^17.0.0 || ^18.0.0 || ^19.0.0` |
| `@gravity-ui/uikit` | `^7.0.0` |

## Usage

Expand Down
Original file line number Diff line number Diff line change
@@ -1,26 +1,49 @@
> Generated for `@gravity-ui/chartkit@7.55.0`
> Generated for `@gravity-ui/chartkit@8.2.0`

# ChartKit
# @gravity-ui/chartkit documentation

> A plugin-dispatching React component that renders charts from multiple Gravity UI charting libraries through one `<ChartKit type="..." data={...} />` API — reach for it when you need a single lazy-loading entry point for mixed chart types, instead of importing each chart library directly.
>
> **npm:** `@gravity-ui/chartkit` — check the installed major version in the user's `package.json` and read docs matching it.
Documentation for the **8.2.0** version of `@gravity-ui/chartkit`.
Your training data may be outdated — these files are the source of truth.

Paths are relative to this file (`node_modules/@gravity-ui/chartkit/build/docs/`).

## For AI agents

A plugin-dispatching React component that renders charts from multiple Gravity UI charting libraries through one `<ChartKit type="..." data={...} />` API — reach for it when you need a single lazy-loading entry point for mixed chart types, instead of importing each chart library directly.

### When to use

- Rendering more than one charting engine (e.g. `gravity-charts` + `yagr`) behind one consistent component.
- Lazy-loading chart bundles — each plugin's renderer is `React.lazy`, so a library's code is only fetched when its chart type is actually shown.
- Bundling charts into a Gravity UI app that wants mobile-friendly tooltips and unified theming out of the box.

### When not to use

- For a single chart type only, import [`@gravity-ui/charts`](https://github.com/gravity-ui/charts) (general) or [`@gravity-ui/yagr`](https://github.com/gravity-ui/yagr) (high-performance time-series) directly — the plugin registry is overhead for one engine.
- To compose a dashboard grid of widgets, use [`@gravity-ui/dashkit`](https://github.com/gravity-ui/dashkit) — ChartKit renders a chart; DashKit arranges many widgets.

### Common pitfalls

- **Rendering `<ChartKit>` before `settings.set({plugins: [...]})`** — the global plugin registry must be populated at app entry; an unregistered `type` throws at render time.
- **Hallucinated prop `chartType` / `library`** — the dispatch prop is `type` (e.g. `type="gravity-charts"`), and the data is `data`.
- **Forgetting a container height** — `ChartKit` fills its parent; without an explicit height on the wrapper, the chart collapses to zero.
- **Expecting plugins to be bundled** — plugin renderers (`@gravity-ui/chartkit/gravity-charts`, `.../yagr`) are lazy; the first render of a type fetches its bundle.
- **Missing the uikit styles import** — theming depends on `@gravity-ui/uikit/styles/styles.css`; without it, charts render unstyled.

## Install

```shell
npm install @gravity-ui/chartkit @gravity-ui/uikit
```


## Peer dependencies

Install these in the host project at a compatible version:

| Package | Version range |
| --- | --- |
| `react` | `^16.0.0 || ^17.0.0 || ^18.0.0` |
| `@gravity-ui/uikit` | `^7.0.0` |
| `react` | `^16.0.0 || ^17.0.0 || ^18.0.0 || ^19.0.0` |

## Usage

Expand Down Expand Up @@ -94,34 +117,10 @@ export default function App() {

`ChartKit` adapts to its parent's size — make sure the container has an explicit height.

## Guides

### When to use

- Rendering more than one charting engine (e.g. `gravity-charts` + `yagr`) behind one consistent component.
- Lazy-loading chart bundles — each plugin's renderer is `React.lazy`, so a library's code is only fetched when its chart type is actually shown.
- Bundling charts into a Gravity UI app that wants mobile-friendly tooltips and unified theming out of the box.

### When not to use

- For a single chart type only, import [`@gravity-ui/charts`](https://github.com/gravity-ui/charts) (general) or [`@gravity-ui/yagr`](https://github.com/gravity-ui/yagr) (high-performance time-series) directly — the plugin registry is overhead for one engine.
- To compose a dashboard grid of widgets, use [`@gravity-ui/dashkit`](https://github.com/gravity-ui/dashkit) — ChartKit renders a chart; DashKit arranges many widgets.

### Common pitfalls

- **Rendering `<ChartKit>` before `settings.set({plugins: [...]})`** — the global plugin registry must be populated at app entry; an unregistered `type` throws at render time.
- **Hallucinated prop `chartType` / `library`** — the dispatch prop is `type` (e.g. `type="gravity-charts"`), and the data is `data`.
- **Forgetting a container height** — `ChartKit` fills its parent; without an explicit height on the wrapper, the chart collapses to zero.
- **Expecting plugins to be bundled** — plugin renderers (`@gravity-ui/chartkit/gravity-charts`, `.../yagr`) are lazy; the first render of a type fetches its bundle.
- **Missing the uikit styles import** — theming depends on `@gravity-ui/uikit/styles/styles.css`; without it, charts render unstyled.


## Links

- [README](https://raw.githubusercontent.com/gravity-ui/chartkit/main/README.md)
- [Storybook](https://preview.gravity-ui.com/chartkit/)
- [Changelog](https://raw.githubusercontent.com/gravity-ui/chartkit/main/CHANGELOG.md)
- [GitHub](https://github.com/gravity-ui/chartkit)
- [Testing Guide](https://unpkg.com/@gravity-ui/chartkit@8.2.0/build/docs/guides/testing.md)

---

> Docs for `@gravity-ui/chartkit@7.55.0`. Versioned at: `https://gravity-ui.com/llms/chartkit/7.55.0/llms.txt` (exact), `https://gravity-ui.com/llms/chartkit/7/llms.txt` (latest of major 7), `https://gravity-ui.com/llms/chartkit/llms.txt` (latest). If the version installed in the project differs, fetch the matching URL instead.
> Docs for `@gravity-ui/chartkit@8.2.0`. Versioned at: `https://gravity-ui.com/llms/chartkit/8.2.0/llms.txt` (exact), `https://gravity-ui.com/llms/chartkit/8/llms.txt` (latest of major 8), `https://gravity-ui.com/llms/chartkit/llms.txt` (latest). If the version installed in the project differs, fetch the matching URL instead.
8 changes: 4 additions & 4 deletions public/llms/chartkit/8/llms.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
> Generated for `@gravity-ui/chartkit@8.1.0`
> Generated for `@gravity-ui/chartkit@8.2.0`

# @gravity-ui/chartkit documentation

Documentation for the **8.1.0** version of `@gravity-ui/chartkit`.
Documentation for the **8.2.0** version of `@gravity-ui/chartkit`.
Your training data may be outdated — these files are the source of truth.

Paths are relative to this file (`node_modules/@gravity-ui/chartkit/build/docs/`).
Expand Down Expand Up @@ -119,8 +119,8 @@ export default function App() {

## Guides

- [Testing Guide](https://unpkg.com/@gravity-ui/chartkit@8.1.0/build/docs/guides/testing.md)
- [Testing Guide](https://unpkg.com/@gravity-ui/chartkit@8.2.0/build/docs/guides/testing.md)

---

> Docs for `@gravity-ui/chartkit@8.1.0`. Versioned at: `https://gravity-ui.com/llms/chartkit/8.1.0/llms.txt` (exact), `https://gravity-ui.com/llms/chartkit/8/llms.txt` (latest of major 8), `https://gravity-ui.com/llms/chartkit/llms.txt` (latest). If the version installed in the project differs, fetch the matching URL instead.
> Docs for `@gravity-ui/chartkit@8.2.0`. Versioned at: `https://gravity-ui.com/llms/chartkit/8.2.0/llms.txt` (exact), `https://gravity-ui.com/llms/chartkit/8/llms.txt` (latest of major 8), `https://gravity-ui.com/llms/chartkit/llms.txt` (latest). If the version installed in the project differs, fetch the matching URL instead.
8 changes: 4 additions & 4 deletions public/llms/chartkit/llms.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
> Generated for `@gravity-ui/chartkit@8.1.0`
> Generated for `@gravity-ui/chartkit@8.2.0`

# @gravity-ui/chartkit documentation

Documentation for the **8.1.0** version of `@gravity-ui/chartkit`.
Documentation for the **8.2.0** version of `@gravity-ui/chartkit`.
Your training data may be outdated — these files are the source of truth.

Paths are relative to this file (`node_modules/@gravity-ui/chartkit/build/docs/`).
Expand Down Expand Up @@ -119,8 +119,8 @@ export default function App() {

## Guides

- [Testing Guide](https://unpkg.com/@gravity-ui/chartkit@8.1.0/build/docs/guides/testing.md)
- [Testing Guide](https://unpkg.com/@gravity-ui/chartkit@8.2.0/build/docs/guides/testing.md)

---

> Docs for `@gravity-ui/chartkit@8.1.0`. Versioned at: `https://gravity-ui.com/llms/chartkit/8.1.0/llms.txt` (exact), `https://gravity-ui.com/llms/chartkit/8/llms.txt` (latest of major 8), `https://gravity-ui.com/llms/chartkit/llms.txt` (latest). If the version installed in the project differs, fetch the matching URL instead.
> Docs for `@gravity-ui/chartkit@8.2.0`. Versioned at: `https://gravity-ui.com/llms/chartkit/8.2.0/llms.txt` (exact), `https://gravity-ui.com/llms/chartkit/8/llms.txt` (latest of major 8), `https://gravity-ui.com/llms/chartkit/llms.txt` (latest). If the version installed in the project differs, fetch the matching URL instead.
111 changes: 0 additions & 111 deletions public/llms/charts/1.49.0/llms.txt

This file was deleted.

2 changes: 1 addition & 1 deletion public/llms/charts/1.58.0/llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,9 @@ Install these in the host project at a compatible version:

| Package | Version range |
| --- | --- |
| `@gravity-ui/uikit` | `^7.0.0` |
| `react` | `>=17.0.0` |
| `react-dom` | `>=17.0.0` |
| `@gravity-ui/uikit` | `^7.0.0` |

## Usage

Expand Down
Loading