Add some more docs for render mode and aria, for easier discoverability. - #403
Add some more docs for render mode and aria, for easier discoverability.#403MayaKirova wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The new render-mode guidance is placed in the WebAssembly getting-started section but render modes apply to Blazor Web Apps, which can mislead standalone WASM users.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates the repository README to improve discoverability of hosting/render-mode requirements and accessibility ownership for Ignite UI for Blazor consumers.
Changes:
- Added a “Supported render modes” section describing interactive render mode requirements.
- Added an “Accessibility (WAI-ARIA)” section clarifying that ARIA patterns/keyboard behavior/testing are owned by the Ignite UI Web Components repo.
- Minor whitespace cleanup (e.g., trailing spaces).
File summaries
| File | Description |
|---|---|
| README.md | Adds documentation for supported interactive render modes and accessibility/WAI-ARIA guidance; also trims minor whitespace. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| ### Supported render modes | ||
|
|
||
| Ignite UI for Blazor components require an **interactive** render mode. The following render modes are supported: | ||
|
|
||
| - **InteractiveServer** | ||
| - **InteractiveWebAssembly** | ||
| - **InteractiveAuto** | ||
|
|
||
| Static server-side rendering (SSR) is not supported because the components rely on JavaScript interop to render and update the underlying web components. | ||
|
|
||
| When using the **Per page/component** interactivity location, make sure an interactive render mode is explicitly specified on every page or component that uses Ignite UI for Blazor components, for example: | ||
|
|
||
| ```razor | ||
| @rendermode InteractiveServer | ||
| ``` |
Here's the re-assessment (on RadioGroup - 1 component): Full BEQ scorecard (24 IDs)
The agent still tried running a sample to check for aria attributes, kb nav and so on. Probably because the skill explicitly tells it to: https://github.com/dotnet/aspnetcore/pull/68627/changes#diff-2187b115d4ead7ac9d38d55d9fd2dc4a152a62acbaa21b64d624bc55b6956e86R18 If we don't want it to do that, it will require changes on the skill. Here's the re-assessment: A11Y scorecard (12 IDs)
|
|
Here's the summary I was able to get by the agent related to the render mode and ARIA. For my assessment it does recognize the name/role and such. The listed defects do sound valid but probably needs to be investigated: I think for my case it directly tested the component for the ARIA and was not relying on docs for it. For the render mode I think its fine as is. The failure on unsupported modes does not sound like critical to be fixed atm. 4.3.1 ARIA readiness summaryOverall ARIA readiness: not ready for an unqualified accessibility claim. The tested Radio Group exposes the core ARIA radio structure correctly, but validation state and composite keyboard behavior have release-blocking gaps. This conclusion is limited to the exact 0.1.1 package in Chromium and is not a formal WCAG or assistive-technology certification.
The primary ARIA remediation needs are:
4.4.1 Render mode readiness summaryOverall render-mode readiness: runtime-ready for the tested interactive modes, but documentation is not release-ready. Radio Group operated correctly in Interactive Server, Interactive WebAssembly, and both phases of Interactive Auto. Prerendering did not throw. The released package does not, however, provide a clear supported-mode matrix, an explicit unsupported-mode contract, or a useful Static SSR accessibility and behavior contract.
The targeted interactive probes observed:
The primary render-mode readiness actions are:
Here's the full assessment file: |
Description
Add explicit information in the README about render modes and accessibility for easier assements.