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
adding context to UX documentation #43535
Open
brentmackinnon
wants to merge
253
commits into
trunk
Choose a base branch
from
adding-ux-docs-context
base: trunk
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
+29,640
−25,182
Conversation
This file contains 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
Hi @JacklynBiggin, Apart from reviewing the code changes, please make sure to review the testing instructions as well. You can follow this guide to find out what good testing instructions should look like: |
Test Results SummaryCommit SHA: 4c21827
To view the full API test report, click here. To view the full E2E test report, click here. To view all test reports, visit the WooCommerce Test Reports Dashboard. |
…3520) * implement `Choose products for me` button * clean * selectSearchedProductDispatcher accepts products array * rename component with LinkedProductListBlockEdit * pull and set linked products from choose button * changelog * rollback minor changes * fix typo in fn * pull the related product from core entities * minor
* Fix notice template overwrites * Add changefile(s) from automation for the following project(s): woocommerce * Bump template versions * Changing template version numbers to 8.5.0 as they haven’t been touched --------- Co-authored-by: github-actions <github-actions@github.com>
* Replace wordpress Tooltip with woocommerce Tooltip * Add nowrap to links inside tooltip * Add margin-left to tooltip * Move logic to handle not opening multiple popovers to inside tooltip component * Add changelogs * Remove unused prop
* Remove Product Gallery block as default * Add beta label to Product Gallery block title * Add changelog files
* Fix Mini-Cart price disappearing on hover * Add changefile(s) from automation for the following project(s): woocommerce-blocks --------- Co-authored-by: github-actions <github-actions@github.com>
* CYS: fix php warning raise by the Product Collection block * fix typo * Add changefile(s) from automation for the following project(s): woocommerce --------- Co-authored-by: github-actions <github-actions@github.com>
…3499) * Call the `/wc/private/ai/patterns` to remove the `patterns_ai_data` post from the db * Add changefile(s) from automation for the following project(s): woocommerce-beta-tester --------- Co-authored-by: github-actions <github-actions@github.com>
* pick clientId by using hook * do not pass clientId to BlockFill component * pick clientId from core hook * introduce SectionActions slot component * expose SectionActions slot component * fix ts issue * changelog * fix closing component bug * do not pass clientId to the BlockSlot instance * revert changes in the description block * fix name for the section actions component * export section actions properly * add a warning when the slot DOM doesn't exist * define the name explicitely * export SectionActions component name * import SectionActions from product list cmp * rename ProductListBlockEdit component fn
* Move e2e HPOS disabled tests to matrix * Changelog --------- Co-authored-by: Jon Lane <jon.lane@automattic.com>
Delete changelog files for 43506 Co-authored-by: WooCommerce Bot <no-reply@woo.com>
Delete changelog files for 43504 Co-authored-by: WooCommerce Bot <no-reply@woo.com>
Delete changelog files for 43497 Co-authored-by: WooCommerce Bot <no-reply@woo.com>
Delete changelog files for 43550 Co-authored-by: WooCommerce Bot <no-reply@woo.com>
* Move ProductTemplate type * useProductTemplate * Use useProductTemplate * Use useLayoutTemplate * Handle if window.productBlockEditorSettings doesn't exist * Unit tests for useProductTemplate * Fix fallback in useProductTemplate * Remove layoutTemplates from ProductEditorSettings on client * Fallback to simple-product layout template * Unit test to verify the standard product template is used if product type is variable * Use standard product template if product type is variable * Unit test to verify product type is used to match if product template id matches a template with a different product type * Make sure product type matches on product template, unless variable, in which case we match simple * Remove layoutTemplates and layoutTemplateEvents from global * Changelog * Changelog * Import types only
…mo in Settings > Payments (#43436) * Do not sanitize WooCommerce Subscriptiion column HTML in Settings > Payments methods table * Add features supports entry to pseudo-gateway WCPay Promotion * Add changelog * Add changelog entry for woocommerce-admin * Lint fixes
…n pop-up is open (#43378) * Prevent body from scrolling when pop-up is open * Add changefile(s) from automation for the following project(s): woocommerce-blocks * Add namespace to the modal-open css class * Fix class name for the Product Gallery block --------- Co-authored-by: github-actions <github-actions@github.com>
* Retrieve new variations if not already generating * Add changelog * Fix lint error
* Remove variable-product-template from the product template list * Add changelog files * Redirect the variable product to the new experience now that is does not have a product template anymore * Fix php linter error
This adds support for using the `pnpm utils ci-jobs` command in our `ci.yml` file. One of the bigger benefits to this change too is that we're now distributing a bundled version of the utils tool. This lets us run it without actually having to install the repo and will let us speed up any workflows that currently do.
* clarify comment in maybe_sync_order * Add changefile(s) from automation for the following project(s): woocommerce * appease the linter --------- Co-authored-by: github-actions <github-actions@github.com>
…tock status (#43548) * Add test to check Product Collection filtering by tags * Set single product out of stock and unskip the test for stock status * Add changelog * Use more specific selector * Update variables holding products in products.sh to keep the same convention
* Add "No AI" banner image and center banner content * Add changefile(s) from automation for the following project(s): woocommerce --------- Co-authored-by: github-actions <github-actions@github.com>
…43555) * handle section actions styles from section block * rename DownloadBlockEdit * remove unneeded wrap el from linked product list * put Choose an Image button in the actions section * move attribute control to block actions section * changelog * remove unused clientId prop * tweak Image button * remove `should show subtitle and "Add new" button` test
* Initial migration * Add additional links to code reference * Fix lint indentation issue * Add nav_args['parentPath'] documentation * Minor code style fix (spacing) * Update add_extension_register_page example to adhere to guidelines * Update woocommerce_admin_pages_list filter example to conform to guidelines * Update parentPath doc to make it clear that it is part of the JS config, not the PHP config
* Remove the required validation constraint from the LINK TO THE EXTERNAL PRODUCT field * Add changelog file
Delete changelog files for 43641 Co-authored-by: WooCommerce Bot <no-reply@woo.com>
* Always show Variation options and Variations sections within the Variations tab * Remove woocommerce/product-variations-fields block since it's not needed anymore * Create ProductTShirt image for variation options empty state * Add renderCustomEmptyState to the attribute control component to be able to set a not default empty state * Render a custom empty state for variation options * Adds defaultSearch prop to NewAttributeModal so it can be used to start searching right after the modal is shown * Let the empty state adds an attribute that matches a given text * Add changelog files * Fix linter errors
* Fix broken link to debugging doc * Update docs manifest
… of Single Product block (#44123) * Initial approach to fix incorrect product data displayed in Product Collection in context of Single Product block * Remove the BlockCOntextProvider * Add Block context for title and summary * Add changelog * Improve typing * Add E2E test with Product Collection inside Single Product block * Improve insertBLock function description * Make productPrices selector in Product Collectionmore specific * Extract components props into a types
* CYS - Core: add integration with the font library * install font only when necessary * refactor logic * add try catch * renaming font * refactor some code * refactor some logic * Add changefile(s) from automation for the following project(s): woocommerce * remove not used import * avoid mutability * improve performance * update name variable * fix naming * fix endpoints after font collection rest controller improvements * use promise.all into the map * improve performance * fix lint error --------- Co-authored-by: github-actions <github-actions@github.com>
* update .npmrc * try project specific .npmrc * try whoami * try package .npmrc * whitespace * try in tool * try adding line * set auth explicitly * test whoami * does this work? * add script call
* CYS - AI flow: fix regression - no fonts visible * Add changefile(s) from automation for the following project(s): woocommerce * Trigger Build * fix lint error --------- Co-authored-by: github-actions <github-actions@github.com>
* updating link on wccli readme * Fix links that were incorrect * Update docs manifest --------- Co-authored-by: Jacklyn Biggin <hi@jacklyn.dev>
* moving webhooks doc * Move webhooks doc to building a woo store It's not really extension development related * Update docs manifest --------- Co-authored-by: Jacklyn Biggin <hi@jacklyn.dev>
* Initial working version * Update scrolling behavior in product collection block frontend This commit updates the scrolling behavior in the product collection block's frontend script. Previously, the code focused on the first anchor or button within a product collection block. This approach was taken to maintain accessibility and ensure that the focused element was scrolled into view. However, this behavior has been changed to improve the user experience. The updated code now directly scrolls to the first product in the collection. This is achieved by selecting the product using a new selector that targets the `.wc-block-product` class within the `.wc-block-product-template` of the specified `data-wc-navigation-id`. Once the product is selected, the `scrollIntoView` method is used with smooth behavior and start block alignment, offering a more visually appealing scroll effect. This change enhances the user experience by smoothly directing attention to the beginning of the product collection, making it easier for users to browse products. * Remove code related to animation * Fix the issue related to pagination block rendering - I have improved the code by breaking it into smaller functions - Added unique `data-wc-key` to each anchor tag * Enhance Product Collection Block with Interactive Prefetching * Refine Prefetch Logic & other improvements This commit further refines the prefetch logic and interactivity in the Product Collection block. It focuses on enhancing code clarity and improving the prefetch behavior based on user interactions. Key changes include: 1. Renamed 'isPrefetchNextAndPreviousLink' to 'isPrefetchNextOrPreviousLink' in ProductCollectionStoreContext for better readability and accuracy. 2. Modified the scrollToFirstProductIfNotVisible function to accept a wcNavigationId as a parameter instead of a reference 3. Introduced checks for the existence of wcNavigationId in scrollToFirstProductIfNotVisible to prevent unnecessary executions. 4. Updated comments throughout frontend.tsx for enhanced clarity, explaining the prefetch logic and its triggers in detail. 5. Adjusted the logic in the navigate and prefetch functions to align with the new context structure and prefetch strategy. 6. In ProductCollection.php, updated data attributes to align with the revised prefetch strategy. 7. Refined the attribute setting in process_pagination_links function to correctly implement the updated interactivity and prefetch logic. These changes aim to optimize the prefetch functionality, reduce unnecessary prefetching on initial page load, and ensure a smoother and more efficient navigation experience within the Product Collection block. * Add changefile(s) from automation for the following project(s): woocommerce-blocks, woocommerce * Improve comments * Use wp_json_encode for data-wc-interactive attribute This commit updates the `ProductCollection` class to use `wp_json_encode` for setting the `data-wc-interactive` attribute value. Previously, the attribute value was hardcoded as a JSON string. Now, by utilizing `wp_json_encode`, we ensure the JSON encoding is handled correctly by WordPress standards, enhancing readability and maintainability of the code. --------- Co-authored-by: github-actions <github-actions@github.com>
* Make legacy data cleanup more performant * Add legacy data cleanup processor * Make legacy cleanup available in the UI * Add some validation around data synchronizer / data cleanup settings * Add some error handling * Add changelog * Make CI happy * Improve option handling * Add unit tests * Partially revert “real time” cleanup * Re-schedule cleanup on ‘shutdown’ if necessary * Revert CSS changes for HPOS settings screen * Revert JS changes for HPOS settings screen * Allow tools to display a status text * Move order cleanup to Tools * PHPCS fixes * Extend bail early protection to other batch processing functions * Log and stop cleanup when a full batch fails * Make PHPCS happy
Delete changelog files for 44174 Co-authored-by: WooCommerce Bot <no-reply@woo.com>
Delete changelog files for 44178 Co-authored-by: WooCommerce Bot <no-reply@woo.com>
Delete changelog files for 44207 Co-authored-by: WooCommerce Bot <no-reply@woo.com>
* Create DownloadableProductTrait for common downloadable blocks creation * Use DownloadableProductTrait in SimpleProductTemplate * Use DownloadableProductTrait in ProductVariationTemplate * Remeber downloadable files in product variations * Add changelog file * Fix php linter error * Unlink downloads and downloadable product props so they can be managed separately * Remove invalid margin bottom from the uploader label * Add changelog file
* Add completed order email test Add test structure to verify completed order email arrival and content * Verify Email JSON Content Parse email content in JSON format * Record email content in JSON Record email content in JSON * Update emails completed order checks Added checks to verify the content of completed order's emails * Add changefile(s) from automation for the following project(s): woocommerce * Update email content const & remove duplicated test Updated with a new const to record email content const and removed duplicated assertion. --------- Co-authored-by: github-actions <github-actions@github.com>
* avoid crash when Gutenberg is not installed * add issue link * Add changefile(s) from automation for the following project(s): woocommerce --------- Co-authored-by: github-actions <github-actions@github.com>
* Adjusting internal links within docs folder * Update docs-manifest.json * Fix linting + update manifest --------- Co-authored-by: Jacklyn Biggin <hi@jacklyn.dev>
…ce/woocommerce into adding-ux-docs-context
rrennick
added
the
focus: documentation
Issues and PRs related to improving documentation
label
May 21, 2024
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.
Submission Review Guidelines:
Changes proposed in this Pull Request:
Adds context to user-experience documents.
How to test the changes in this Pull Request:
Using the WooCommerce Testing Instructions Guide, include your detailed testing instructions:
Changelog entry
Significance
Type
Message
Comment