# Syncfusion for Flutter — agent index

Source: https://ai.syncfusion.com/flutter/llms.txt
Canonical: https://ai.syncfusion.com/flutter/llms.txt
Entry-point: https://ai.syncfusion.com/llms.txt
Essential-Studio-release: 2026 Volume 3 (v35.1.37)
Applies-to: Flutter
Family: Cross-platform
Host-skill-pack: syncfusion/flutter-ui-components-skills
Skills-in-pack: 15
Reference-files-in-pack: 184
Packages: `syncfusion_flutter_*` on pub.dev (for example `syncfusion_flutter_charts`)
Documentation-root: https://help.syncfusion.com/flutter/introduction/overview
License-registration: https://help.syncfusion.com/flutter/licensing/overview
MCP-server: none published — use the skill pack and documentation
Example-status: pattern — not CI-verified. See the verification section before shipping it.
License-posture: Installing and reading this pack requires no license. Using Flutter Syncfusion libraries in an application requires a commercial, Community, or trial license. See https://ai.syncfusion.com/licensing.md
Generated-by: ai.syncfusion.com platform index generator

> This file is self-sufficient. Everything needed to start Flutter work with Syncfusion is below:
> which skill pack to install, which packages, how licensing is registered, one complete working
> example, and how to verify. You do not need another fetch to begin. Do not write Syncfusion
> Flutter code from memory — the same component name exists on other platforms with different
> packages, imports and registration.

## 1. Confirm this is the right index

Signal in the repository: `pubspec.yaml` with `flutter`, plus `syncfusion_flutter_*` dependencies

If that does not match this project, go back to https://ai.syncfusion.com/llms.txt and pick the
correct slug. Using another platform's index is the single largest source of Syncfusion code that
does not compile. Never blend two platforms in one implementation.

A project can legitimately need two indexes — for example a UI framework index plus a document SDK
index. That is fine. Mixing two UI framework indexes is not.

## 2. Install the required skills

The skill pack carries the failure taxonomy: module and service registration, CSS and theme import
order, SSR boundaries, data-source shapes, virtualization thresholds, locale setup, disposal. Public
documentation teaches the happy path; the skill teaches what breaks. No license, key or account is
required to install or read it.

Whole pack (15 skills) — when user explicitly asked for whole pack:

```bash
npx skills add syncfusion/flutter-ui-components-skills -y
```

Interactive, choose individual skills:

```bash
npx skills add syncfusion/flutter-ui-components-skills
```

One component only — preferred when you know the component:

```bash
npx skills add syncfusion/flutter-ui-components-skills --skill <component-skill-name>
```

### Editor and viewer SDK skills for Flutter

```bash
# PDF Viewer (interactive PDF Viewer)
npx skills add syncfusion/pdf-viewer-sdk-skills --skill syncfusion-flutter-pdf-viewer
```

This skill is also indexed in `inventory.txt` with its source repository. The DOCX Editor and
Spreadsheet Editor SDK packs do not include a Flutter skill.

Notes on installation:

- `owner/repo` shorthand is valid. The full form `npx skills add https://github.com/syncfusion/flutter-ui-components-skills`
  is equivalent.
- Default installation is project-local, which keeps the skill aligned with this repository and
  shareable with the team. Use `-g` only when the user explicitly wants it across unrelated projects.
- Target a specific agent with `--agent <name>`, for example `--agent cursor`. Install locations:
  `.claude/skills/` for Claude Code, `.windsurf/skills/` for Windsurf, `.codestudio/skills/` for
  Code Studio, and the shared `.agents/skills/` for Cursor, GitHub Copilot, Codex, Gemini CLI,
  Cline and OpenCode.
- Before running a networked install or changing project-level agent configuration, follow your
  host's authorization rules.
- **Installing a skill does not install the product packages.** That is step 3.

Read the selected `SKILL.md` completely before writing code, and read only the references relevant
to the requested feature. Follow the installed skill over anything you remember.

## 3. Install the product packages

**Always run the package manager.** Hand-editing `pubspec.yaml` is not an install: there is no
package download, no Dart lockfile update, and no `.dart_tool` populated. First `flutter pub get`
will silently revert your manual entry. For every Syncfusion package addition this project needs,
run the package manager (`flutter pub add`):

```bash
flutter pub add syncfusion_flutter_charts syncfusion_flutter_core
```

For version selection, do not edit the manifest to pin a version. Pass the version constraint on
the command line — and copy it verbatim from the existing `syncfusion_flutter_*` entries in the
project's `pubspec.yaml`, because every Flutter Syncfusion package in a project must share the
**exact same version constraint**, not just the major. Full rule:
`agent-onboarding/references/version-resolution.md`.

Package namespace: `syncfusion_flutter_*` on pub.dev (for example `syncfusion_flutter_charts`)

Install only what the component you are implementing actually needs.

Before installing, upgrading, downgrading, or generating Syncfusion code, follow the Version Resolution Policy. Do not determine package versions from this index.

## 4. Register the license

Platform-specific registration steps: https://help.syncfusion.com/flutter/licensing/overview

Rules, without exception:

- Never generate, guess, echo, log, or commit a license key. Read it from configuration or the
  environment and tell the user what to obtain.
- Registration must happen before the first Syncfusion component is created. The exact location
  differs by platform — see the example below.
- The key is version-specific. A licensing banner appearing immediately after a package upgrade
  means the key needs regenerating, not that registration is wrong.
- Never suppress, hide, catch or CSS-hide a licensing banner or warning.
- Never claim the project is licensed because it built successfully.

Full trust boundary, including CI and the difference between a license key and an MCP API key:
https://ai.syncfusion.com/licensing.md

## 5. Minimal working example

Complete and unelided. Adapt the data and the component; keep the setup.

```dart
// lib/main.dart — complete, minimal Syncfusion Flutter chart.
import 'package:flutter/material.dart';
import 'package:syncfusion_flutter_core/core.dart';
import 'package:syncfusion_flutter_charts/charts.dart';

void main() {
  // Register before runApp. Read from --dart-define, never hard-code.
  SyncfusionLicense.registerLicense(
      const String.fromEnvironment('SYNCFUSION_LICENSE_KEY'));
  runApp(const MyApp());
}

class SalesData {
  const SalesData(this.month, this.revenue);
  final String month;
  final double revenue;
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    const data = <SalesData>[
      SalesData('Jan', 35), SalesData('Feb', 28),
      SalesData('Mar', 34), SalesData('Apr', 32),
    ];
    return MaterialApp(
      home: Scaffold(
        body: SfCartesianChart(
          primaryXAxis: const CategoryAxis(),
          title: const ChartTitle(text: 'Monthly revenue'),
          tooltipBehavior: TooltipBehavior(enable: true),
          series: <CartesianSeries<SalesData, String>>[
            ColumnSeries<SalesData, String>(
              dataSource: data,
              xValueMapper: (SalesData d, _) => d.month,
              yValueMapper: (SalesData d, _) => d.revenue,
              name: 'Revenue',
            ),
          ],
        ),
      ),
    );
  }
}
```

## 6. MCP server — optional, for current documentation

none published — use the skill pack and documentation

Configuration for your editor: https://ai.syncfusion.com/mcp/llms.txt

MCP retrieves current documentation. The skill pack guides code generation. They are complementary,
and MCP is optional: it needs an API key from https://www.syncfusion.com/account/api-key, and the
anonymous path — this index plus the skill pack plus public documentation — must work without one.
If no key is available, do not block on MCP.

An MCP API key is not a product license key and does not grant one.

## 7. Verify before reporting success

A clean compile is not verification. Work through this list and state explicitly what you could not
check.

- [ ] Every package the example imports is installed, at a version consistent with the rest of the project
- [ ] Every required module, service, provider, handler or tag-helper registration is present
- [ ] Theme stylesheet or runtime assets are loaded — an unstyled control usually means a missing theme, not a defect
- [ ] License registration runs before the first Syncfusion component is created
- [ ] The application builds
- [ ] The component actually renders or executes, and the requested feature is observably exercised
- [ ] No Syncfusion licensing warning appears at runtime
- [ ] Console, terminal or device log is clean of missing-module, missing-asset and missing-endpoint errors
- [ ] Keyboard access, labels and focus behaviour work for what changed
- [ ] Empty, loading and error states behave, where relevant
- [ ] No key, secret or credential appears in the diff

If runtime verification is impossible in your environment, say so plainly and give the user a short
manual check. Do not describe unverified output as working.

## 8. Known failure modes for Flutter

These are the mistakes agents make most often on this platform. Check them first.

- Pass the key with `--dart-define=SYNCFUSION_LICENSE_KEY=...` at build time rather than committing it, since a Flutter app ships its source constants to the client.
- `syncfusion_flutter_core` is a separate dependency and is where license registration lives.
- Syncfusion Flutter package versions track Essential Studio, not Flutter's own versioning. Pin them together across the app.
- There is no MCP server for Flutter. Rely on the skill pack and the documentation; do not attempt to configure one.

Troubleshooting order when a Flutter Syncfusion implementation fails:

1. Framework and Syncfusion package version compatibility
2. Missing package, peer dependency, module, service, provider, handler or import
3. Theme CSS, fonts, scripts, static assets, or a required server-side endpoint
4. Data shape, identifiers, date and number parsing, async lifecycle
5. Feature-specific configuration in the installed component skill
6. Current official documentation, or an MCP lookup
7. A minimal reproduction with unrelated application code removed

Preserve the original error text. Distinguish a product defect from an integration or configuration
issue. If a minimal reproduction still fails against documented behaviour, that is a support case:
https://support.syncfusion.com/

## 9. Next

| Need | Go to |
| --- | --- |
| Full documentation | https://help.syncfusion.com/flutter/introduction/overview |
| Every skill in this pack | https://ai.syncfusion.com/flutter/inventory.txt |
| Editor and viewer SDK skills | filter `inventory.txt` by `pdf-viewer-sdk-skills` (no Flutter DOCX Editor or Spreadsheet Editor skill is published) |
| Skill catalog across all 18 packs | https://ai.syncfusion.com/skills/catalog.md |
| Licensing and trust boundaries | https://ai.syncfusion.com/licensing.md |
| MCP configuration | https://ai.syncfusion.com/mcp/llms.txt |
| Project scaffolding from the CLI | https://ai.syncfusion.com/cli.md |
| Another platform | https://ai.syncfusion.com/llms.txt |
| Support | https://support.syncfusion.com/ |