Skip to content
This repository was archived by the owner on Feb 23, 2024. It is now read-only.

Conversation

@nielslange
Copy link
Contributor

Fixes #6945

Notes

In #6612, we ran a Data Store Migration. This PR aims to create the external documentation for the wc/store/checkout data store.

Testing

  1. Open https://github.com/woocommerce/woocommerce-blocks/blob/361b48b6220f57fab8a62b9a9272757530d6f14a/assets/js/data/checkout/selectors.ts
  2. Verify that checkout.md from this PR documents all selector that appear in the document mentioned before.
  • Do not include in the Testing Notes

@nielslange nielslange added status: needs review focus: documentation This issue is a request for better documentation. skip-changelog PRs that you don't want to appear in the changelog. block: checkout Issues related to the checkout block. labels Sep 8, 2022
@rubikuserbot rubikuserbot requested review from a team and tarhi-saad and removed request for a team September 8, 2022 04:11
@github-actions
Copy link
Contributor

github-actions bot commented Sep 8, 2022

The release ZIP for this PR is accessible via:

https://wcblocks.wpcomstaging.com/wp-content/uploads/woocommerce-gutenberg-products-block-7085.zip

@github-actions
Copy link
Contributor

github-actions bot commented Sep 8, 2022

Size Change: 0 B

Total Size: 893 kB

ℹ️ View Unchanged
Filename Size
build/active-filters-frontend.js 7.62 kB
build/active-filters.js 8.29 kB
build/all-products-frontend.js 18.2 kB
build/all-products.js 34 kB
build/all-reviews.js 7.79 kB
build/attribute-filter-frontend.js 22.3 kB
build/attribute-filter.js 13.3 kB
build/blocks-checkout.js 17.5 kB
build/cart-blocks/cart-accepted-payment-methods-frontend.js 1.17 kB
build/cart-blocks/cart-cross-sells-frontend.js 253 B
build/cart-blocks/cart-cross-sells-products--product-add-to-cart-frontend.js 5.43 kB
build/cart-blocks/cart-cross-sells-products-frontend.js 4.66 kB
build/cart-blocks/cart-express-payment-frontend.js 5.08 kB
build/cart-blocks/cart-items-frontend.js 299 B
build/cart-blocks/cart-line-items--mini-cart-contents-block/products-table-frontend.js 5.27 kB
build/cart-blocks/cart-line-items-frontend.js 430 B
build/cart-blocks/cart-order-summary-frontend.js 1.1 kB
build/cart-blocks/cart-totals-frontend.js 322 B
build/cart-blocks/empty-cart-frontend.js 345 B
build/cart-blocks/filled-cart-frontend.js 781 B
build/cart-blocks/order-summary-coupon-form-frontend.js 2.64 kB
build/cart-blocks/order-summary-discount-frontend.js 2.15 kB
build/cart-blocks/order-summary-fee-frontend.js 273 B
build/cart-blocks/order-summary-heading-frontend.js 454 B
build/cart-blocks/order-summary-shipping--checkout-blocks/order-summary-shipping-frontend.js 6.37 kB
build/cart-blocks/order-summary-shipping-frontend.js 427 B
build/cart-blocks/order-summary-subtotal-frontend.js 274 B
build/cart-blocks/order-summary-taxes-frontend.js 434 B
build/cart-blocks/proceed-to-checkout-frontend.js 1.15 kB
build/cart-frontend.js 48 kB
build/cart.js 50.3 kB
build/checkout-blocks/actions-frontend.js 1.42 kB
build/checkout-blocks/billing-address--checkout-blocks/shipping-address-frontend.js 4.11 kB
build/checkout-blocks/billing-address-frontend.js 890 B
build/checkout-blocks/contact-information-frontend.js 2.84 kB
build/checkout-blocks/express-payment-frontend.js 5.37 kB
build/checkout-blocks/fields-frontend.js 345 B
build/checkout-blocks/order-note-frontend.js 1.08 kB
build/checkout-blocks/order-summary-cart-items-frontend.js 3.66 kB
build/checkout-blocks/order-summary-coupon-form-frontend.js 2.79 kB
build/checkout-blocks/order-summary-discount-frontend.js 2.27 kB
build/checkout-blocks/order-summary-fee-frontend.js 276 B
build/checkout-blocks/order-summary-frontend.js 1.11 kB
build/checkout-blocks/order-summary-shipping-frontend.js 600 B
build/checkout-blocks/order-summary-subtotal-frontend.js 275 B
build/checkout-blocks/order-summary-taxes-frontend.js 435 B
build/checkout-blocks/payment-frontend.js 7.68 kB
build/checkout-blocks/shipping-address-frontend.js 1.03 kB
build/checkout-blocks/shipping-methods-frontend.js 4.75 kB
build/checkout-blocks/terms-frontend.js 1.23 kB
build/checkout-blocks/totals-frontend.js 325 B
build/checkout-frontend.js 49.9 kB
build/checkout.js 43.7 kB
build/featured-category.js 13.2 kB
build/featured-product.js 13.4 kB
build/general-style-rtl.css 1.29 kB
build/general-style.css 1.29 kB
build/handpicked-products.js 7.33 kB
build/legacy-template.js 2.84 kB
build/mini-cart-component-frontend.js 16.9 kB
build/mini-cart-contents-block/empty-cart-frontend.js 366 B
build/mini-cart-contents-block/filled-cart-frontend.js 229 B
build/mini-cart-contents-block/footer--mini-cart-contents-block/products-table-frontend.js 4.69 kB
build/mini-cart-contents-block/footer-frontend.js 7.39 kB
build/mini-cart-contents-block/items-frontend.js 237 B
build/mini-cart-contents-block/products-table-frontend.js 290 B
build/mini-cart-contents-block/shopping-button-frontend.js 288 B
build/mini-cart-contents-block/title-frontend.js 367 B
build/mini-cart-contents.js 23.4 kB
build/mini-cart-frontend.js 1.72 kB
build/mini-cart.js 4.57 kB
build/price-filter-frontend.js 13.4 kB
build/price-filter.js 9.35 kB
build/price-format.js 1.19 kB
build/product-add-to-cart--product-button--product-category-list--product-image--product-price--product-r--a0326d00.js 226 B
build/product-add-to-cart--product-button--product-image--product-title.js 2.69 kB
build/product-add-to-cart-frontend.js 2.6 kB
build/product-add-to-cart.js 6.87 kB
build/product-best-sellers.js 7.7 kB
build/product-button--product-category-list--product-image--product-price--product-rating--product-sale-b--e17c7c01.js 432 B
build/product-button--product-image--product-rating--product-sale-badge--product-title.js 302 B
build/product-button-frontend.js 1.89 kB
build/product-button.js 1.58 kB
build/product-categories.js 2.36 kB
build/product-category-list-frontend.js 879 B
build/product-category-list.js 503 B
build/product-category.js 8.69 kB
build/product-image-frontend.js 1.91 kB
build/product-image.js 1.61 kB
build/product-new.js 7.69 kB
build/product-on-sale.js 8.02 kB
build/product-price-frontend.js 1.91 kB
build/product-price.js 1.53 kB
build/product-query.js 646 B
build/product-rating-frontend.js 1.18 kB
build/product-rating.js 771 B
build/product-sale-badge-frontend.js 1.14 kB
build/product-sale-badge.js 816 B
build/product-search.js 2.61 kB
build/product-sku-frontend.js 380 B
build/product-sku.js 380 B
build/product-stock-indicator-frontend.js 992 B
build/product-stock-indicator.js 623 B
build/product-summary-frontend.js 1.28 kB
build/product-summary.js 920 B
build/product-tag-list-frontend.js 873 B
build/product-tag-list.js 497 B
build/product-tag.js 8.05 kB
build/product-title-frontend.js 1.34 kB
build/product-title.js 938 B
build/product-top-rated.js 7.93 kB
build/products-by-attribute.js 8.62 kB
build/reviews-by-category.js 11.3 kB
build/reviews-by-product.js 12.4 kB
build/reviews-frontend.js 7.02 kB
build/single-product-frontend.js 21.5 kB
build/single-product.js 10.1 kB
build/stock-filter-frontend.js 7.61 kB
build/stock-filter.js 7.55 kB
build/vendors--cart-blocks/cart-cross-sells-products--cart-blocks/cart-line-items--cart-blocks/cart-order--04fe80d1-frontend.js 5.26 kB
build/vendors--cart-blocks/cart-cross-sells-products--cart-blocks/order-summary-shipping--checkout-blocks--18f9376a-frontend.js 19.1 kB
build/vendors--cart-blocks/cart-cross-sells-products--product-add-to-cart-frontend.js 6.92 kB
build/vendors--cart-blocks/cart-line-items--checkout-blocks/order-summary-cart-items--mini-cart-contents---233ab542-frontend.js 3.14 kB
build/vendors--cart-blocks/order-summary-shipping--checkout-blocks/billing-address--checkout-blocks/order--5b8feb0b-frontend.js 4.85 kB
build/vendors--mini-cart-contents-block/footer-frontend.js 6.86 kB
build/wc-blocks-data.js 9.9 kB
build/wc-blocks-editor-style-rtl.css 5.24 kB
build/wc-blocks-editor-style.css 5.24 kB
build/wc-blocks-google-analytics.js 1.56 kB
build/wc-blocks-middleware.js 931 B
build/wc-blocks-registry.js 2.7 kB
build/wc-blocks-shared-context.js 1.51 kB
build/wc-blocks-shared-hocs.js 1.71 kB
build/wc-blocks-style-rtl.css 23.9 kB
build/wc-blocks-style.css 23.8 kB
build/wc-blocks-vendors-style-rtl.css 1.95 kB
build/wc-blocks-vendors-style.css 1.95 kB
build/wc-blocks-vendors.js 54.5 kB
build/wc-blocks.js 2.63 kB
build/wc-payment-method-bacs.js 816 B
build/wc-payment-method-cheque.js 811 B
build/wc-payment-method-cod.js 909 B
build/wc-payment-method-paypal.js 837 B
build/wc-settings.js 2.6 kB

compressed-size-action

Copy link
Contributor

@alexflorisca alexflorisca left a comment

Choose a reason for hiding this comment

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

Nice work @nielslange, this looks good but let's wait to make a decision on how we continue with the data store work based on pdFofs-fT-p2

@nielslange
Copy link
Contributor Author

Nice work @nielslange, this looks good but let's wait to make a decision on how we continue with the data store work based on https://woocheckout.wordpress.com/2022/09/06/data-architecture-for-cart-checkout-block/

Sure, @alexflorisca.

@nielslange nielslange closed this Sep 9, 2022
@nielslange nielslange reopened this Sep 9, 2022
Copy link
Contributor

@opr opr left a comment

Choose a reason for hiding this comment

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

Thanks for documenting these selectors, Niels! Just a couple of comments and we should be good to go 👏🏼

Copy link
Contributor

@alexflorisca alexflorisca left a comment

Choose a reason for hiding this comment

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

Yeah, thanks for making those changes Niels, makes sense to leave it as you have it. Good work, everything looks good 👍 Let's wait to merge this until we merge the data store work into trunk though otherwise it will document things that aren't yet there! Would you mind changing the branch that it gets merged into from trunk to feature/data-store-refactor

@github-actions github-actions bot added this to the 8.6.0 milestone Sep 22, 2022
@alexflorisca alexflorisca removed this from the 8.6.0 milestone Sep 22, 2022
@nielslange nielslange changed the base branch from trunk to feature/data-store-refactor September 23, 2022 04:15
@nielslange nielslange changed the base branch from feature/data-store-refactor to trunk September 23, 2022 04:18
@nielslange nielslange force-pushed the add/add-external-docs-for-the-wc-store-checkout-data-store branch from 23ea7ed to 329884c Compare September 23, 2022 04:23
@nielslange nielslange changed the base branch from trunk to feature/data-store-refactor September 23, 2022 04:23
@nielslange nielslange merged commit 2618506 into feature/data-store-refactor Sep 23, 2022
@nielslange nielslange deleted the add/add-external-docs-for-the-wc-store-checkout-data-store branch September 23, 2022 04:33
@nielslange
Copy link
Contributor Author

Yeah, thanks for making those changes Niels, makes sense to leave it as you have it. Good work, everything looks good 👍 Let's wait to merge this until we merge the data store work into trunk though otherwise it will document things that aren't yet there! Would you mind changing the branch that it gets merged into from trunk to feature/data-store-refactor

Thanks for your review, @alexflorisca. I just rebased this PR from trunk to feature/data-store-refactor and merged it.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

block: checkout Issues related to the checkout block. focus: documentation This issue is a request for better documentation. skip-changelog PRs that you don't want to appear in the changelog.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Write external documentation for the wc/store/checkout data store

4 participants