docs: add code examples for Menu, Notifications, Paginator#751
Open
fateeand wants to merge 5 commits into
Open
docs: add code examples for Menu, Notifications, Paginator#751fateeand wants to merge 5 commits into
fateeand wants to merge 5 commits into
Conversation
fateeand
requested review from
TerranceKhumalo-absa,
korel-san and
lukasmatta
as code owners
July 17, 2026 09:49
Contributor
Coverage report for library
Test suite run success2386 tests passing in 76 suites. Report generated by 🧪jest coverage report action from 1ddc95f |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances the Composition app documentation by adding “live” code blocks (via CodeExampleComponent) to the Menu, Notification, and Paginator documentation pages, so users can see rendered examples alongside the corresponding HTML/TS snippets.
Changes:
- Added new
*.examples.tsfiles that define HTML/TS snippet strings for each docs page. - Updated the Menu, Notification, and Paginator docs pages to render examples inside
<app-code-example>. - Simplified related page styling to match the new example layout.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| projects/composition/src/app/pages/paginator-page/paginator-page.examples.ts | Adds code-snippet definitions for paginator usage. |
| projects/composition/src/app/pages/paginator-page/paginator-page.component.ts | Wires CodeExampleComponent and examples data into the paginator docs page. |
| projects/composition/src/app/pages/paginator-page/paginator-page.component.html | Wraps the paginator demo in <app-code-example>. |
| projects/composition/src/app/pages/notification-page/notification-page.examples.ts | Adds multiple notification service usage snippets (HTML + TS). |
| projects/composition/src/app/pages/notification-page/notification-page.component.ts | Wires CodeExampleComponent and examples data into the notification docs page. |
| projects/composition/src/app/pages/notification-page/notification-page.component.scss | Updates styles for section titles in the new layout. |
| projects/composition/src/app/pages/notification-page/notification-page.component.html | Replaces the old button groups with multiple <app-code-example> blocks. |
| projects/composition/src/app/pages/menu-page/menu-page.examples.ts | Adds menu usage snippets (HTML + TS) for multiple scenarios. |
| projects/composition/src/app/pages/menu-page/menu-page.component.ts | Wires CodeExampleComponent and examples data into the menu docs page. |
| projects/composition/src/app/pages/menu-page/menu-page.component.scss | Removes old group layout styles no longer used by the template. |
| projects/composition/src/app/pages/menu-page/menu-page.component.html | Wraps each menu scenario in <app-code-example> blocks. |
Contributor
Playwright test results
Details
|
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
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.
Adds live code examples to the Menu, Notifications and Paginator components' documentation pages.
Closes #729
Closes #730
Closes #731