-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Docs: Collection example #19593
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: Collection example #19593
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds a comprehensive "Collection Example" to the examples folder to demonstrate collection registration, repository implementation, different collection views (table and card), and a dashboard integration.
- Added new collection manifests, repository modules, and view components for table and card layouts.
- Introduced a dashboard example that presents the collection data.
- Updated server extension registration to use optional chaining.
Reviewed Changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/server-extension-registrator.controller.ts | Updated to use optional chaining for the packages list. |
| src/Umbraco.Web.UI.Client/examples/collection/index.ts | Added an entry point to merge collection and dashboard manifests. |
| src/Umbraco.Web.UI.Client/examples/collection/dashboard-with-collection/manifests.ts | New dashboard manifest configuration. |
| src/Umbraco.Web.UI.Client/examples/collection/dashboard-with-collection/dashboard-with-collection.element.ts | Dashboard element implementing the collection view. |
| src/Umbraco.Web.UI.Client/examples/collection/collection/table-view/manifests.ts | New table collection view manifest. |
| src/Umbraco.Web.UI.Client/examples/collection/collection/table-view/index.ts | Re-export file for table view constant. |
| src/Umbraco.Web.UI.Client/examples/collection/collection/table-view/collection-view.element.ts | Table view element rendering collection items. |
| src/Umbraco.Web.UI.Client/examples/collection/collection/repository/* | New repository types, constants, manifests, and implementation for the collection. |
| src/Umbraco.Web.UI.Client/examples/collection/collection/manifests.ts | New collection manifest merging various view and repository manifests. |
| src/Umbraco.Web.UI.Client/examples/collection/collection/card-view/manifests.ts | New card collection view manifest. |
| src/Umbraco.Web.UI.Client/examples/collection/collection/card-view/index.ts | Re-export file for card view constant. |
| src/Umbraco.Web.UI.Client/examples/collection/collection/card-view/collection-view.element.ts | Card view element using a grid layout to display items. |
| src/Umbraco.Web.UI.Client/examples/collection/README.md | Documentation update outlining the collection example features and outstanding tasks. |
Comments suppressed due to low confidence (2)
src/Umbraco.Web.UI.Client/examples/collection/collection/table-view/index.ts:1
- The re-exported constant 'UMB_LANGUAGE_TABLE_COLLECTION_VIEW_ALIAS' is not defined in the corresponding manifests file. Please define this constant in the manifests or remove the re-export if it is not needed.
export { UMB_LANGUAGE_TABLE_COLLECTION_VIEW_ALIAS } from './manifests.js';
leekelleher
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! 🚀
This PR adds a basic "Collection Example" to the examples folder.
The examples include:
Additional things we can include in the example. These will
Dashboard
Workspace View