Skip to content

docs(prompt-field): show collapsed in the api table - #6847

Draft
rubencarvalho wants to merge 1 commit into
mainfrom
ruben/docs-prompt-field-api-table
Draft

rubencarvalho wants to merge 1 commit into
mainfrom
ruben/docs-prompt-field-api-table

Conversation

@rubencarvalho

Copy link
Copy Markdown
Contributor

Description

Removes the @internal tag from the collapsed property on swc-prompt-field, so the property shows in the Storybook API table. The Playground render now passes collapsed to the element, so the new control works.

Motivation and context

collapsed is a public, reflected property that consumers can use, but @internal hid it from the API table.

Related issue(s)

  • fixes [Issue Number]

Screenshots (if appropriate)


Author's checklist

  • I have read the CONTRIBUTING and PULL_REQUESTS documents.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices
  • I have added automated tests to cover my changes.
  • I have included a well-written changeset if my change needs to be published.
  • I have included updated documentation if my change required it.

Validation: no lint, build, or tests were run locally (dependencies are not installed in this worktree). CI will validate.


Reviewer's checklist

  • Includes a Github Issue with appropriate flag or Jira ticket number without a link
  • Includes thoughtfully written changeset if changes suggested include patch, minor, or major features
  • Automated tests cover all use cases and follow best practices for writing
  • Validated on all supported browsers
  • All VRTs are approved before the author can update Golden Hash

Manual review test cases

  • collapsed shows in the API table

    1. Go to the Storybook docs page for AI Toolkit/Prompt field
    2. Find the API table
    3. Expect a collapsed row with a boolean control
  • The Playground control works

    1. Go to the Prompt field Playground story
    2. Turn on the collapsed control
    3. Expect the single-line layout with the send button inline

Device review

  • Did it pass in Desktop?
  • Did it pass in (emulated) Mobile?
  • Did it pass in (emulated) iPad?

Accessibility testing checklist

Required: Complete each applicable item and document your testing steps (replace the placeholders with your component-specific instructions).

  • Keyboard (required — document steps below) — What to test for: Focus order is logical; Tab reaches the component and all interactive descendants; Enter/Space activate where appropriate; arrow keys work for tabs, menus, sliders, etc.; no focus traps; Escape dismisses when applicable; focus indicator is visible.

    1. Go to the Prompt field Playground story and turn on collapsed
    2. Press Tab through the component
    3. Expect focus to reach the textarea and send button only; hidden leading actions are inert
  • Screen reader (required — document steps below) — What to test for: Role and name are announced correctly; state changes (e.g. expanded, selected) are announced; labels and relationships are clear; no unnecessary or duplicate announcements.

    1. Go to the Prompt field Playground story and turn on collapsed
    2. Navigate the component with a screen reader
    3. Expect no change from current behavior; this PR only changes docs visibility

@changeset-bot

changeset-bot Bot commented Oct 21, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: b144f46

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions

Copy link
Copy Markdown
Contributor

📚 Branch Preview Links

🔍 Gen1 Visual Regression Test Results

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

Deployed to Azure Blob Storage: pr-6847

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

This branch has not been deployed

No deployments
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.

1 participant