Skip to content

fix(app-shell): a read-only form designer card no longer describes how to drag it (objectui#11924) - #11961

Merged
objectstack-fleet[bot] merged 1 commit into
mainfrom
claude/issue-11924-readonly-card-describedby
Oct 8, 2026
Merged

objectstack-fleet[bot] merged 1 commit into
mainfrom
claude/issue-11924-readonly-card-describedby

Conversation

@objectstack-fleet

Copy link
Copy Markdown
Contributor

Fixes #11924

Clause-②: no

What changed

In a read-only package, a field card in the form designer pointed aria-describedby at the canvas's drag instructions. A screen reader then told the author how to drag a card that cannot move. The read-only card now carries no description. A writable card keeps the instructions.

  • packages/app-shell/src/views/studio-design/ObjectFormDesigner.tsx: in SortableField, one attribute follows the {...attributes} / {...listeners} spread, aria-describedby={readOnly ? undefined : attributes['aria-describedby']}, with a comment saying why. The card already overrides aria-label the same way, after the spread.
  • packages/app-shell/src/views/studio-design/ObjectFormDesigner.readOnlyDescription-11924.test.tsx (new, beside it): the pins below.
  • .changeset/11924-readonly-card-describedby.md: an @object-ui/app-shell patch.

No other file changed. The change adds no export, prop, type member, spec key or language-pack key. Every file is inside the claim's file surface. The "not on it" list is untouched: the objectui#11898 keyboard placement, StudioDesignSurface.tsx, packages/components/src/ui/** and packages/i18n/**.

Mechanism, measured

H1, confirmed. The installed @dnd-kit/core 6.3.1 sets aria-describedby unconditionally. Its useDraggable builds its returned attributes with 'aria-describedby': ariaDescribedById.draggable (read in core.esm.js). useSortable passes the user's attributes through for role, roleDescription and tabIndex only. So the card's existing roleDescription: readOnly ? '' : ... (objectui#11872) could not reach aria-describedby.

H1 follow-up: useSortable({ disabled: readOnly }) is not the cleaner fix. Measured through the real component. I added disabled: readOnly and removed this fix. A read-only card then rendered:

{"role":"button","tabindex":"0","aria-disabled":"true","aria-roledescription":"","aria-describedby":"DndDescribedBy-0","aria-label":"Name — click to view properties"}

aria-describedby still points at the instructions. The card also gains aria-disabled="true", yet a click still opens the inspector. So disabled fixes nothing here and adds a second false statement. The one-attribute override is the smaller correct change. The probe was a temporary file, removed afterwards. The tree is proven clean: blob == HEAD and git diff HEAD is empty.

H2, confirmed: nothing else about a read-only card changes. It stays role="button" with tabindex="0" and its read-only accessible name. It takes focus, and a click calls onSelectField with its field name. A control pins this.

H3: byte-neutral by construction. NOT MEASURED locally. The change is one JSX attribute: a ternary on a prop the component already holds. The build strips the comment. The instrument for this is the eager-closure budget bot's reading on this PR against main's, and that reading comes from the CI build.

Pins

The instrument is the card's computed accessible description: jest-dom's toHaveAccessibleDescription, which follows aria-describedby into dnd-kit's hidden instructions node. The instructions are resolved by the key engine.studio.formDnd.instructions through the designer's table, in en-US and zh-CN.

  • Read-only, en-US and zh-CN: the card has no aria-describedby, and its description is neither locale's instructions.
  • Control, writable, en-US and zh-CN: the card has aria-describedby, and its description equals the instructions row. This shows the instrument can see the hidden node.
  • Control, read-only: the card is a focusable button and selects its field on click.

Reverse check

The fix was committed first, at c9e527f6c. The mutation then went through objectstack's scripts/ablation-replace.mjs in wrap mode. The tool proves that the mutation landed on disk and that the restore matches HEAD.

  • Mutation: readOnly ? undefined : attributes['aria-describedby'] became false ? undefined : attributes['aria-describedby'], which is the pre-fix behaviour. Anchor count went 1 to 0. Blob went e9c9f48745f4 to 406253ee4fb5.
  • Result: Tests 2 failed | 3 passed (5). Both read-only pins went red (aria-describedby="DndDescribedBy-0", then -1). Both writable controls and the click control stayed green. The direction was red, as expected.
  • Restore: blob == HEAD e9c9f48745f4, and git diff HEAD is empty.
  • First attempt: it was a refused no-op. The replacement was a substring of the anchor, so the tool refused before any test run and restored the file. I record it here rather than leave it out.

There is no build or dist/ leg. The test imports ./ObjectFormDesigner by relative path, so it runs the source.

Gates

All gates ran at c9e527f6c. That is git rev-parse --short HEAD after the last commit, and the lock runs echoed it.

  • Tests: repo-root pnpm exec vitest run under the verify lock gave Test Files 9 passed (9) and Tests 69 passed (69), with lock VERDICT command-exit 0. The run covered:
    • the new file;
    • every test importing ObjectFormDesigner: the five ObjectFormDesigner.*.test.tsx files (objectui#11802, objectui#11871, objectui#11872 and objectui#11898 among them), StudioDesignSurface.formFields.test.tsx and packages/plugin-form/src/__tests__/autoLayout.wideSpelling.test.ts;
    • packages/core/src/utils/__tests__/column-identity.ratchet.test.ts.
  • Type-check: the closure build turbo run build --filter=@object-ui/app-shell^... gave 28 cached, 28 total. Then pnpm --filter @object-ui/app-shell type-check ran (tsc --noEmit && tsc -p tsconfig.test.json; the second project's include of src/**/*.test.tsx covers the new test). Output: TYPECHECK-OK, lock VERDICT command-exit 0.
  • i18n keys: pnpm check:i18n-keys exited 0.
  • Changeset presence: node scripts/check-changeset-presence.mjs exited 0: "2 source file(s) of 1 released package(s) changed, and this change declares 1 changeset(s)".
  • No major: node scripts/check-changeset-no-major.mjs exited 0.
  • Line citations: pnpm check:new-line-citations printed VERDICT new-cross-file-line-citations: 0 new citation(s), enforcement report-only -> exit 0.
  • Control bytes: pnpm check:control-bytes exited 0.
  • Test-file gates: node scripts/check-vi-mock-override-shape.mjs and node scripts/check-test-path-roots.mjs both exited 0. These are lint-workflow gates that read test files.
  • ESLint: pnpm exec eslint on the two touched TS files exited 0. The --format json output reports 2 files, 0 errors and 1 warning. The warning is older than this PR: react-hooks/set-state-in-effect on the effect that re-syncs items from the draft, a line this diff does not touch.
  • Governed surface: node scripts/check-governed-queue-guard.mjs --test over the three paths reported NOT GOVERNED.
  • Left to CI: the repo-wide pnpm lint and the rest of the lint farm. The ESLint run above covers only the two touched files. It is not a proven narrowing.

Acceptance notes

  • Docs (AGENTS.md rule 2, docs-driven): this is a bug fix and no doc describes the card's screen-reader description. git grep for screen-reader prose in content/docs and packages/app-shell/README.md finds 5 lines. As a control, none of them names the designer or dragging. The earlier sibling a11y fixes on this component touched no docs either.
  • The hidden node remains: in a read-only canvas, dnd-kit still renders its hidden instructions node and live region. Nothing references the node now, and an unreferenced display: none node is not exposed. I left it alone.

Session: https://claude.ai/code/session_01MgfduSkFrfM3eorB3UGfAU


Generated by Claude Code

…w to drag it (objectui#11924)

dnd-kit's useDraggable writes aria-describedby onto every card, pointing at
the canvas's drag instructions, and useSortable's attributes cannot remove
it. A read-only package's card has its sensors off, so the card now drops
that attribute when readOnly; a writable card keeps it.

Pinned through the real ObjectFormDesigner in en and zh, with the writable
card as the control and a read-only click-to-select / tab-order control.

Claude-Session: https://claude.ai/code/session_01MgfduSkFrfM3eorB3UGfAU
Co-authored-by: Claude <noreply@anthropic.com>
@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

Metric Value Budget
Eager closure (gzip, 336 chunks) 3306.9 KB 3312.0 KB
Main entry chunk (gzip) 71.3 KB 350 KB
Entry file index-DKAFIzV_.js —
Status PASS —

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

Package Size Gzipped
app-shell (consoleActionDispatch.js) 0.20KB 0.19KB
app-shell (index.js) 17.82KB 6.58KB
app-shell (runtime-config.js) 22.59KB 7.89KB
app-shell (types.js) 0.01KB 0.04KB
app-shell (urlParams.js) 10.11KB 3.87KB
auth (ActiveOrganizationStorage.js) 27.95KB 10.04KB
auth (AuthContext.js) 0.31KB 0.24KB
auth (AuthGuard.js) 2.07KB 1.00KB
auth (AuthProvider.js) 40.22KB 10.61KB
auth (AuthShell.js) 3.49KB 1.40KB
auth (ForgotPasswordForm.js) 12.21KB 3.45KB
auth (LoginForm.js) 18.15KB 5.40KB
auth (PreviewBanner.js) 0.90KB 0.50KB
auth (RegisterForm.js) 6.72KB 2.24KB
auth (SocialSignInButtons.js) 9.70KB 3.93KB
auth (UserMenu.js) 3.39KB 1.21KB
auth (auth-gate-events.js) 1.29KB 0.66KB
auth (authStyles.js) 5.04KB 1.72KB
auth (createAuthClient.js) 40.70KB 10.94KB
auth (createAuthenticatedFetch.js) 8.54KB 3.46KB
auth (index.js) 3.63KB 1.64KB
auth (invitation-status.js) 1.22KB 0.70KB
auth (org-roles.js) 6.66KB 2.78KB
auth (phone-identifier.js) 1.11KB 0.66KB
auth (types.js) 0.59KB 0.35KB
auth (useAuth.js) 5.30KB 1.02KB
auth (useWorkspaceAdminStatus.js) 11.08KB 4.58KB
collaboration (CommentThread.js) 27.11KB 7.97KB
collaboration (LiveCursors.js) 3.17KB 1.27KB
collaboration (PresenceAvatars.js) 6.28KB 2.60KB
collaboration (PresenceProvider.js) 2.79KB 1.13KB
collaboration (index.js) 1.68KB 0.73KB
collaboration (useCollaborationTranslation.js) 6.50KB 2.52KB
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) 587.49KB 141.58KB
core (index.js) 10.00KB 3.96KB
create-plugin (index.js) 27.94KB 9.51KB
data-objectstack (index.js) 240.39KB 67.09KB
fields (index.js) 266.92KB 67.47KB
i18n (LocalizationContext.js) 2.92KB 1.42KB
i18n (builtinAggregateLabels.js) 0.86KB 0.49KB
i18n (currency.js) 2.59KB 1.22KB
i18n (fallbackInterpolation.js) 6.25KB 2.77KB
i18n (i18n.js) 8.87KB 3.64KB
i18n (index.js) 5.52KB 2.39KB
i18n (pickLocalized.js) 9.86KB 3.95KB
i18n (provider.js) 39.35KB 12.88KB
i18n (translateFn.js) 0.20KB 0.18KB
i18n (useDisplayLocale.js) 3.52KB 1.76KB
i18n (useObjectLabel.js) 36.87KB 9.88KB
i18n (useSafeTranslation.js) 7.14KB 2.92KB
layout (index.js) 41.50KB 11.82KB
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.75KB
mobile (index.js) 1.99KB 0.87KB
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) 6.96KB 1.98KB
mobile (useOfflineSync.js) 1.99KB 0.72KB
mobile (usePullToRefresh.js) 6.62KB 2.45KB
mobile (useResponsive.js) 0.72KB 0.42KB
mobile (useSpecGesture.js) 5.52KB 2.10KB
mobile (useTouchTarget.js) 1.01KB 0.54KB
permissions (MePermissionsProvider.js) 13.86KB 5.00KB
permissions (PermissionContext.js) 0.31KB 0.25KB
permissions (PermissionGuard.js) 0.89KB 0.45KB
permissions (PermissionProvider.js) 6.52KB 2.26KB
permissions (discardProofCache.js) 1.04KB 0.55KB
permissions (evaluator.js) 8.33KB 3.07KB
permissions (index.js) 0.93KB 0.41KB
permissions (store.js) 0.91KB 0.42KB
permissions (useFieldPermissions.js) 1.28KB 0.53KB
permissions (usePermissions.js) 4.83KB 2.27KB
plugin-ai (index.js) 16.04KB 3.92KB
plugin-calendar (index.js) 53.39KB 15.52KB
plugin-charts (index.js) 84.71KB 23.25KB
plugin-chatbot (index.js) 199.63KB 47.46KB
plugin-dashboard (index.js) 144.20KB 38.95KB
plugin-designer (index.js) 231.46KB 48.87KB
plugin-detail (index.js) 248.57KB 65.47KB
plugin-editor (index.js) 2.23KB 1.05KB
plugin-form (index.js) 176.62KB 45.75KB
plugin-gantt (index.js) 179.17KB 45.07KB
plugin-grid (index.js) 248.06KB 68.79KB
plugin-kanban (index.js) 52.17KB 16.37KB
plugin-list (index.js) 117.58KB 29.37KB
plugin-map (index.js) 27.24KB 9.03KB
plugin-markdown (index.js) 13.88KB 4.80KB
plugin-report (index.js) 44.12KB 12.29KB
plugin-timeline (index.js) 39.10KB 11.81KB
plugin-tree (index.js) 15.07KB 5.33KB
plugin-view (index.js) 91.07KB 22.93KB
providers (DataSourceProvider.js) 0.75KB 0.39KB
providers (MetadataProvider.js) 1.37KB 0.59KB
providers (ThemeProvider.js) 1.90KB 0.85KB
providers (UploadProvider.js) 11.81KB 3.58KB
providers (index.js) 0.45KB 0.23KB
providers (types.js) 0.01KB 0.04KB
react-runtime (index.js) 5.62KB 2.34KB
react (LazyPluginLoader.js) 4.47KB 1.63KB
react (SchemaRenderer.js) 120.63KB 39.56KB
react (data-invalidation.js) 5.05KB 2.08KB
react (index.js) 4.50KB 2.06KB
react (schema-input.js) 4.31KB 2.07KB
react (spec-input.js) 0.20KB 0.18KB
sdui-parser (body-dialect.js) 4.50KB 1.99KB
sdui-parser (codegen.js) 9.45KB 3.76KB
sdui-parser (dashboard-widget-options.js) 3.07KB 1.30KB
sdui-parser (index.js) 7.30KB 3.12KB
sdui-parser (input-type.js) 2.84KB 1.40KB
sdui-parser (parse.js) 25.28KB 7.80KB
sdui-parser (provenance.js) 3.84KB 1.90KB
sdui-parser (types.js) 0.28KB 0.23KB
sdui-parser (validate.js) 23.87KB 7.83KB
types (ai.js) 4.39KB 2.17KB
types (api-types.js) 0.20KB 0.18KB
types (app.js) 4.12KB 1.61KB
types (authoring-nodes.js) 0.20KB 0.19KB
types (base.js) 0.20KB 0.18KB
types (blocks.js) 0.20KB 0.18KB
types (cloud.js) 0.20KB 0.18KB
types (complex.js) 4.44KB 2.07KB
types (crud.js) 0.20KB 0.18KB
types (dashboard-filter-alias.js) 6.23KB 2.74KB
types (dashboard-widget-layout.js) 2.06KB 0.96KB
types (data-display.js) 3.75KB 1.85KB
types (data-protocol.js) 0.20KB 0.19KB
types (data.js) 0.20KB 0.18KB
types (designer.js) 1.85KB 0.85KB
types (disclosure.js) 0.20KB 0.18KB
types (error-code.js) 1.54KB 0.88KB
types (expression.js) 0.20KB 0.18KB
types (feedback.js) 0.20KB 0.18KB
types (field-types.js) 1.13KB 0.65KB
types (form.js) 0.20KB 0.18KB
types (http-inflight.js) 8.87KB 3.73KB
types (http-retry.js) 4.32KB 2.02KB
types (icon-key-migration.js) 4.26KB 1.63KB
types (index.js) 5.78KB 2.70KB
types (layout.js) 0.20KB 0.18KB
types (managed-by.js) 0.19KB 0.18KB
types (mobile.js) 5.00KB 2.39KB
types (navigation.js) 0.20KB 0.18KB
types (node-slots.js) 7.18KB 2.34KB
types (objectql.js) 0.20KB 0.18KB
types (overlay.js) 0.20KB 0.18KB
types (permissions.js) 2.52KB 1.31KB
types (plugin-scope.js) 0.20KB 0.18KB
types (record-components.js) 0.20KB 0.19KB
types (record-semantics.js) 1.28KB 0.67KB
types (registry.js) 0.20KB 0.18KB
types (reports.js) 0.20KB 0.18KB
types (select-option.js) 0.20KB 0.19KB
types (spec-report.js) 4.99KB 1.96KB
types (spec-ui-namespace.js) 0.20KB 0.19KB
types (strict-authoring-face.js) 19.93KB 7.25KB
types (system-fields.js) 3.33KB 1.54KB
types (theme.js) 6.28KB 2.87KB
types (ui-action.js) 8.11KB 3.32KB
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

@objectstack-fleet
objectstack-fleet Bot marked this pull request as ready for review October 8, 2026 11:59
@objectstack-fleet
objectstack-fleet Bot added this pull request to the merge queue Oct 8, 2026
Merged via the queue into main with commit 94f48a2 Oct 8, 2026
45 checks passed
@objectstack-fleet
objectstack-fleet Bot deleted the claude/issue-11924-readonly-card-describedby branch October 8, 2026 12:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

2 participants