woocommerce/plugins/woocommerce-blocks/docs/theming
Albert Juhé Lluveras 8bb217cec6 Show express payment methods in the Cart block (https://github.com/woocommerce/woocommerce-blocks/pull/3004)
* Shown express payment methods in Cart block

* Fixes

* Create usePositionRelativeToViewport hook

* Typo

* Style fixes

* Remove footer push div

* Styling fixes

* Improve code clarity

* Split ExpressCheckoutFormControl into two components

* Rename visibilityObserver to referenceElement

* Replace 'useEffect' with 'useLayoutEffect'

* Add tests for usePositionRelativeToViewport

* Self-closing div

* Add explanatory comment

* Create a shim for IntersectionObserver

* Update express payment components class names

* Add todo comment to remove IntersectionObserver shim when we drop IE11 support
2020-08-20 16:14:12 +02:00
..
README.md Show express payment methods in the Cart block (https://github.com/woocommerce/woocommerce-blocks/pull/3004) 2020-08-20 16:14:12 +02:00
cart-and-checkout.md Document Cart & Checkout button styles (https://github.com/woocommerce/woocommerce-blocks/pull/2814) 2020-07-07 11:59:51 +02:00
class-names-update-280.md Remove text color from Cart and Checkout blocks (https://github.com/woocommerce/woocommerce-blocks/pull/2745) 2020-06-23 11:13:53 +01:00
class-names-update-330.md Show express payment methods in the Cart block (https://github.com/woocommerce/woocommerce-blocks/pull/3004) 2020-08-20 16:14:12 +02:00
product-grid-270.md Fix product grid blocks markup & design inconsistencies (https://github.com/woocommerce/woocommerce-blocks/pull/2428) 2020-06-02 17:06:28 +02:00

README.md

Theming WooCommerce Blocks

This page includes all documentation regarding WooCommerce Blocks and themes.

General concepts

Block and component class names

WooCommerce Blocks follows BEM for class names, as stated in our coding guidelines. All classes start with one of these two prefixes:

  • .wc-block-: class names specific to a single block.
  • .wc-block-components-: class names specific to a component. The component might be reused by different blocks.

The combination of block class names and component class names allows themes to style each component either globally or only in specific blocks. As an example, you could style all prices to be italics with:

/* This will apply to all block prices */
.wc-block-components-formatted-money-amount {
	font-style: italic;
}

But if you only wanted to make it italic in the Checkout block, that could be done adding the block selector:

/* This will apply to prices in the checkout block */
.wc-block-checkout .wc-block-components-formatted-money-amount {
	font-style: italic;
}

Note: for backwards compatibility, some components might have class names with both prefixes (ie: wc-block-sort-select and wc-block-components-sort-select). In those cases, the class name with .wc-block- prefix is deprecated and shouldn't be used in new code. It will be removed in future versions. If an element has both classes always style the one with .wc-block-components- prefix.

Container query class names

Some of our components have responsive classes depending on the container width. The reason to use these classes instead of CSS media queries is to adapt to the container where the block is added (CSS media queries only allow reacting to viewport sizes).

Those classes are:

Container width Class name
>700px is-large
521px-700px is-medium
401px-520px is-small
<=400px is-mobile

As an example, if we wanted to do the Checkout font size 10% larger when the container has a width of 521px or wider, we could do so with this code:

.wc-block-checkout.is-medium,
.wc-block-checkout.is-large {
	font-size: 1.1em;
}

WC Blocks vs. theme style conflicts for semantic elements

WooCommerce Blocks uses HTML elements according to their semantic meaning, not their default layout. That means that some times blocks might use an anchor link (<a>) but display it as a button. Or the other way around, a <button> might be displayed as a text link. Similarly, headings might be displayed as regular text.

In these cases, Blocks include some CSS resets to undo most default styles introduced by themes. A <button> that is displayed as a text link will probably have resets for the background, border, etc. That will solve most conflicts out-of-the-box but in some occasions those CSS resets might not have effect if the theme has a specific CSS selector with higher specificity. When that happens, we really encourage theme developers to decrease their selectors specificity so Blocks styles have preference, if that's not possible, themes can write CSS resets on top.

Legacy classes from WooCommerce (.price, .star-rating, .button...)

WooCommerce Blocks avoids using legacy unprefixed classes as much as possible. However, you might find some of them that have been added for backwards compatibility. We still encourage themes to use the prefixed classes when possible, this avoids conflicts with other plugins, the editor, etc.

Blocks

Other docs