From 879be5974f0b9fbdf4cffec31808f4588c650541 Mon Sep 17 00:00:00 2001 From: Tony Wu Date: Thu, 5 Nov 2026 20:57:56 +0000 Subject: [PATCH] fix(docs): align Vue SFC loading and guarded navigation --- docs/API/v3/frameworks/overview.md | 6 +- docs/API/v3/frameworks/vue.md | 112 +++++++++++++++--- docs/CLAUDE.md | 2 + .../__tests__/vue-routing-example.test.mjs | 86 ++++++++++++++ docs/package-lock.json | 26 +++- docs/package.json | 3 +- 6 files changed, 212 insertions(+), 23 deletions(-) create mode 100644 docs/bin/__tests__/vue-routing-example.test.mjs diff --git a/docs/API/v3/frameworks/overview.md b/docs/API/v3/frameworks/overview.md index 22e41904..9a645909 100644 --- a/docs/API/v3/frameworks/overview.md +++ b/docs/API/v3/frameworks/overview.md @@ -11,7 +11,7 @@ deprecated: false V3 apps run **without a build step**. Source files are uploaded to the media library and fetched at runtime via `Fliplet.Media.getContents`. Dependencies are resolved through `Fliplet.require.lazy`, not `import`. This changes which framework features work and which quietly fail. -Fetch the per-framework doc (`v3-framework-vue`, `v3-framework-react`, etc.) before scaffolding. This doc is for picking. +Read the [Vue](vue), [React](react), [Alpine](alpine) or [vanilla JS](vanilla) guide before scaffolding with your chosen framework. This page helps you choose. ## The runtime constraints (apply to every framework) @@ -39,11 +39,11 @@ Default order when the user hasn't expressed a preference: 1. **One screen, no forms**: vanilla JS 2. **Multi-screen, reactive state**: Vue 3 — best balance of no-build ergonomics and features 3. **Form-heavy single-page CRUD**: Alpine.js -4. **User explicitly asked for React**: React, via `htm` or `React.createElement` (see `v3-framework-react`) +4. **User explicitly asked for React**: React, via `htm` or `React.createElement` (see the [React guide](react)) ## What to fetch next -After picking, call `get_fliplet_docs('v3-framework-')` for the specific constraints. Every per-framework doc covers: loading the framework, features that need a build step (and what to do instead), wiring to `Fliplet.Router`, binding `Fliplet.Media.authenticate`, common errors, and DO/DON'T. +After picking, fetch the matching guide with `fetch_fliplet_doc({ path: 'API/v3/frameworks/vue.md' })` (or the `react`, `alpine` or `vanilla` path) for its setup and constraints. Every per-framework doc covers: loading the framework, features that need a build step (and what to do instead), wiring to `Fliplet.Router`, binding `Fliplet.Media.authenticate`, common errors, and DO/DON'T. ## Related diff --git a/docs/API/v3/frameworks/vue.md b/docs/API/v3/frameworks/vue.md index d17e0655..b7e75e0b 100644 --- a/docs/API/v3/frameworks/vue.md +++ b/docs/API/v3/frameworks/vue.md @@ -9,54 +9,130 @@ deprecated: false # V3 Vue apps -Vue 3 is the best-supported multi-screen framework in V3 because a runtime-compiler build exists — meaning `template` strings compile in the browser without a toolchain. The traps below come from using the wrong Vue build, or reaching for features that assume Vite/webpack. +V3 Vue apps use the browser runtime compiler and Fliplet’s media helpers to load Vue single-file components (SFCs) without a build step. Keep `App.js` as a JavaScript component export and each screen as ordinary `