Skip to content

Comments

Sync web components documentation with source repository attributes#353

Merged
timowestnosto merged 7 commits intoTechdocsfrom
copilot/align-docs-with-web-components
Feb 20, 2026
Merged

Sync web components documentation with source repository attributes#353
timowestnosto merged 7 commits intoTechdocsfrom
copilot/align-docs-with-web-components

Conversation

Copy link

Copilot AI commented Feb 20, 2026

  • Review current documentation and compare with web-components repository
  • Update Campaign component attributes (add nav-synced)
  • Update Image component attributes (add missing attributes: loading, fetch-priority, breakpoints, unstyled)
  • Update SimpleCard component attributes (add image-mode, variant-id, mock)
  • Update VariantSelector component attributes (add mode, max-values, variant-id, placeholder)
  • Update DynamicCard component attributes (update template deprecation notice, add mock)
  • Update SectionCampaign component attributes (add title-selector)
  • Add Bundle component documentation
  • Verify documentation aligns with web-components repository
  • Address all code review feedback
  • Add default values for Image component attributes
  • Improve SimpleCard variant-id description to emphasize default behavior
  • Add backticks to VariantSelector mode values for clarity

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits February 20, 2026 07:25
Co-authored-by: timowestnosto <13622115+timowestnosto@users.noreply.github.com>
Co-authored-by: timowestnosto <13622115+timowestnosto@users.noreply.github.com>
@timowestnosto timowestnosto marked this pull request as ready for review February 20, 2026 07:27
Copilot AI and others added 3 commits February 20, 2026 07:27
Co-authored-by: timowestnosto <13622115+timowestnosto@users.noreply.github.com>
Co-authored-by: timowestnosto <13622115+timowestnosto@users.noreply.github.com>
Co-authored-by: timowestnosto <13622115+timowestnosto@users.noreply.github.com>
Copilot AI changed the title [WIP] Align documentation with available web components attributes Sync web components documentation with source repository attributes Feb 20, 2026
Copilot AI requested a review from timowestnosto February 20, 2026 07:31
Comment on lines 254 to 261
| `crop` | Shopify only. The crop of the image. Can be "center", "left", "right", "top", or "bottom". |
| `layout` | The layout of the image. Can be "fixed", "constrained", or "fullWidth". Defaults to "constrained". |
| `alt` | Alternative text for the image for accessibility purposes. |
| `sizes` | The sizes attribute for responsive images to help the browser choose the right image size. |
| `loading` | The loading behavior of the image. Use "lazy" for lazy loading or "eager" for immediate loading. |
| `fetch-priority` | Provides a hint to the browser about the priority of this image relative to other images. Can be "high", "low", or "auto". |
| `breakpoints` | Custom widths (as an array of numbers) for responsive image generation. Default breakpoints are generated based on common screen sizes. |
| `unstyled` | When present, prevents inline styles from being applied to the image element. |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be nice to mention the defaults where applicable.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot do it

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Added default values for loading (defaults to "lazy"), fetch-priority (defaults to "auto"), and unstyled (defaults to false) in commit 0ad422a.

| `brand` | Show brand/vendor data. Defaults to `false`. |
| `discount` | Show discount data. Defaults to `false`. |
| `rating` | Show product rating. Defaults to `false`. |
| `variant-id` | The specific variant ID to display. When set, shows this variant's data instead of the default variant. |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it makes more sense to say what's happening by default, rather than "When a variant id is set, will show this variant"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot do it

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to describe the default behavior first: "By default, displays the default variant. When set, shows this variant's data instead." in commit 0ad422a.

| `handle` | **Required.** The Shopify product handle to fetch data for. |
| `preselect` | Whether to automatically preselect the options of the first available variant. Defaults to `false`. |
| `variant-id` | Optional. The ID of the variant to preselect on load. |
| `mode` | Optional. Display mode: "options" or "compact". Defaults to "options". |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"options" or "compact"? Backticks to emphasize these are exact string values.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot do it

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added backticks around "options" and "compact" to emphasize they are exact string values in commit 0ad422a.

…back

Co-authored-by: timowestnosto <13622115+timowestnosto@users.noreply.github.com>
@timowestnosto timowestnosto merged commit 8c1e755 into Techdocs Feb 20, 2026
1 of 3 checks passed
@timowestnosto timowestnosto deleted the copilot/align-docs-with-web-components branch February 20, 2026 09:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants