Text Editor - LLMs
Use the Vue Text Editor documentation as structured context for AI assistants and code-generation tools.
#Overview
PrimeUI publishes the Vue TextEditor docs as markdown-friendly endpoints. Use them when an assistant needs the current TextEditor API, parts, setup steps, demos, and reference pages without scraping the rendered site.
Good TextEditor prompts give the assistant three things: the setup page, the architecture page, and the exact feature page for the task. Add API or reference pages only when the task needs a command signature, state flag, context accessor, or data attribute.
#Usage
https://vue.primeuipro.dev/llms.txt
https://vue.primeuipro.dev/llms-full.txt
https://vue.primeuipro.dev/raw/docs/texteditor.md/llms.txt is the compact documentation map. /llms-full.txt contains the full documentation bundle. /raw/docs/<path>.md returns one page as clean markdown, which is useful when a tool should focus on a single TextEditor topic.
Use /llms.txt for discovery, /raw/docs/... for focused work, and /llms-full.txt when the assistant needs broad context across modes, features, demos, and references.
#TextEditor Pages
Point the assistant at the TextEditor index first, then add the exact page that matches the task.
https://vue.primeuipro.dev/raw/docs/texteditor.md
https://vue.primeuipro.dev/raw/docs/texteditor/getting-started/architecture.md
https://vue.primeuipro.dev/raw/docs/texteditor/getting-started/setup.md
https://vue.primeuipro.dev/raw/docs/texteditor/toolbar/static.md
https://vue.primeuipro.dev/raw/docs/texteditor/block/index.md
https://vue.primeuipro.dev/raw/docs/texteditor/reference/api.mdUse focused pages for implementation work. Setup covers installation, style imports, and the CLI for copying PrimeUI or Tailwind TextEditor UI parts. Architecture covers the runtime model, editing modes, the bound data, template-driven parts, and the plugin system.
#Context Packs
Use a small pack instead of the full docs when the task is narrow.
| Task | Include |
|---|---|
| First install | Setup, Architecture, Theming, and Static Toolbar. |
| Build a classic editor | Architecture, Static Toolbar, Context Toolbar, and the relevant format and structure pages. |
| Build a block editor | Architecture, Block Mode, Block Menu, and Slash Commands. |
| Add inserted content | Architecture plus Link, Image, Document, Table, or Mention for the content type the task needs. |
| Customize a part's UI | The matching feature page, the API reference for its context accessor, and Data Attributes in Theming. |
| Add a plugin | Plugins Architecture plus AI Integration, Translate, or Code Highlight for the plugin the task needs. |
| Explain generated demo code | The docs page that owns the demo, plus /llms-full.txt when helper components or shared demo data are needed. |
#Demo Source
TextEditor demo source is included through the generated documentation data. When an assistant needs the code behind a rendered example, reference the page that owns the demo instead of asking it to infer behavior from screenshots.
https://vue.primeuipro.dev/raw/docs/texteditor/content/mention.md
https://vue.primeuipro.dev/raw/docs/texteditor/content/table.md
https://vue.primeuipro.dev/raw/docs/texteditor/toolbar/static.mdThe raw markdown keeps demo names in place, and /llms-full.txt expands TextEditor demo content during the documentation build.
Demo source can include helper-component tabs and shared data excerpts. Treat those as example app code, not required TextEditor runtime code. The reusable contract is the TextEditor parts, props, commands, state, context accessors, and style or data-attribute APIs documented on the page.
#Guardrails
Give the assistant explicit constraints when it writes TextEditor code.
Use @primeui/vue-texteditor as the source of TextEditor runtime parts.
Use the TextEditor parts and context accessors shown in the docs.
Keep Usage snippets headless unless the task is specifically about installed UI parts.
Use only documented TextEditor parts, props, commands, state flags, context accessors, and UI-part imports.
Read commands and state from useTextEditorContext() instead of drilling props.
Keep the runtime responsible for the document model, command dispatch, history, selection, and accessibility.If the assistant needs UI parts, point it to Setup first. Setup explains PrimeUI and Tailwind CLI installs, style imports, and when to write manual parts.
#Prompting Pattern
Give the assistant the Vue TextEditor scope, the page links, and the expected output.
Use the Vue TextEditor docs below as the source of truth.
Read commands and state from the documented context accessors only when the task asks for custom UI.
Use only the APIs shown on the linked TextEditor pages.
Context:
- https://vue.primeuipro.dev/raw/docs/texteditor/getting-started/architecture.md
- https://vue.primeuipro.dev/raw/docs/texteditor/getting-started/setup.md
- https://vue.primeuipro.dev/raw/docs/texteditor/toolbar/static.md
Task:
Write a Vue TextEditor with a custom toolbar that toggles bold, italic, headings, and lists.For customization tasks, add the relevant feature page and ask for the smallest working override first.
Use the Vue TextEditor docs below.
Start with a minimal override, then show the production version.
Keep runtime-owned behavior intact.
Context:
- https://vue.primeuipro.dev/raw/docs/texteditor/content/mention.md
- https://vue.primeuipro.dev/raw/docs/texteditor/reference/api.md
Task:
Create a custom mention list that filters users by name and inserts the selected handle.#Output Checklist
Ask the assistant to return:
- imports from
@primeui/vue-texteditor; - the
TextEditor.Rootstructure with only the required props; - the parts and toolbar widgets it uses;
- the context accessor each widget reads, such as
useTextEditorContext()oruseMentionMenuContext(); - style imports or UI-part imports when setup is part of the task;
- a note about which TextEditor behavior remains runtime-owned.