Skip to content

docs(plugin-form): document FormFieldTab.visibleWhen and its support boundary - #6628

Merged
os-sales merged 2 commits into
mainfrom
claude/issue-6237-tabbed-docs-and-sibling-measurement
Aug 28, 2026
Merged

docs(plugin-form): document FormFieldTab.visibleWhen and its support boundary#6628
os-sales merged 2 commits into
mainfrom
claude/issue-6237-tabbed-docs-and-sibling-measurement

Conversation

@os-sales

@os-salesos-sales commented Aug 28, 2026

Copy link
Copy Markdown
Collaborator

Part of #6237 — the docs half of round 2 only. The two renderer arms (TabbedForm sections, WizardForm steps) stay open on that card pending a ruling; #6237 remains open and is deliberately not closed by this PR.

Session: session_01CRJge11jso9TpXRWFt1Z49 (durable copy — footer form degrades on edit).

What this documents

FormFieldTab.visibleWhen landed in PR #6619 (renderer evaluation + ModalForm tabbed synthesis) as a published, declared key with nothing telling an author it exists. This PR adds a "Conditional tabs" subsection in TWO places — content/docs/plugins/plugin-form.mdx, and (second commit, PM order widening the fence by exactly this one file) its twin section in packages/plugin-form/README.md, which ships to npm and was documenting a feature-less version of the key:

  • What it gates: both the tab trigger and its panel — a hidden tab leaves the strip entirely.
  • Vocabulary: the same CEL predicate slot as field rules (string or dialect/source object), canonical engine, host predicate scope, fail-open.
  • The ruled submit semantics (maintainer, 2026-08-27), stated loudly because they are counter-intuitive: a hidden tab's values still submit; its fields skip client-side validation; the server-side contract is the loud floor; stale errors clear on a verdict flip.
  • Selection and engagement mechanics: derived re-selection over visible tabs; engagement judged on DECLARED tabs.
  • A support table naming which authoring surfaces carry the predicate todayfieldTabs and ModalForm's tabbed contentLayout: Yes; TabbedForm sections and WizardForm steps: No, deliberately (objectui#6111), until each surface enforces it. Both copies carry the No rows. The content/docs wizard section also gains one sentence making explicit that its "conditional rules are respected" claim is about the FIELDS' rules, not a step-level predicate.

The two No rows are the guard this card family exists for: both pages now state the boundary instead of letting a reader infer that a section predicate works in every layout.

Verification (at 10c73cf, the head of this branch — two commits, clean tree; every verdict below re-run at this head)

  • check:doc-fences — exit 0, own verdict: "every TypeScript block in 223 document(s) is fenced ts/tsx/typescript … No unknown fence spelling hides one."
  • check:doc-types — exit 0, own verdict: "Every documented component type is registered."
  • docs:check-links — exit 0, "Links are valid across 17 scan roots." That gate strips fragments (anchors out of its scope, stated at scripts/check-doc-links.mjs:800-832), so the one intra-page anchor (content/docs only; the README mirror adds no links) was verified against the repo's own github-slugger@2.0.0: computed slug conditional-tabs-formfieldtabvisiblewhen is byte-identical to the link written.
  • check:doc-snippets — NOT run locally (needs the 21-package built dist closure); declared narrowing: its population is ts/tsx/typescript fence bodies of COVERED documents. The content/docs diff adds/removes zero fence lines (git diff 38a123cac..HEAD -- content/docs/ | grep -c '^[+-]```' reads 0; positive control in the same query shape reads 2 on fence-touching commits 7fdf74e and 546ddf7). The README's one in-fence line lands in packages/plugin-form/README.md, which is declared UNGATED in the gate's own ledger (stale-entry rules fire only on file-missing or no-ts-blocks, neither moved). CI's doc-snippet-types.yml builds and runs the real thing.
  • check:readme-exports — NOT MEASURED locally: exit 1 with every finding "type entry ./dist/index.d.ts is not on disk — run pnpm build first" across 36 unbuilt packages (378 self-imports unjudgeable, tree-state, none a verdict about this diff). This diff cannot move it: the README edit adds ZERO import lines (git show 10c73cf9 -- packages/plugin-form/README.md | grep -c '^+.*import' reads 0; positive control: commit 062943f reads 10 in the same query shape), and all 54 pre-existing plugin-form rows are the same unbuilt-dist class. CI builds before judging.
  • check:changeset-presence — exit 0 at the new head, own verdict: "No source of a released package changed in this range, so no changeset is owed." (2 files changed, 0 published source; README is not under src/.)
  • check:control-bytes — exit 0, "OK (scanned 5485 tracked text file(s))."
  • Vitest, repo-root invocation (root config, invocation guard active): at eeaa6f1 the content/docs reader set ran green — Test Files 129 passed (129), Tests 4568 passed (4568). At 10c73cf the README-reader superset (all of scripts/ plus every test file outside it whose text mentions README — 30 files, grep-enumerated over every test glob) is queued behind a long-running full-suite holder on the shared verify lock; its verdict lands in the report on The tabbed modal arm (ModalFormcontentLayout: 'tabbed') cannot carry a section visibleWhen at all — FormFieldTab declares no predicate slot #6237 (the report-at-draft protocol: gate states are recorded honestly, in_progress included). Narrowing rationale unchanged: the diff is two documentation files no package source imports; CI shards run the whole repo on this PR.

