Skip to content

feat(react,types): read canonical visibleWhen in renderers (ADR-0089)#2490

Merged
os-zhuang merged 1 commit into
mainfrom
claude/adr-0089-visible-when-renderer
Jul 14, 2026
Merged

feat(react,types): read canonical visibleWhen in renderers (ADR-0089)#2490
os-zhuang merged 1 commit into
mainfrom
claude/adr-0089-visible-when-renderer

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

Companion to framework ADR-0089 — implements the "Renderer reads" task, objectstack-ai/framework#2904. Pairs with the spec-side PR objectstack-ai/framework#2900.

Why

@objectstack/spec now unifies conditional visibility under a single canonical key, visibleWhen, and folds the deprecated visibleOn (view form section/field) / visibility (page component) aliases into it at parse. Any metadata parsed through the spec schemas therefore exposes only visibleWhen. The ObjectUI renderers previously read visibleOn / visibility, so a normalized page component would have rendered unconditionally. This makes the renderers read the canonical key.

Changes

  • Page renderer (SchemaRenderer) — evaluates visibleWhen first (show-when-truthy), then the deprecated visibleOn / visibility as a defensive read for raw / un-normalized metadata. visibleWhen is stripped from DOM props.
  • spec→node bridges — the page bridge maps a component's visibleWhen ?? visibility onto the node's canonical visibleWhen; the form-view bridge maps a field's visibleWhen ?? visibleOn onto the ObjectForm view-level predicate slot.
  • @object-ui/react FormRenderer — prefers visibleWhen over the visibleOn alias (both the visibility eval and the "has conditional fields" watch guard). ObjectForm / form.tsx already evaluated visibleWhen via resolveFieldRuleState.
  • @object-ui/types — the component base (BaseSchema + base.zod) gains the canonical visibleWhen; visibleOn is marked @deprecated.

Back-compat

Fully back-compat — existing visibleOn / visibility metadata keeps working through the alias reads. No authored metadata needs to change.

Tests

New coverage for the canonical visibleWhen path in SchemaRenderer.expressions.test.tsx (+ deprecated-alias regression) and the page/form bridges (SpecBridge.test.ts). Full suites green: @object-ui/react (5823 passed, 24 network-integration tests skipped), @object-ui/components form (503), @object-ui/types; tsc --noEmit clean across react + types. Includes a minor changeset.

🤖 Generated with Claude Code

https://claude.ai/code/session_017fU25GeYSPKq9eEURsQffF


Generated by Claude Code

`@objectstack/spec` unifies conditional visibility under the canonical key
`visibleWhen`, folding the deprecated `visibleOn` (view form) / `visibility`
(page component) aliases into it at parse. Update ObjectUI to read the
canonical key:

- SchemaRenderer (page): evaluate `visibleWhen` first (show-when-truthy), keep
  `visibleOn`/`visibility` as defensive reads for raw metadata; strip
  `visibleWhen` from DOM props.
- spec-bridge: page bridge maps `visibleWhen ?? visibility` → node `visibleWhen`;
  form-view bridge maps `visibleWhen ?? visibleOn` → the ObjectForm view-level
  predicate slot.
- react FormRenderer: prefer `visibleWhen` over the `visibleOn` alias.
- types: component base (`BaseSchema` / `base.zod`) gains canonical `visibleWhen`;
  `visibleOn` marked `@deprecated`.

Fully back-compat: existing `visibleOn`/`visibility` metadata keeps working via
the alias reads. Addresses objectstack-ai/framework#2904.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017fU25GeYSPKq9eEURsQffF
@vercel

vercel Bot commented Jul 14, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
objectui Ignored Ignored Jul 14, 2026 9:42am

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

Metric Value Budget
Main entry (gzip) 27.5 KB 350 KB
Entry file index-U1wV6Lhm.js
Status PASS

📦 Bundle Size Report

