docs(core/application): Skip link for the ix-application component - #271
Open
dmytro-halimov wants to merge 1 commit into
Open
docs(core/application): Skip link for the ix-application component#271dmytro-halimov wants to merge 1 commit into
dmytro-halimov wants to merge 1 commit into
Conversation
dmytro-halimov
changed the title
✅ Deploy Preview for industrial-experience ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
📝 WalkthroughWalkthroughThe documentation now describes the Application component’s built-in skip link, target configuration, localization, fallback behavior, disabling conditions, and related accessibility guidance. ChangesApplication skip-link documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/components/application/code.mdx`:
- Line 23: Correct the documentation reference in the text near
ApplicationPlayground: point “the basic example” to the following example that
actually configures skipLinkTargetId, or add that configuration to the preceding
example. Ensure the prose accurately matches the example being referenced.
🪄 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: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 8472001c-5d81-4bea-bdd2-c6cd24e634b1
📒 Files selected for processing (4)
docs/components/application/code.mdxdocs/components/application/guide.mddocs/guidelines/accessibility/code.mddocs/guidelines/accessibility/overview.md
|
|
||
| ## Skip link target | ||
|
|
||
| `ix-application` includes a "Skip to main content" link with no configuration required. By default, it focuses the application's internal main region. The basic example above uses `skipLinkTargetId` to focus a specific content boundary instead: |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Correct the example reference.
The text says the basic example above uses skipLinkTargetId, but that example is only <ApplicationPlayground />. Refer to the following example instead, or update the preceding example to include the configuration.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/components/application/code.mdx` at line 23, Correct the documentation
reference in the text near ApplicationPlayground: point “the basic example” to
the following example that actually configures skipLinkTargetId, or add that
configuration to the preceding example. Ensure the prose accurately matches the
example being referenced.
9 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Main repo PR: siemens/ix#2670
🆕 What is the new behavior?
Add a default-on skip link to ix-application for bypassing repeated application-shell content, including configurable destination targeting with focus and scroll management, localized link text, and an explicit opt-out for applications that provide their own bypass mechanism.
👨💻 Help & support