Reported on the card

The read-only measurement of the TabbedForm and WizardForm arms (the other half of this round's scope) is posted as the structured report on #6237 — evidence for the ruling those arms wait on. Q1/Q2 from that report are with the decision box; nothing from either is implemented here.

Generated by Claude Code

…boundary
Part of #6237. The key landed in PR #6619 (renderer + ModalForm tabbed
synthesis) with nothing telling an author it exists. Documents what it
gates (trigger AND panel), the expression vocabulary (same CEL slot as
field rules, fail-open), and the ruled submit semantics: a hidden tab's
values still submit, its fields skip client-side validation, the server
is the loud floor, stale errors clear.
States explicitly which authoring surfaces carry the predicate today —
`fieldTabs` and ModalForm's tabbed contentLayout — and that
TabbedForm sections and WizardForm steps do NOT: #6111 deliberately
left those undeclared until each surface enforces it.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CRJge11jso9TpXRWFt1Z49
…ckage README
Part of #6237, round-2 fence widened by exactly this one file (PM order on
the report's Q3): the README's twin "Tabbed field layout (fieldTabs)"
section documented a feature-less version of a key that now exists. Mirrors
the content/docs subsection verbatim in substance — gating (trigger AND
panel), vocabulary, ruled submit semantics, selection/engagement mechanics,
and the support table whose No rows keep TabbedForm sections and WizardForm
steps explicitly undocumented-as-working.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CRJge11jso9TpXRWFt1Z49
@github-actions

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

MetricValueBudget
Eager closure (gzip, 52 chunks)3237.3 KB3266.6 KB
Main entry chunk (gzip)157.3 KB350 KB
Entry fileindex-DZpGdrcH.js
StatusPASS

The eager closure is every chunk the entry reaches through static imports — what the browser fetches and parses before the app renders. The entry chunk on its own is a small fraction of it.


📦 Bundle Size Report

