Weave Code
Filament Docs Laravel Package
tomatophp/filament-docs
Manage documents and contracts in one place with a template builder. Generate docs from templates using the Tiptop editor, add custom variables via facade, filter by template, and print or export as PDF with custom headers, footers, and CSS.
Filament Documents Editor is a Filament plugin for managing documents and contracts in one place. Build reusable templates with the Tiptop Editor, inject dynamic values through a simple facade, and generate finished documents straight from your templates.
- Generate documents from templates
- Add custom variables via facade
- Print or export documents as PDF
- Filter documents by template
- Relation managers plus custom print header, footer, and CSS
Frequently asked questions about Filament Docs
- What Filament and Laravel versions does tomatophp/filament-docs support?
- Version 5.0.0 requires Filament v5 and Laravel 12 or 13, so it is a narrow, current-only support window. Teams still on Filament v3 must stay on the separately maintained v3 branch of the package. Filament v4 currently appears to have no supported line, so confirm the intended upgrade path with the maintainer before planning an adoption on v4.
- How do I install and set up filament-docs in a Laravel app?
- Install it with Composer, then run the install command that ships with the package, which handles guided setup such as publishing config, migrations, and assets before you register the plugin in your Filament panel provider. Because a guided installer writes files into an existing application, verify exactly what it writes and whether it is idempotent and safe to re-run. Run your migrations afterwards and check that document and template tables appear as expected.
- Does filament-docs still use Tiptap, or Filament's RichEditor?
- As of v5.0.0 the separate Tiptap integration was removed in favour of Filament's built-in RichEditor, which is the biggest architectural change in the release. Template and document authoring now use the same editor stack as the rest of your admin panel, so there is no extra Vue or React asset pipeline to configure on Filament v5. Some older README text and screenshots still reference the former editor, so treat the release notes as the source of truth.
- How do I inject custom variables into a document template?
- The package exposes a facade for registering custom variables, which you then place inside a template and get replaced when a document is generated. Templates remain reusable, so contracts, invoices, and reports can share one structure with different variable values. Because the facade is a service-container binding, keep variable registration in a dedicated service provider to avoid tight coupling across your app.
- Can I print documents or export them as PDF in filament-docs?
- Yes. Each document can be printed from a dedicated print page or exported as a PDF, and the rendering path is HTML, then sanitization, then the bundled print stylesheet, then the PDF library. PDF output still depends on an underlying library such as DomPDF or Snappy, so run your usual compatibility and font tests before relying on it in production. On-demand rendering is resource intensive at volume, so consider queuing large batches.
- Is template HTML sanitized in filament-docs, and will my existing markup change?
- HTML is now sanitized both on save and on render, which is a genuine security improvement but also a behaviour change rather than a pure bug fix. Markup the sanitizer disallows, such as inline styles, custom classes, embedded fonts, iframes, and data attributes, will be silently stripped. Audit your existing templates after upgrading and ask the maintainer whether the allowlist is configurable if you depend on that markup.
- Can I customize the print header, footer, and CSS?
- Yes, the package supports custom print headers, footers, and print CSS, and v5 replaced the old Tailwind CDN with a bundled print stylesheet. That removes an external network dependency at print time, which matters for air-gapped and regulated environments. The trade-off is that you inherit the package's print styling, so custom branding usually needs an override strategy you should plan for up front.
- Is Filament v4 supported by filament-docs, or do I need to upgrade to v5?
- Only Filament v5 is supported by the 5.x line, with Filament v3 covered by the legacy branch. If you are on Filament v4 you are effectively on an unsupported island, which is the single biggest feasibility question for adoption. Confirm with the maintainer whether v4 was skipped deliberately and whether an upgrade to Filament v5 or a hold on the v3 branch is the intended route.
- Is filament-docs tested, and does it ship model factories?
- Yes. The release includes a test suite covering the resources, the print page, actions, the relation manager, and the install command, plus shipped model factories. That materially lowers integration risk and speeds up writing your own feature tests around document generation. It also means you can seed templates and documents in tests without hand-rolling fixtures.
- What breaking changes should I expect when upgrading filament-docs to v5.0.0?
- This is a major version bump, so expect breaking changes in template storage format, editor integration, config keys, and possibly namespaces. The editor swap from Tiptap to RichEditor means any templates authored under the old editor need review or re-authoring, since the HTML the two editors produce is not guaranteed to be interchangeable. Plan a migration pass that covers both template content and any custom print CSS or overrides you maintain.
Weaver
How can I help you explore Laravel packages today?