docs: update breadcrumbs JSDoc, add missing styling section#11820
Merged
Conversation
web-padawan
force-pushed
the
breadcrumbs-step12
branch
3 times, most recently
from
cfaf9b5 to
01f1e06
Compare
web-padawan
force-pushed
the
breadcrumbs-step12
branch
from
01f1e06 to
e4ebcd5
Compare
web-padawan
changed the title
|
vursen
approved these changes
May 25, 2026
Collaborator
|
This ticket/PR has been released with Vaadin 25.2.0-beta2. |
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
3 participants
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.
Closes out the Breadcrumbs SDD pipeline at 12/12. Brings the class-level JSDoc on the four public entries up to the standard set by
<vaadin-side-nav>and<vaadin-card>— no behavior changes, no new exports.Changes
vaadin-breadcrumbs.js/.d.ts— HTML usage example, parts table (including theoverlayandoverlay-contentparts re-exported from the internal overlay), state-attributes table, custom CSS properties list (single-bullet).vaadin-breadcrumbs-item.js/.d.ts— HTML usage example, parts table, state-attributes table forcurrent,disabled,focus-ring,focused,has-prefix(framework-neutral wording — noDisabledMixin/FocusMixinmentions in the public docs).implementation-notes.md— Task 12 log entry.What's intentionally absent
@fireslines.grep -rn dispatchEvent packages/breadcrumbs/src/is empty — the component dispatches no public events. The regeneratedcustom-elements.jsonconfirmsevents: []for both elements.vaadin-breadcrumbs-overlay.js. It's@private— not part of the public surface.Verification
yarn lint— cleanyarn lint:types— cleanyarn test --group breadcrumbs— 59 unit + 21 snapshot tests passyarn release:cem— regeneratespackages/breadcrumbs/custom-elements.jsoncleanly; events arrays stay empty for both elements🤖 Generated with Claude Code