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

Add theming docs #2691

Merged
merged 6 commits into from Jun 11, 2020
Merged

Add theming docs #2691

merged 6 commits into from Jun 11, 2020

Conversation

Aljullu
Copy link
Contributor

@Aljullu Aljullu commented Jun 11, 2020

Fixes #2538.
Part of #2457.

  • Update the coding guidelines according to the discussion in Revisit our CSS selectors naming #2457.
  • Update some class names following these new guidelines. If this PR is approved, I will continue with more class names.
  • Add docs about the class name changes in 2.8.0, so theme developers can see if any of the class names they are using has been removed or deprecated.
  • Add docs targeting theme developers explaining our class name usage and how to style blocks. I think I covered most of the topics that might be confusing for themes, but if you have any idea of something else to add, feel free to comment it.

Release notes

Some class names have been updated in order to fix inconsistencies and make them easier to style. Docs about this change can be found in:

https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/main/docs/theming/class-names-update-280.md

See follow-up PR that modified more class names: #2711.

Changelog

Update some class names to match the new guidelines. Check the docs in order to see which class names have been updated.

@Aljullu Aljullu added status: needs review needs: dev note PR that has some text that needs to be included in the release notes. labels Jun 11, 2020
@Aljullu Aljullu added this to the 2.8.0 milestone Jun 11, 2020
@Aljullu Aljullu requested a review from a team as a code owner June 11, 2020 09:47
@Aljullu Aljullu self-assigned this Jun 11, 2020
@Aljullu Aljullu requested review from nerrad and removed request for a team June 11, 2020 09:47
@github-actions
Copy link
Contributor

github-actions bot commented Jun 11, 2020

Size Change: +354 B (0%)

Total Size: 1.57 MB

Filename Size Change
build/all-products-frontend.js 38.9 kB +32 B (0%)
build/all-products.js 21.7 kB +26 B (0%)
build/all-reviews-legacy.js 9.24 kB +28 B (0%)
build/all-reviews.js 9.54 kB +27 B (0%)
build/cart-frontend.js 63.6 kB +7 B (0%)
build/cart.js 32.9 kB +6 B (0%)
build/checkout-frontend.js 80.1 kB +6 B (0%)
build/checkout.js 38.4 kB +6 B (0%)
build/price-filter-frontend.js 14.1 kB +6 B (0%)
build/price-filter.js 10 kB +5 B (0%)
build/reviews-by-category-legacy.js 11.2 kB +29 B (0%)
build/reviews-by-category.js 11.6 kB +24 B (0%)
build/reviews-by-product-legacy.js 12.7 kB +28 B (0%)
build/reviews-by-product.js 13.1 kB +34 B (0%)
build/reviews-frontend-legacy.js 8.08 kB +28 B (0%)
build/reviews-frontend.js 8.93 kB +29 B (0%)
build/single-product-frontend.js 41.7 kB +9 B (0%)
build/single-product.js 15.6 kB +6 B (0%)
build/style-legacy-rtl.css 5.5 kB +6 B (0%)
build/style-legacy.css 5.5 kB +5 B (0%)
build/style-rtl.css 17.3 kB +4 B (0%)
build/style.css 17.3 kB +3 B (0%)
ℹ️ View Unchanged
Filename Size Change
build/active-filters-frontend.js 7.21 kB 0 B
build/active-filters.js 7.94 kB 0 B
build/attribute-filter-frontend.js 16.7 kB 0 B
build/attribute-filter.js 11.5 kB 0 B
build/block-error-boundary-legacy.js 775 B 0 B
build/block-error-boundary.js 774 B 0 B
build/blocks-legacy.js 2.92 kB 0 B
build/blocks.js 2.92 kB 0 B
build/custom-select-control-style-legacy.js 782 B 0 B
build/custom-select-control-style.js 782 B 0 B
build/editor-legacy-rtl.css 12.5 kB 0 B
build/editor-legacy.css 12.5 kB 0 B
build/editor-rtl.css 13.5 kB 0 B
build/editor.css 13.5 kB 0 B
build/featured-category-legacy.js 7.27 kB 0 B
build/featured-category.js 7.59 kB 0 B
build/featured-product-legacy.js 9.51 kB 0 B
build/featured-product.js 9.83 kB 0 B
build/handpicked-products-legacy.js 6.91 kB 0 B
build/handpicked-products.js 7.24 kB 0 B
build/product-best-sellers-legacy.js 6.99 kB 0 B
build/product-best-sellers.js 7.3 kB 0 B
build/product-categories-legacy.js 3.22 kB 0 B
build/product-categories.js 3.21 kB 0 B
build/product-category-legacy.js 7.91 kB 0 B
build/product-category.js 8.25 kB 0 B
build/product-list-style-legacy.js 774 B 0 B
build/product-new-legacy.js 7.15 kB 0 B
build/product-new.js 7.47 kB 0 B
build/product-on-sale-legacy.js 7.52 kB 0 B
build/product-on-sale.js 7.87 kB 0 B
build/product-search-legacy.js 3.14 kB 0 B
build/product-search.js 3.43 kB 0 B
build/product-tag-legacy.js 6.08 kB 0 B
build/product-tag.js 6.39 kB 0 B
build/product-top-rated-legacy.js 7.12 kB 0 B
build/product-top-rated.js 7.44 kB 0 B
build/products-by-attribute-legacy.js 7.88 kB 0 B
build/products-by-attribute.js 8.19 kB 0 B
build/snackbar-notice-style-legacy.js 778 B 0 B
build/snackbar-notice-style.js 779 B 0 B
build/spinner-style-legacy.js 772 B 0 B
build/spinner-style.js 772 B 0 B
build/vendors-legacy.js 366 kB 0 B
build/vendors-style-legacy-rtl.css 1.03 kB 0 B
build/vendors-style-legacy.css 1.03 kB 0 B
build/vendors-style-legacy.js 103 B 0 B
build/vendors-style-rtl.css 1.03 kB 0 B
build/vendors-style.css 1.03 kB 0 B
build/vendors-style.js 102 B 0 B
build/vendors.js 414 kB 0 B
build/wc-blocks-data.js 7.09 kB 0 B
build/wc-blocks-middleware.js 931 B 0 B
build/wc-blocks-registry.js 1.79 kB 0 B
build/wc-payment-method-cheque.js 794 B 0 B
build/wc-payment-method-paypal.js 830 B 0 B
build/wc-payment-method-stripe.js 11.9 kB 0 B
build/wc-settings.js 2.14 kB 0 B
build/wc-shared-context.js 1.51 kB 0 B

compressed-size-action

Copy link
Contributor

@nerrad nerrad left a comment

Choose a reason for hiding this comment

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

In general this looks great @Aljullu 👏

I've made a couple comments and I'm pre-approving.

docs/theming/class-names-update-280.md Outdated Show resolved Hide resolved
Comment on lines +9 to +11
| Removed | New class name |
| --- | --- |

Copy link
Contributor

Choose a reason for hiding this comment

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

Is this incomplete, or was it intentionally left blank?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, I left it blank in purpose. This will be filled when we replace more classes according to the plan in #2457. I wanted to keep the scope of this PR small and mainly focus in docs, but after merge I will work on a follow-up to handle all the classes that need to be changed and will fill this list accordingly.

Co-authored-by: Darren Ethier <darren@roughsmootheng.in>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
needs: dev note PR that has some text that needs to be included in the release notes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Write documentation for themes on how to style the Cart and Checkout blocks
3 participants