PackageSizeGzipped
app-shell (consoleActionDispatch.js)0.20KB0.19KB
app-shell (index.js)11.89KB4.50KB
app-shell (runtime-config.js)20.61KB7.35KB
app-shell (types.js)0.01KB0.04KB
app-shell (urlParams.js)10.06KB3.86KB
auth (ActiveOrganizationStorage.js)25.05KB9.16KB
auth (AuthContext.js)0.31KB0.24KB
auth (AuthGuard.js)2.07KB1.00KB
auth (AuthProvider.js)40.18KB10.59KB
auth (AuthShell.js)3.49KB1.40KB
auth (ForgotPasswordForm.js)12.21KB3.45KB
auth (LoginForm.js)18.15KB5.39KB
auth (PreviewBanner.js)0.90KB0.50KB
auth (RegisterForm.js)6.65KB2.22KB
auth (SocialSignInButtons.js)9.61KB3.89KB
auth (UserMenu.js)3.41KB1.23KB
auth (auth-gate-events.js)1.29KB0.66KB
auth (authStyles.js)5.04KB1.72KB
auth (createAuthClient.js)40.21KB10.80KB
auth (createAuthenticatedFetch.js)8.46KB3.43KB
auth (index.js)3.19KB1.44KB
auth (invitation-status.js)1.22KB0.70KB
auth (org-roles.js)6.66KB2.78KB
auth (phone-identifier.js)1.11KB0.66KB
auth (types.js)0.59KB0.35KB
auth (useAuth.js)5.30KB1.02KB
auth (useWorkspaceAdminStatus.js)5.13KB2.35KB
collaboration (CommentThread.js)26.08KB7.56KB
collaboration (LiveCursors.js)3.17KB1.27KB
collaboration (PresenceAvatars.js)6.49KB2.64KB
collaboration (PresenceProvider.js)2.79KB1.13KB
collaboration (index.js)1.68KB0.73KB
collaboration (useCollaborationTranslation.js)6.05KB2.52KB
collaboration (useCommentSearch.js)1.98KB0.88KB
collaboration (useConflictResolution.js)7.75KB1.86KB
collaboration (useMentionNotifications.js)1.81KB0.68KB
collaboration (usePresence.js)6.33KB1.84KB
collaboration (useRealtimeSubscription.js)7.91KB2.01KB
components (index.js)507.69KB114.99KB
core (index.js)5.30KB2.13KB
create-plugin (index.js)10.08KB3.26KB
data-objectstack (index.js)173.10KB47.96KB
fields (index.js)238.89KB60.02KB
i18n (LocalizationContext.js)1.76KB0.96KB
i18n (currency.js)1.22KB0.64KB
i18n (fallbackInterpolation.js)6.25KB2.77KB
i18n (i18n.js)4.28KB1.75KB
i18n (index.js)3.44KB1.39KB
i18n (pickLocalized.js)7.62KB3.26KB
i18n (provider.js)26.89KB9.04KB
i18n (useDisplayLocale.js)2.85KB1.45KB
i18n (useObjectLabel.js)33.40KB8.71KB
i18n (useSafeTranslation.js)5.60KB2.33KB
layout (index.js)38.95KB10.97KB
mobile (MobileProvider.js)0.92KB0.49KB
mobile (ResponsiveContainer.js)0.94KB0.38KB
mobile (breakpoints.js)1.51KB0.70KB
mobile (createOfflineDataSource.js)5.61KB1.75KB
mobile (index.js)1.55KB0.62KB
mobile (offlineQueue.js)3.91KB1.35KB
mobile (pwa.js)0.97KB0.49KB
mobile (serviceWorker.js)1.48KB0.62KB
mobile (serviceWorkerSource.js)3.41KB1.48KB
mobile (useBreakpoint.js)1.54KB0.65KB
mobile (useGesture.js)6.96KB1.98KB
mobile (useOfflineSync.js)1.99KB0.72KB
mobile (usePullToRefresh.js)2.53KB0.85KB
mobile (useResponsive.js)0.72KB0.42KB
mobile (useResponsiveConfig.js)1.37KB0.63KB
mobile (useSpecGesture.js)4.32KB1.64KB
mobile (useTouchTarget.js)1.01KB0.54KB
permissions (MePermissionsProvider.js)9.53KB3.38KB
permissions (PermissionContext.js)0.31KB0.25KB
permissions (PermissionGuard.js)0.89KB0.45KB
permissions (PermissionProvider.js)4.64KB1.50KB
permissions (evaluator.js)5.12KB1.74KB
permissions (index.js)0.93KB0.41KB
permissions (store.js)0.91KB0.42KB
permissions (useFieldPermissions.js)1.28KB0.53KB
permissions (usePermissions.js)1.93KB0.88KB
plugin-ai (index.js)15.75KB3.80KB
plugin-calendar (index.js)46.85KB12.89KB
plugin-charts (index.js)64.66KB18.32KB
plugin-chatbot (index.js)190.33KB45.10KB
plugin-dashboard (index.js)133.46KB34.48KB
plugin-designer (index.js)212.80KB43.15KB
plugin-detail (index.js)245.29KB62.39KB
plugin-editor (index.js)2.46KB1.10KB
plugin-form (index.js)132.01KB32.23KB
plugin-gantt (index.js)165.16KB40.33KB
plugin-grid (index.js)201.66KB54.57KB
plugin-kanban (index.js)53.11KB14.62KB
plugin-list (index.js)112.86KB27.54KB
plugin-map (index.js)20.09KB6.62KB
plugin-markdown (index.js)13.72KB4.69KB
plugin-report (index.js)43.51KB11.94KB
plugin-timeline (index.js)26.72KB7.71KB
plugin-tree (index.js)9.26KB3.13KB
plugin-view (index.js)85.87KB21.12KB
providers (DataSourceProvider.js)0.75KB0.39KB
providers (MetadataProvider.js)1.37KB0.59KB
providers (ThemeProvider.js)1.90KB0.85KB
providers (UploadProvider.js)11.66KB3.50KB
providers (index.js)0.45KB0.23KB
providers (types.js)0.01KB0.04KB
react-runtime (index.js)5.62KB2.34KB
react (LazyPluginLoader.js)4.47KB1.63KB
react (SchemaRenderer.js)65.97KB21.98KB
react (data-invalidation.js)5.05KB2.08KB
react (index.js)2.44KB1.21KB
react (schema-input.js)2.32KB1.24KB
react (spec-input.js)0.20KB0.18KB
sdui-parser (codegen.js)5.41KB2.34KB
sdui-parser (dashboard-widget-options.js)3.08KB1.30KB
sdui-parser (index.js)4.93KB2.24KB
sdui-parser (input-type.js)2.84KB1.40KB
sdui-parser (parse.js)12.13KB3.65KB
sdui-parser (provenance.js)3.66KB1.82KB
sdui-parser (types.js)0.28KB0.23KB
sdui-parser (validate.js)9.30KB3.22KB
types (ai.js)0.20KB0.17KB
types (api-types.js)0.20KB0.18KB
types (app.js)2.87KB0.99KB
types (base.js)0.20KB0.18KB
types (blocks.js)0.20KB0.18KB
types (complex.js)2.74KB1.41KB
types (crud.js)0.20KB0.18KB
types (dashboard-filter-alias.js)6.23KB2.74KB
types (data-display.js)3.75KB1.85KB
types (data-protocol.js)0.20KB0.19KB
types (data.js)0.20KB0.18KB
types (designer.js)1.85KB0.85KB
types (disclosure.js)0.20KB0.18KB
types (error-code.js)1.54KB0.88KB
types (feedback.js)0.20KB0.18KB
types (field-types.js)0.20KB0.18KB
types (form.js)0.20KB0.18KB
types (http-inflight.js)8.87KB3.73KB
types (http-retry.js)4.32KB2.02KB
types (icon-key-migration.js)4.26KB1.63KB
types (index.js)4.72KB2.24KB
types (layout.js)0.20KB0.18KB
types (managed-by.js)0.19KB0.18KB
types (mobile.js)2.59KB1.31KB
types (navigation.js)0.20KB0.18KB
types (objectql.js)0.20KB0.18KB
types (overlay.js)0.20KB0.18KB
types (permissions.js)0.20KB0.18KB
types (plugin-scope.js)0.20KB0.18KB
types (record-components.js)0.20KB0.19KB
types (record-semantics.js)1.28KB0.67KB
types (registry.js)0.20KB0.18KB
types (reports.js)0.20KB0.18KB
types (spec-report.js)5.05KB1.93KB
types (spec-ui-namespace.js)0.20KB0.19KB
types (system-fields.js)3.33KB1.54KB
types (theme.js)6.28KB2.87KB
types (ui-action.js)3.40KB1.71KB
types (views.js)0.20KB0.18KB
types (widget.js)0.20KB0.18KB

Size Limits

  • ✅ Core packages should be < 50KB gzipped
  • ✅ Component packages should be < 100KB gzipped
  • ⚠️ Plugin packages should be < 150KB gzipped

@os-sales
os-sales marked this pull request as ready for review August 28, 2026 05:20
@os-sales
os-sales added this pull request to the merge queueAug 28, 2026
Merged via the queue into main with commit efdc6c6Aug 28, 2026
27 checks passed
@os-sales
os-sales deleted the claude/issue-6237-tabbed-docs-and-sibling-measurement branch August 28, 2026 05:32
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationplugin

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@os-sales@claude