[Docs] Link WindowEventMap definition in window events docs#9777
[Docs] Link WindowEventMap definition in window events docs#9777MannXo wants to merge 3 commits into
Conversation
|
👋 Since this is a community submitted pull request, a Buildkite build has not been started automatically. Would an Elastic organization member please verify the contents of this pull request and kick off a build manually? |
|
This is a documentation-only change to |
weronikaolejniczak
left a comment
There was a problem hiding this comment.
@MannXo Instead of adding the link directly in the content, I would add a JSDoc comment for event which will automatically propagate to the prop table in the documentation.
eui/packages/eui/src/services/window_event/window_event.ts
Lines 13 to 16 in 5d0fffa
Replace markdown link syntax with plain text to avoid docgen parser issues. The docgen tool automatically creates links for recognized TypeScript types like WindowEventMap without needing explicit markdown syntax. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Reflected. see updated screenshot in the PR description |
Summary
Fixes #9729
The
EuiWindowEventeventprop is typed askeyof WindowEventMap, so the props table only ever showed that raw type name without explaining what it means or where to find the valid values. This adds a short sentence linkingWindowEventMapto its actual definition so readers can find the exact accepted event names.Note:
WindowEventMapis a TypeScript-only interface (not a documented Web API), so there's no MDN page for it — the link points to the interface definition in the TypeScript repo, pinned to thetypescriptversion EUI currently depends on (5.8.3) so the link stays accurate.API Changes
N/A — docs-only change.
Screenshots
Impact Assessment
🔴 Breaking changes💅 Visual changes🧪 Test impact🔧 Hard to integrateImpact level: 🟢 None
Release Readiness
FigmaMigration guideAdoption planQA instructions for reviewer
WindowEventMaplink resolves to the TypeScript interface definitionChecklist before marking Ready for Review
QA: Tested light/dark modes, high contrast, mobile, Chrome/Safari/Edge/Firefox, keyboard-only, screen readerQA: Tested in CodeSandbox and KibanaTests: Added/updated Jest, Cypress, and VRTChangelog: Added changelog entry(docs-only change per changelogs.md —skip-changeloglabel requested, see comment below; I don't have permission to self-apply it)Breaking changesReviewer checklist