Skip to content

docs(identity-placeholder): document usage and a11y notes#1403

Open
dohy-eon wants to merge 2 commits intodaangn:devfrom
dohy-eon:dev
Open

docs(identity-placeholder): document usage and a11y notes#1403
dohy-eon wants to merge 2 commits intodaangn:devfrom
dohy-eon:dev

Conversation

@dohy-eon
Copy link
Copy Markdown

@dohy-eon dohy-eon commented Apr 3, 2026

Summary

  • Document snippet import path and a typical Avatar fallback pattern.
  • Describe default screen reader behavior (role="img", fixed English aria-label) and when to consider aria-hidden for standalone use.

Test plan

  • bun docs:test (or bun test:all)

Summary by CodeRabbit

  • 문서
    • IdentityPlaceholder 컴포넌트 사용법 문서 추가: 컴포넌트 임포트 및 렌더링 예시, Avatar의 폴백으로 활용하는 방법 및 React 복합 구성 요소와의 조합 예시 포함
    • 접근성 가이드 추가: 기본 SVG 접근성 속성(예: role, aria-label) 설명과 장식용으로 사용할 경우 aria-hidden 추가 권장 사항 포함

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 3, 2026

⚠️ No Changeset found

Latest commit: 8e012ef

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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 3, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: f8daeec5-4d40-4d48-a6af-29a845dbfb4a

📥 Commits

Reviewing files that changed from the base of the PR and between b6f0928 and 8e012ef.

📒 Files selected for processing (1)
  • docs/content/react/components/identity-placeholder.mdx
✅ Files skipped from review due to trivial changes (1)
  • docs/content/react/components/identity-placeholder.mdx

📝 Walkthrough

Walkthrough

IdentityPlaceholder 문서가 추가되어 Usage(임포트·렌더링·Avatar fallback·복합 API 구성)와 Accessibility(SVG에 적용된 role/aria-label 및 사용 컨텍스트 가이드) 섹션이 포함되었습니다. 변경은 문서 파일 1개에 국한됩니다.

Changes

Cohort / File(s) Summary
Documentation
docs/content/react/components/identity-placeholder.mdx
Usage 섹션 추가: IdentityPlaceholder 임포트 방법, 렌더링 예시, Avatarfallback으로 사용 예, 및 복합 API(IdentityPlaceholder.Root, IdentityPlaceholder.Image) 구성법 설명. Accessibility 섹션 추가: 내부 SVG에 role="img", aria-label="Identity placeholder" 기본 적용 및 standalone 장식 요소에는 aria-hidden="true" 권장 안내.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🐰 새 문서가 살짝 튀어나와서,
아이콘 자리를 은은히 채우네.
접근성 속성 속삭이며 웃고,
개발 길에 작은 당근 하나 놓고 갑니다. 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed PR 제목은 풀 리퀘스트의 주요 변경 사항인 identity-placeholder 컴포넌트의 사용 방법과 접근성 관련 문서화를 명확하게 요약하고 있습니다.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/content/react/components/identity-placeholder.mdx`:
- Around line 50-51: Clarify that the suggestion to apply aria-hidden applies
only to the decorative identity placeholder element itself (non-interactive,
non-focusable placeholder inside the component) rather than the entire parent
container; update the text in identity-placeholder.mdx to say something like:
when the placeholder is purely decorative and the same information is already
provided in nearby text, mark the placeholder element itself with
aria-hidden="true" (not the whole container) so assistive technologies ignore
only the decorative element while preserving accessibility of surrounding
interactive or informative content.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 75ce545a-a446-4745-a09d-55751a7ceb48

📥 Commits

Reviewing files that changed from the base of the PR and between 14f68c9 and b6f0928.

📒 Files selected for processing (1)
  • docs/content/react/components/identity-placeholder.mdx

Comment thread docs/content/react/components/identity-placeholder.mdx Outdated
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