Skip to content

feat!: remove surface deprecated in 0.10.x - #3248

Merged
interactivellama merged 2 commits into
masterfrom
feat/remove-deprecated-surface
Oct 27, 2026
Merged

interactivellama merged 2 commits into
masterfrom
feat/remove-deprecated-surface

Conversation

@Niznikr

@Niznikr Niznikr commented Oct 19, 2026 •

Copy link
Copy Markdown
Collaborator

Additional description

What: removes the props, components, and import paths that 0.10.x already flagged with dev-only deprecation warnings (ROADMAP: Deprecated surface). v11 kept them working; this drops them before v11 leaves alpha. Each item lists its replacement in CHANGELOG.md under Removed.

Breaking changes and migration:

Removed Use instead
InlineEdit / SLDSInlineEdit (components/forms/input/inline) Input with inlineEditTrigger (the prop stays)
ModalTrigger / SLDSModalTrigger Render Modal with isOpen; it already portals to body
Modal title heading
Modal closeButtonAssistiveText assistiveText.closeButton
Tooltip target onRequestTargetElement
Tooltip variant="info" / "error" theme
String assistiveText on Avatar, Breadcrumb, Button, ButtonStateful, Checkbox, Search, Spinner, Textarea, Tree An object, e.g. assistiveText={{ label: 'Loading' }}; see each component's assistiveText type for its keys
components/forms/checkbox path components/checkbox
components/tabs/pane path components/tabs/panel
Checkbox oldEventParameterOrder Nothing; v11 already ignored it
FORMS_INLINE_EDIT in utilities/constants Nothing

components/forms/checkbox and components/tabs/pane were never shipped as JavaScript in v11, so only their type declarations and source go away.

Supporting cleanup:

  • Warning code that only checked the removed props is deleted: check-props.js for Avatar, Breadcrumb, ButtonStateful, Modal, and Spinner, plus utilities/warning/deprecated-event-parameter.js. The remaining check-props.js files lose only the removed checks.
  • The SetupAssistant examples stop passing oldEventParameterOrder.
  • The InlineEdit story, example, and test are deleted. That story had no HTML snapshot, so the snapshot file doesn't change.
  • ROADMAP.md: forms no longer appears in the lists of folders without a story or test.

Out of scope:

  • Popover's closeButtonAssistiveText: it's a separate prop with its own deprecation warning.
  • types/components.ts: it still declares a closeButtonAssistiveText on a ModalProps interface. The package's types come from the generated dist/types files, so this file isn't part of what consumers get; it looks stale and could be deleted in a follow-up.

Merge note: the boolean prop rename PR (feat/boolean-prop-names) adds rename warnings to check-props.js files that this PR deletes: Avatar, ButtonStateful, Modal, and Spinner. It also keeps Checkbox's import of deprecated-event-parameter. Whichever PR merges second needs a rebase. When resolving:

  • Keep each of those check-props.js files, containing only the boolean rename warnings.
  • Drop the Checkbox import.
  • Remove the duplicate checkProps import and call in components/modal/index.tsx.

Tests: removed props and paths are covered by typecheck and the build: nothing in the library, examples, or stories still uses them. No new tests; the only test change is the deleted InlineEdit test. Locally: 49 test files and 1,017 tests pass, lint has 0 errors (222 warnings, one fewer than master), and typecheck and build are clean.


CONTRIBUTOR checklist (do not remove)

Please complete for every pull request.

Green gate — all of these must pass locally (CI runs the same):

  • npm run lint passes with 0 errors (npm run lint:fix to auto-fix). Warnings are the tracked gradual-migration backlog; do not add new errors.
  • npm run typecheck is clean (tsc --noEmit).
  • npm test -- --run passes — this runs both Vitest projects (jsdom unit + real-browser browser) and the story HTML snapshots. If you changed rendered markup on purpose, update snapshots with npm test -- --run -u and review the diff.
  • npm run build succeeds (type-check + Vite library build + .d.ts + entry shims).

Behavior & docs:

  • First-time contributors: sign the CLA (a bot will comment with instructions).
  • Added/updated Vitest + React Testing Library tests for the change (template: components/button/__tests__). New props and bug fixes should get a regression test. Tests that genuinely need a real browser (focus traversal, layout/measurement, canvas) go in a *.browser.test.jsx file (the browser project); everything else is jsdom.
  • Reviewed the component's Storybook stories: npm run storybook → http://localhost:6007/. Confirm the story actually renders and behaves (deprecated Storyshots/Karma are gone; there is no separate browser-tests server).
  • Story/example code uses the component's real prop API (e.g. render-props like onRenderContent / onRenderVisualPicker, icon props, events), not assumptions — a common source of "component looks broken" reports has been stories authored against the wrong API. Cross-check against components/<name>/__examples__.
  • Storybook Accessibility (a11y) panel shows no new violations for the affected stories.
  • If you added or changed a type, remember runtime PropTypes were removed in the TS migration — types are the contract. Ship accurate .d.ts (they're generated by the build); JS consumers rely on them via editor type-acquisition.

REVIEWER checklist (do not remove)

  • CI is green (GitHub Actions CI workflow: lint, typecheck, test, build). Chromatic visual review, if configured, has been checked.
  • Change has adequate test coverage; bug fixes include a regression test.
  • Reviewed the affected Storybook stories and their a11y panels.
  • Rendered markup still conforms to SLDS — check the story HTML snapshot diff (components/__tests__/__snapshots__/story-snapshots.test.jsx.snap).
  • Public API / package surface: if exports changed, the deep-import contract still holds (@salesforce/design-system-react/components/<name> and nested paths resolve for ESM, CJS, and types). Removing/renaming a public component or export is a breaking change → feat!:/BREAKING CHANGE: and a major version bump.

Niznikr and others added 2 commits October 26, 2026 19:38
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Remove the props, components, and aliases that already warned in
development on 0.10.x: InlineEdit, ModalTrigger, Modal title and
closeButtonAssistiveText, Tooltip target and the info/error variant
values, string assistiveText on nine components, the forms/checkbox
and tabs/pane aliases, Checkbox oldEventParameterOrder, and the
FORMS_INLINE_EDIT constant.

BREAKING CHANGE: InlineEdit/SLDSInlineEdit and ModalTrigger/SLDSModalTrigger
are no longer exported. Modal drops title (use heading) and
closeButtonAssistiveText (use assistiveText.closeButton). Tooltip drops
target (use onRequestTargetElement) and the info/error variant values
(use theme). Avatar, Breadcrumb, Button, ButtonStateful, Checkbox,
Search, Spinner, Textarea, and Tree accept only an object for
assistiveText. The components/forms/checkbox and components/tabs/pane
paths, Checkbox oldEventParameterOrder, and FORMS_INLINE_EDIT are removed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@interactivellama
interactivellama force-pushed the feat/remove-deprecated-surface branch from 03c0600 to 0fb625a Compare October 27, 2026 01:47
@interactivellama
interactivellama merged commit 8aa75a7 into master Oct 27, 2026
13 checks passed
@interactivellama
interactivellama deleted the feat/remove-deprecated-surface branch October 27, 2026 02:07
interactivellama added a commit that referenced this pull request Oct 27, 2026
…base

#3248 removed Modal's check-props module and its checkProps call; the
callback-shapes rebase reintroduced the import and the componentDoc import.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
interactivellama added a commit that referenced this pull request Oct 27, 2026
* feat!: standardize v11 callback shapes on (event, data)

Callbacks across Tabs, MenuDropdown, Carousel, SetupAssistant, Popover,
Tree, SplitView, PillContainer, Toast, Modal, WelcomeMat and DatePicker
now receive (event, data), report the requested state in data, and have
exported data types. Old Tree, SplitView and PillContainer callbacks are
deprecated with one-time warnings rather than removed.

BREAKING CHANGE: Tabs onSelect is called as onSelect(event, { selectedIndex,
previousIndex }) and returning false no longer cancels the selection.
MenuDropdown onSelect is called as onSelect(event, { option, optionIndex }).
Carousel onRequestAutoplayToggle and SetupAssistant onStepToggleIsOpen /
SetupAssistantStep onToggleIsOpen data report the requested state. Popover
onRequestClose data always includes a trigger. See CHANGELOG.md.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(modal): drop check-props and component.json leftovers from the rebase

#3248 removed Modal's check-props module and its checkProps call; the
callback-shapes rebase reintroduced the import and the componentDoc import.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Stephen James <sjames@salesforce.com>
interactivellama added a commit that referenced this pull request Oct 29, 2026
* feat!: standardize v11 callback shapes on (event, data)

Callbacks across Tabs, MenuDropdown, Carousel, SetupAssistant, Popover,
Tree, SplitView, PillContainer, Toast, Modal, WelcomeMat and DatePicker
now receive (event, data), report the requested state in data, and have
exported data types. Old Tree, SplitView and PillContainer callbacks are
deprecated with one-time warnings rather than removed.

BREAKING CHANGE: Tabs onSelect is called as onSelect(event, { selectedIndex,
previousIndex }) and returning false no longer cancels the selection.
MenuDropdown onSelect is called as onSelect(event, { option, optionIndex }).
Carousel onRequestAutoplayToggle and SetupAssistant onStepToggleIsOpen /
SetupAssistantStep onToggleIsOpen data report the requested state. Popover
onRequestClose data always includes a trigger. See CHANGELOG.md.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(modal): drop check-props and component.json leftovers from the rebase

#3248 removed Modal's check-props module and its checkProps call; the
callback-shapes rebase reintroduced the import and the componentDoc import.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Stephen James <sjames@salesforce.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants