-
Notifications
You must be signed in to change notification settings - Fork 0
APIDOCS 2573: Docs improvements for Collection #57
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
base: main
Are you sure you want to change the base?
Conversation
* | ||
* > **Note:** This component is only relevant for [Wix Vibe](https://support.wix.com/en/article/wix-vibe-an-overview) and [Wix Headless](https://dev.wix.com/docs/go-headless/get-started/about-headless/about-wix-headless) developers. | ||
* | ||
* @component |
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.
How does this actually work? With the standard API getCollection(), a user needs to provide an ID.
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.
Ohhh I think that this “Collection” is just a group of items displayed in a grid.
I thought that it was like in Wix Stores, where a “Collection” refers to themed groups of products that store owners create to organize their catalog.
I think there is a naming concern here.
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.
A couple of things:
- I see we already have the import statement as part of the docs. I think it's a good idea to also include a usage example, similar to what exists for SEO?
- I know there was discussion of adding some kind of playground where users could interact with each component. I'm not sure where that's at, but in the meantime, maybe we consider (if possible in jsdoc) adding an image to the description. This isn't our usual style but may help users by giving them an idea of the component's visual appearance.
@taliasa44 As for your comments above:
|
|
||
/** | ||
* Headless component for load more products functionality | ||
* Note: V3 API uses simplified loading without traditional pagination |
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.
Why was this note here?
Overview
Docs improvements for:
Related links
Jira ticket
Slack thread with some design feedback