Skip to content

Conversation

@Rajdeepc
Copy link
Contributor

Description

Comprehensive documentation rewrite for sp-truncated with full API reference, accessibility guidelines, usage patterns, and practical examples across multiple component contexts.

Added sp-truncated to bundle/elements.ts to ensure proper component registration and CSS rendering in documentation demo blocks.

Motivation and context

Related issue(s)

  • fixes SWC-431

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.

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

  • Descriptive Test Statement

    1. Go here
    2. Do this action
    3. Expect this result
  • Descriptive Test Statement

    1. Go here
    2. Do this action
    3. Expect this result

Device review

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

@Rajdeepc Rajdeepc self-assigned this Oct 28, 2025
@Rajdeepc Rajdeepc requested a review from a team as a code owner October 28, 2025 13:00
@Rajdeepc Rajdeepc added a11y Issues or PRs related to accessibility Documentation Issues or PRs involving changes to documentation or documentation website Status: Ready for review PR ready for review or re-review. labels Oct 28, 2025
@changeset-bot
Copy link

changeset-bot bot commented Oct 28, 2025

⚠️ No Changeset found

Latest commit: 1fa7876

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.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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
Contributor

github-actions bot commented Oct 28, 2025

📚 Branch Preview

🔍 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-5839

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.

@github-actions
Copy link
Contributor

Tachometer results

Currently, no packages are changed by this PR...

@Rajdeepc Rajdeepc marked this pull request as draft October 28, 2025 13:09
@Rajdeepc Rajdeepc added Status: WIP PR is a work in progress or draft and removed Status: Ready for review PR ready for review or re-review. labels Oct 28, 2025
@coveralls
Copy link
Collaborator

coveralls commented Oct 28, 2025

Pull Request Test Coverage Report for Build 18939955006

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 97.964%

Totals Coverage Status
Change from base Build 18885025935: 0.0%
Covered Lines: 34259
Relevant Lines: 34788

💛 - Coveralls

@Rajdeepc
Copy link
Contributor Author

Known issue: sp-tooltip is getting cut off due to max-width constraint for long words. Will be tacked in SWC-1331

@Rajdeepc Rajdeepc marked this pull request as ready for review October 30, 2025 12:03
@Rajdeepc Rajdeepc added Status: Ready for review PR ready for review or re-review. and removed Status: WIP PR is a work in progress or draft labels Oct 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

a11y Issues or PRs related to accessibility Documentation Issues or PRs involving changes to documentation or documentation website Status: Ready for review PR ready for review or re-review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants