Skip to content

Use with AI ​

These docs are built to be read by AI assistants and coding agents as well as people. Point your agent at the right source and it will write correct vue-json-excel3 code instead of guessing from outdated examples.

Machine-readable docs ​

URLWhat it is
/llms.txtA short index of every page with its title and description, following the llms.txt convention. Good for agents that fetch pages on demand.
/llms-full.txtThe complete documentation in one Markdown file. Best for pasting into a chat or loading as context.
Any page + .mdAppend .md to any docs URL to get that page as clean Markdown, for example /props.md or /using-callbacks-examples.md.

The Markdown versions contain the full source of every live demo and plain tables for the props, without interactive widgets.

Copy page / Ask AI ​

Every docs page has a Copy page button and an Ask AI menu at the top:

  • Copy page copies the current page as Markdown, ready to paste into any assistant.
  • Ask AI opens your assistant of choice (ChatGPT, Claude, Grok, Perplexity, and others) with a prompt that references the page. For DeepSeek and Gemini, which do not accept a prefilled prompt from a link, the prompt is copied to your clipboard and the site opens in a new tab: just paste.

Claude Code ​

Add this to your project's CLAUDE.md:

md
## vue-json-excel3

This project uses vue-json-excel3 to download JSON as Excel / CSV files.
When working with it, fetch https://vue-json-excel3.netlify.app/llms-full.txt
for the current API instead of relying on memory. Import it as
`import JsonExcel from 'vue-json-excel3'`.

Optional: a Claude Code skill ​

For on-demand loading, create .claude/skills/vue-json-excel3/SKILL.md:

md
---
name: vue-json-excel3
description: Use when adding, configuring or debugging Excel / CSV downloads with the vue-json-excel3 Vue 3 component (JsonExcel, download-excel, xls, xlsx, csv export, fields, cell formats).
---

# vue-json-excel3

Full docs: https://vue-json-excel3.netlify.app/llms-full.txt (fetch when unsure).

Rules:
- Import: `import JsonExcel from 'vue-json-excel3'`.
  Global: `app.component('downloadExcel', JsonExcel)`.
- It is a wrapper: put any content (text, icon, button) in the default slot;
  clicking it builds the file in the browser and downloads it.
- `type`: 'xls' (default, HTML-based, Excel shows a format warning),
  'xlsx' (native workbook, no warning) or 'csv'. Set `name` with a matching extension.
- `data`: array of row objects. `fields`: { 'Column label': 'path.to.value' }.
  Nested paths work. Without `fields`, the keys of the first row are used.
  Use `export-fields` when another library already uses a `fields` attribute.
- Field callbacks: { field: 'path', callback: (value) => ... }.
  `field` can point at a nested object; omit `field` to receive the whole row.
- Load data on click with `:fetch="async () => rows"` (only when no `data`),
  plus `before-generate` / `before-finish` for loading state.
- xlsx only: `:formats="{ B: '0.00%' }"` and `:widths="{ A: 20 }"`, keyed by column letter.
- Other props: header, footer, per-columns-headers, worksheet, default-value, meta,
  escape-csv (default true), stringify-long-num, rtl, debounce (500 ms).
- `emit-blob` + `@blob` returns the file as a Blob instead of downloading it.
- SSR (Nuxt/VitePress): render it inside `<ClientOnly>`.

Cursor, GitHub Copilot, OpenAI Codex, Windsurf ​

Most coding agents read an AGENTS.md file at the repository root (Copilot also reads .github/copilot-instructions.md, Windsurf reads .windsurfrules). Add:

md
## vue-json-excel3

- Docs for agents: https://vue-json-excel3.netlify.app/llms-full.txt
- Per-page Markdown: append `.md` to any https://vue-json-excel3.netlify.app URL.
- Import with `import JsonExcel from 'vue-json-excel3'`; wrap a button with it and
  pass `:data`, `:fields`, `type` ('xls' | 'xlsx' | 'csv') and `name`.
- Prefer `type="xlsx"` for Excel files; `formats` / `widths` only work with xlsx.

Cursor @Docs: open Cursor Settings → Indexing & Docs → Add Doc and enter https://vue-json-excel3.netlify.app/llms-full.txt. Then reference it in chat with @Docs vue-json-excel3.

ChatGPT, Claude.ai, Grok, DeepSeek, Gemini, Perplexity ​

In any chat assistant:

  1. Paste the URL https://vue-json-excel3.netlify.app/llms-full.txt and ask it to read it (assistants with browsing), or
  2. Open /llms-full.txt, copy everything and paste it into the chat (works everywhere), or
  3. Use the Ask AI menu on the page you are reading. For DeepSeek and Gemini the prompt is copied to your clipboard; paste it into the chat.

Prompt recipes ​

Copy and adapt these prompts:

Export a table to Excel

Using vue-json-excel3 (docs: https://vue-json-excel3.netlify.app/llms-full.txt), add an "Export to Excel" button to my <UsersTable> component that downloads the current rows as users.xlsx, with columns "Name", "Email" and "Signed up" (formatted as yyyy-mm-dd), and sensible column widths.

Fetch from an API on click

Using vue-json-excel3, create a "Download report" button that calls GET /api/report only when clicked (use the fetch prop), shows a spinner with before-generate / before-finish, and downloads the result as CSV.

Format money and percentages

Following https://vue-json-excel3.netlify.app/cell-format-xlsx-examples.md, export my orders array as xlsx with the total column formatted as USD currency and the discount column as a percentage.

Nuxt integration

Add vue-json-excel3 to my Nuxt app: register it in a client-only plugin, render the download button inside <ClientOnly>, and export the data from a useFetch call.

Released under the MIT License.