Package Size Gzipped
app-shell (index.js) 7.84KB 2.85KB
app-shell (runtime-config.js) 7.42KB 2.32KB
app-shell (types.js) 0.01KB 0.04KB
app-shell (urlParams.js) 7.57KB 2.97KB
auth (AuthContext.js) 0.31KB 0.24KB
auth (AuthGuard.js) 1.17KB 0.53KB
auth (AuthProvider.js) 21.70KB 4.21KB
auth (AuthShell.js) 3.49KB 1.40KB
auth (ForgotPasswordForm.js) 12.12KB 3.41KB
auth (LoginForm.js) 17.12KB 5.00KB
auth (PreviewBanner.js) 0.90KB 0.50KB
auth (RegisterForm.js) 6.63KB 2.15KB
auth (SocialSignInButtons.js) 9.60KB 3.89KB
auth (UserMenu.js) 3.40KB 1.22KB
auth (auth-gate-events.js) 1.29KB 0.66KB
auth (authStyles.js) 5.04KB 1.72KB
auth (createAuthClient.js) 30.17KB 7.28KB
auth (createAuthenticatedFetch.js) 3.93KB 1.55KB
auth (index.js) 1.83KB 0.79KB
auth (phone-identifier.js) 1.11KB 0.66KB
auth (types.js) 0.59KB 0.35KB
auth (useAuth.js) 4.86KB 0.85KB
auth (useIsWorkspaceAdmin.js) 1.61KB 0.85KB
collaboration (CommentThread.js) 18.38KB 4.49KB
collaboration (LiveCursors.js) 3.17KB 1.27KB
collaboration (PresenceAvatars.js) 3.65KB 1.42KB
collaboration (PresenceProvider.js) 2.42KB 0.96KB
collaboration (index.js) 1.25KB 0.53KB
collaboration (useCommentSearch.js) 1.98KB 0.88KB
collaboration (useConflictResolution.js) 7.75KB 1.86KB
collaboration (useMentionNotifications.js) 1.81KB 0.68KB
collaboration (usePresence.js) 6.33KB 1.84KB
collaboration (useRealtimeSubscription.js) 7.91KB 2.01KB
components (index.js) 441.87KB 95.38KB
core (index.js) 1.65KB 0.59KB
create-plugin (index.js) 9.28KB 2.98KB
data-objectstack (index.js) 113.70KB 28.15KB
fields (index.js) 202.54KB 49.50KB
i18n (LocalizationContext.js) 1.76KB 0.96KB
i18n (currency.js) 1.22KB 0.64KB
i18n (i18n.js) 4.32KB 1.77KB
i18n (index.js) 2.46KB 0.96KB
i18n (pickLocalized.js) 1.31KB 0.67KB
i18n (provider.js) 5.37KB 1.72KB
i18n (useObjectLabel.js) 21.15KB 4.68KB
i18n (useSafeTranslation.js) 2.68KB 0.98KB
layout (index.js) 38.45KB 10.67KB
mobile (MobileProvider.js) 0.92KB 0.49KB
mobile (ResponsiveContainer.js) 0.94KB 0.38KB
mobile (breakpoints.js) 1.51KB 0.70KB
mobile (createOfflineDataSource.js) 5.61KB 1.74KB
mobile (index.js) 1.50KB 0.62KB
mobile (offlineQueue.js) 3.91KB 1.35KB
mobile (pwa.js) 0.97KB 0.49KB
mobile (serviceWorker.js) 1.48KB 0.62KB
mobile (serviceWorkerSource.js) 3.41KB 1.48KB
mobile (useBreakpoint.js) 1.54KB 0.65KB
mobile (useGesture.js) 4.42KB 1.27KB
mobile (useOfflineSync.js) 1.99KB 0.72KB
mobile (usePullToRefresh.js) 2.53KB 0.85KB
mobile (useResponsive.js) 0.71KB 0.42KB
mobile (useResponsiveConfig.js) 1.36KB 0.63KB
mobile (useSpecGesture.js) 1.77KB 0.77KB
mobile (useTouchTarget.js) 1.01KB 0.54KB
permissions (MePermissionsProvider.js) 5.09KB 1.84KB
permissions (PermissionContext.js) 0.31KB 0.25KB
permissions (PermissionGuard.js) 0.89KB 0.45KB
permissions (PermissionProvider.js) 3.46KB 1.03KB
permissions (evaluator.js) 4.00KB 1.23KB
permissions (index.js) 0.91KB 0.41KB
permissions (store.js) 0.91KB 0.42KB
permissions (useFieldPermissions.js) 1.28KB 0.52KB
permissions (usePermissions.js) 1.50KB 0.70KB
plugin-ai (index.js) 15.71KB 3.79KB
plugin-calendar (index.js) 45.12KB 12.34KB
plugin-charts (index.js) 46.31KB 13.06KB
plugin-chatbot (index.js) 176.18KB 42.05KB
plugin-dashboard (index.js) 108.35KB 26.87KB
plugin-designer (index.js) 213.94KB 43.03KB
plugin-detail (index.js) 210.11KB 50.70KB
plugin-editor (index.js) 2.46KB 1.10KB
plugin-form (index.js) 104.26KB 25.24KB
plugin-gantt (index.js) 149.17KB 37.17KB
plugin-grid (index.js) 172.19KB 45.48KB
plugin-kanban (index.js) 48.16KB 12.94KB
plugin-list (index.js) 98.74KB 23.30KB
plugin-map (index.js) 16.80KB 5.24KB
plugin-markdown (index.js) 13.65KB 4.67KB
plugin-report (index.js) 37.82KB 9.96KB
plugin-timeline (index.js) 25.37KB 7.20KB
plugin-tree (index.js) 8.21KB 2.76KB
plugin-view (index.js) 85.51KB 20.81KB
providers (DataSourceProvider.js) 0.75KB 0.39KB
providers (MetadataProvider.js) 1.37KB 0.59KB
providers (ThemeProvider.js) 1.55KB 0.67KB
providers (UploadProvider.js) 11.71KB 3.53KB
providers (index.js) 0.44KB 0.22KB
providers (types.js) 0.01KB 0.04KB
react-runtime (index.js) 3.19KB 1.38KB
react (LazyPluginLoader.js) 3.77KB 1.33KB
react (SchemaRenderer.js) 18.70KB 6.09KB
react (data-invalidation.js) 5.05KB 2.08KB
react (index.js) 0.79KB 0.43KB
sdui-parser (codegen.js) 4.09KB 1.74KB
sdui-parser (index.js) 2.16KB 0.94KB
sdui-parser (parse.js) 10.04KB 2.82KB
sdui-parser (types.js) 0.29KB 0.24KB
sdui-parser (validate.js) 4.69KB 1.48KB
tenant (TenantContext.js) 0.31KB 0.25KB
tenant (TenantGuard.js) 1.04KB 0.43KB
tenant (TenantProvider.js) 2.76KB 0.98KB
tenant (TenantScopedQuery.js) 0.77KB 0.44KB
tenant (index.js) 0.75KB 0.38KB
tenant (resolver.js) 2.64KB 0.76KB
tenant (useTenant.js) 0.50KB 0.32KB
tenant (useTenantBranding.js) 0.62KB 0.39KB
types (ai.js) 0.20KB 0.17KB
types (api-types.js) 0.20KB 0.18KB
types (app.js) 2.87KB 0.99KB
types (base.js) 0.20KB 0.18KB
types (blocks.js) 0.20KB 0.18KB
types (complex.js) 0.20KB 0.18KB
types (crud.js) 0.20KB 0.18KB
types (data-display.js) 0.20KB 0.18KB
types (data-protocol.js) 0.20KB 0.19KB
types (data.js) 0.20KB 0.18KB
types (designer.js) 0.77KB 0.41KB
types (disclosure.js) 0.20KB 0.18KB
types (feedback.js) 0.20KB 0.18KB
types (field-types.js) 0.20KB 0.18KB
types (form.js) 0.20KB 0.18KB
types (index.js) 1.54KB 0.68KB
types (layout.js) 0.20KB 0.18KB
types (mobile.js) 0.20KB 0.18KB
types (navigation.js) 0.20KB 0.18KB
types (objectql.js) 0.20KB 0.18KB
types (overlay.js) 0.20KB 0.18KB
types (permissions.js) 0.20KB 0.18KB
types (plugin-scope.js) 0.20KB 0.18KB
types (record-components.js) 0.20KB 0.19KB
types (registry.js) 0.20KB 0.18KB
types (reports.js) 0.20KB 0.18KB
types (spec-report.js) 5.26KB 1.96KB
types (tenant.js) 0.20KB 0.18KB
types (theme.js) 0.20KB 0.18KB
types (ui-action.js) 0.75KB 0.46KB
types (views.js) 0.20KB 0.18KB
types (widget.js) 0.20KB 0.18KB

Size Limits

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

@os-zhuang os-zhuang marked this pull request as ready for review July 14, 2026 11:17
@os-zhuang os-zhuang merged commit 86c69c3 into main Jul 14, 2026
10 checks passed
@os-zhuang os-zhuang deleted the claude/adr-0089-visible-when-renderer branch July 14, 2026 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants