woocommerce/plugins/woocommerce-blocks/docs/designers/theming/class-names-update-280.md

101 lines
7.3 KiB
Markdown
Raw Normal View History

# Class names update in 2.8.0 <!-- omit in toc -->
## Table of Contents <!-- omit in toc -->
Add Cart/Checkout/Order-Received Templates (https://github.com/woocommerce/woocommerce-blocks/pull/9301) * WIP: dirty attempt to dry run Cart & Checkout templates * Added Cart and Checkout to the template hierarchies * Merge branch 'trunk' into poc/cart_and_checkout_fse_templates * Updated cart & Checkout templates * Order Received FSE template (https://github.com/woocommerce/woocommerce-blocks/pull/8937) * Order Received template bootstrap * typo * WIP: new block * add logic here * Order received classic template * reverted constants.ts * Added the post title (buggy) * Corrected page title * Updated constants.ts * Fixed template typo * removed placeholder for order received block * add order-received template description * updated placeholder description * Formatting fixes * Template description. * replaced hardcoded string with OrderReceivedTemplate::SLUG --------- Co-authored-by: Luigi <gigitux@gmail.com> * Code formatting (https://github.com/woocommerce/woocommerce-blocks/pull/8350) * Code formatting * page_template_hierarchy priority to 1 (https://github.com/woocommerce/woocommerce-blocks/pull/9323) Co-authored-by: Paulo Arromba <17236129+wavvves@users.noreply.github.com> * Migrate Cart and Checkout Pages to the Template Editor when using a FSE theme (https://github.com/woocommerce/woocommerce-blocks/pull/9339) * Introduce woocommerce_blocks_template_content hook * Migrate cart and checkout page content to the template editor * Add redirection from edit page to edit template --------- Co-authored-by: Paulo Arromba <17236129+wavvves@users.noreply.github.com> * Removed header and footer from checkout template. (https://github.com/woocommerce/woocommerce-blocks/pull/9378) * Removed header and footer from checkout template. * Removed header and footer from checkout template migration * Permalink solution for the checkout endpoint/template (https://github.com/woocommerce/woocommerce-blocks/pull/9406) * Checkout endpoint work * Move setting field to util * Include link to edit the template * Remove todo * Refactor checkout templates to share logic (https://github.com/woocommerce/woocommerce-blocks/pull/9411) * Sync endpoints with pages (https://github.com/woocommerce/woocommerce-blocks/pull/9426) * Switch to page syncing * Update settings descriptions --------- Co-authored-by: Paulo Arromba <17236129+wavvves@users.noreply.github.com> * Migrate pages to templates once (https://github.com/woocommerce/woocommerce-blocks/pull/9488) * Migrate content on init, once * Skip migration if page does not exist * Put back HTML for header and footer parts * Fix page redirect due to wrong ID * fix loading template part * Removed unnecessary var * update cart and checkout html templates --------- Co-authored-by: Paulo Arromba <17236129+wavvves@users.noreply.github.com> * Include a notice to redirect user to template editor (https://github.com/woocommerce/woocommerce-blocks/pull/9508) * Template Placeholder Design for the Order Received Template (https://github.com/woocommerce/woocommerce-blocks/pull/9602) * Load frontend styles in editor iframe * Update placeholder to include skeleton and updated icons * Update classic template configs * 1px border for .wp-block-woocommerce-classic-template__placeholder-copy * Show copy on focus * Sample data --------- Co-authored-by: Paulo Arromba <17236129+wavvves@users.noreply.github.com> * Add simplified header on checkout template (https://github.com/woocommerce/woocommerce-blocks/pull/9607) * Added simplified header on checkout template * Moved simplified header to template part * updated constants.ts * added template part to checkout.html * Add missing translation * frontpage_template_hierarchy no longer needed * Allow plugin based template parts (https://github.com/woocommerce/woocommerce-blocks/pull/9667) * Merge branch 'trunk' into add/9288_cart-checkout-order-received_fse_templates * Synced templates on blockified folder * Add blockified order-received.html * removed WooCommerce prefix * Refactor/rebrand order received template to order confirmation (https://github.com/woocommerce/woocommerce-blocks/pull/9734) * rebrand order received to order confirmation * updated descriptions for templates * updated descriptions for order confirmation placeholder * Resolve merge conflict * Resolve merge conflicts * Resolve more merge conflicts after rebase * Fix formatting * Use patterns for localisation (https://github.com/woocommerce/woocommerce-blocks/pull/9883) * e2e tests for cart and checkout templates (https://github.com/woocommerce/woocommerce-blocks/pull/9939) * Merge branch 'trunk' into poc/cart_and_checkout_fse_templates * Merge branch 'trunk' into add/9288_cart-checkout-order-received_fse_templates * Resolve merge conflicts * Add e2e for permalink settings * Test that templates exist * Add test to check that templates can be edited * Add tests to confirm templates can be edited * Ensure cart has contents before running tests on frontend views * Commend out problem test * Make sure search has multiple results * Remove useThrottle - bad rebase * Revert changes to docs after rebase * Revert function call for noReviewsPlaceholder * Bad rebase * Reverts * Remove revertTemplate * Spacing * Wait for networkidle after navigation * Always wait for network * Use button roles in site editor * More specific button locator * Update option comparison * Fix template content * Disable failing tests * Disable failing classic template tests * Use enterEditMode * More enterEditMode usage * enterEditMode * Use test.skip * More robust selectors * Alt iframe selector --------- Co-authored-by: Paulo Arromba <17236129+wavvves@users.noreply.github.com> * Skip flakey test --------- Co-authored-by: Luigi <gigitux@gmail.com> Co-authored-by: Mike Jolley <mike.jolley@me.com>
2023-06-29 13:41:22 +00:00
- [Replaced classes](#replaced-classes)
- [Deprecated classes](#deprecated-classes)
In [WooCommerce Blocks 2.8.0](https://developer.woocommerce.com/2020/06/24/woocommerce-blocks-2-8-release-notes/), we replaced and deprecated some some class names to simplify them, fix inconsistencies, and make it easier to differentiate frontend components from editor components.
## Replaced classes
Some classes that were introduced in 2.6.0 and 2.7.0 and didn't ship in WooCommerce Core have been replaced by new ones. They can be found in this table:
| Removed | New class name |
| -------------------------------------- | ----------------------------------------------------- |
| `wc-block-address-form` | `wc-block-components-address-form` |
| `wc-block-checkout-form` | `wc-block-components-checkout-form` |
| `wc-block-checkout-step` | `wc-block-components-checkout-step` |
| `wc-block-cart__payment-method-icons` | `wc-block-components-payment-method-icons` |
| `wc-blocks-payment-method-icon` | `wc-block-components-payment-method-icon` |
| `wc-block-cart__payment-method-label` | `wc-block-components-payment-method-label` |
| `wc-block-low-stock-badge` | `wc-block-components-product-low-stock-badge` |
| `wc-block-product-metadata` | `wc-block-components-product-metadata` |
| `wc-block-product-name` | `wc-block-components-product-name` |
| `wc-block-product-price` | `wc-block-components-product-price` |
| `wc-block-product-price--regular` | `wc-block-components-product-price__regular` |
| `wc-block-sale-badge` | `wc-block-components-sale-badge` |
| `wc-block-product-variation-data` | `wc-block-components-product-variation-data` |
| `wc-block-cart__shipping-calculator` | `wc-block-components-shipping-calculator` |
| `wc-block-shipping-calculator` | `wc-block-components-shipping-calculator` |
| `wc-block-cart__shipping-address` | `wc-block-components-shipping-address` |
| `wc-block-shipping-rates-control` | `wc-block-components-shipping-rates-control` |
| `wc-block-coupon-code` | `wc-block-components-totals-coupon` |
| `wc-block-cart-coupon-list` | `wc-block-components-totals-discount__coupon-list` |
| `wc-block-totals-footer-item` | `wc-block-components-totals-footer-item` |
| `wc-block-totals-table-item` | `wc-block-components-totals-item` |
| `wc-block-shipping-totals` | `wc-block-components-totals-shipping` |
| `wc-block-checkbox` | `wc-block-components-checkbox` |
| `wc-block-country-input` | `wc-block-components-country-input` |
| `wc-block-loading-mask` | `wc-block-components-loading-mask` |
| `wc-blocks-loading-mask__children` | `wc-block-components-loading-mask__children` |
| `wc-block-quantity-selector` | `wc-block-components-quantity-selector` |
| `wc-block-radio-control` | `wc-block-components-radio-control` |
| `wc-block-select` | `wc-block-components-select` |
| `wc-block-main` | `wc-block-components-main` |
| `wc-block-sidebar-layout` | `wc-block-components-sidebar-layout` |
| `wc-block-sidebar` | `wc-block-components-sidebar` |
| `wc-block-notices__snackbar` | `wc-block-components-notices__snackbar` |
| `wc-block-text-input` | `wc-block-components-text-input` |
| `wc-block-component__title` | `wc-block-components-title` |
| `wc-block-form-input-validation-error` | `wc-block-components-validation-error` |
| `wc-block-checkout__save-card-info` | `wc-block-components-payment-methods__save-card-info` |
**Note:** If not listed, all items in the table above include derived classes.
For example, given that `wc-block-address-form` changed to `wc-block-components-address-form`:
- `wc-block-address-form__company` also changed to `wc-block-components-address-form__company`
- `wc-block-address-form__address_1` also changed to `wc-block-components-address-form__address_1`
In most cases, it should be safe to do a search & replace in the stylesheet replacing the removed class names with the new ones.
## Deprecated classes
Some classes that were introduced in previous versions or that have shipped in WooCommerce Core, have not been removed but are deprecated. Those classes will not be removed until the next major version but all themes are encouraged to update to the new ones as soon as possible:
| Deprecated | New class name |
| --------------------------------- | -------------------------------------------- |
| `wc-block-error` | `wc-block-components-error` |
| `wc-block-product-sort-select` | `wc-block-components-product-sort-select` |
| `wc-block-formatted-money-amount` | `wc-block-components-formatted-money-amount` |
| `wc-block-checkbox-list` | `wc-block-components-checkbox-list` |
| `wc-block-dropdown-selector` | `wc-block-components-dropdown-selector` |
| `wc-block-filter-submit-button` | `wc-block-components-filter-submit-button` |
| `wc-block-load-more` | `wc-block-components-load-more` |
| `wc-block-pagination` | `wc-block-components-pagination` |
| `wc-block-pagination-page` | `wc-block-components-pagination__page` |
| `wc-block-pagination-ellipsis` | `wc-block-components-pagination__ellipsis` |
| `wc-block-review-list` | `wc-block-components-review-list` |
| `wc-block-review-sort-select` | `wc-block-components-review-sort-select` |
| `wc-block-price-filter` | `wc-block-components-price-slider` |
| `wc-block-form-text-input` | `wc-block-components-price-slider__amount` |
**Note:** if not listed, all items in the table above include derived classes.
For example, given that `wc-block-error` changed to `wc-block-components-error`
- `wc-block-error__company` also changed to `wc-block-components-error__content`
- `wc-block-error__address_1` also changed to `wc-block-components-error__image`
<!-- FEEDBACK -->
---
[We're hiring!](https://woocommerce.com/careers/) Come work with us!
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce/issues/new?assignees=&labels=type%3A+documentation&template=suggestion-for-documentation-improvement-correction.md&title=Feedback%20on%20./docs/designers/theming/class-names-update-280.md)
<!-- /FEEDBACK -->