CSS & JS

1. General aspects

Every View or Card may have its own CSS and JS code.

To reduce the FCP (First Contentful Paint) metric, CSS code is added within the head tag (at the top of the page), while JS code is added as <script type=module> before the closing "body" tag (at the bottom).

1.1) Just-in-Time assets

Views and Cards are modular, and Advanced Views uses the Just-in-Time strategy for assets. This means that each page will have CSS and JS code only for the items that appear on that page.

This eliminates the need to worry about bundling, allowing you to develop templates that can be mixed by editors in any order without enqueuing them site-wide.

Thanks to the modular approach, you can even use TS/Sass or Tailwind to create independent assets, while Advanced Views will take care of the bundling itself. Read this page to learn how to setup TS/Tailwind properly.

2.How to use it

Add a View and assign fields as usual. (See Creating your first View.)

On the View edit screen, switch to the CSS & JS tab.

Insert or Paste your CSS styles in the CSS Code field.

Click on the Update button to publish your changes.

3. CSS Code

3.1) Selectors

Use the 'Inspect' tool of your browser to identify which class to style. See below for magic shortcuts so you won't need to write repetitive class names when defining your styles.

Magic shortcuts are available (and will use the BEM Unique Name if defined) :

Magic shortcut	Replaced with	BEM Unique Name
#view	.acf-view--id--X	.bem-name
#this__	.acf-view__	.bem-name__
#view__	.acf-view--id--X .acf-view__	.bem-name .bem-name__

Magic shortcut

Replaced with

BEM Unique Name

#view

.acf-view--id--X

.bem-name

#this__

.acf-view__

.bem-name__

#view__

.acf-view--id--X .acf-view__

.bem-name .bem-name__

We recommend using #view { #this__first-field { //... }, #this__second-field { //... } } format, which is possible thanks to the built-in CSS nesting.

Note: These magic shortcuts only work if they are placed in the CSS Code field/file of your View.

In Practice

Display fields and their labels on one line using:

// universal 
// Display fields and labels inline.
#view { 
   > div {
      display: flex;
      gap: 10px;
   }
}

Or alternatively turn on the 'Add Classification Classes' setting in the Template tab, and use the below CSS:

// when adding classification classes
// Display fields and labels inline.
#view {
   #this__row {
      display: flex;
      gap: 10px;
   }
}

Find classes in the Default Template

Once your View has been published/updated, the Twig template will automatically be generated and can be seen in the Template tab.

See the 'class=""' attribute of the Twig template for each field. E.g. class="acf-view__name-link".

Then define the style in the CSS Code field on the CSS & JS tab.

Example:

// add border to image
.acf-view__category-image {
    padding: 3px;
    border: 1px solid #cecece;
}

3.2) Sass usage

In Advanced Views, there is a File System Storage option. If you enable it, you can utilize Sass for View and Card CSS code. Check this page for details.

3.3) Tailwind usage

In Advanced Views, there is a File System Storage option. If you enable it, you can utilize Tailwind for View and Card CSS code. Check this page for details.

4. JS Code

4.1) Web Components

A) Classic Web Components

Every View and Card may have its own JS code. The Advanced Views Framework allows you to employ Web Components without any extra actions. The plugin, out-of-the-box, creates a unique tag wrapper for every View and Card. As soon as you add some JS code, Advanced Views creates a Web Component for the current instance and places your JS code inside.

Tip: If you need to add global JS, you can set the 'Web Component Type' setting of your View or Card to 'None'. Additionally, you can configure the default setting for new Views and Cards inside the Defaults tab of the Framework settings.

This means your code will be automatically executed for every View or Card instance appearing on the page. For example, let's say we have a View and want to track clicks on links inside.

Without Web Components, your JS code might look like this:

document.addEventListener('DOMContentLoaded', function () {
  document.body.querySelectorAll('.my-object').forEach((obj) => {
    obj.querySelectorAll('a').addEventListener('click', function () {
      // some stuff here
    });
  });
});

With Web Components, your code is called for every instance on the page and has the 'this' context. So, you can write it like this:

this.querySelectorAll('a').addEventListener('click', function () {
  // some stuff here
});

Web Components are much shorter and a more convenient way to add custom JS code, especially when dealing with Ajax-loaded content.

In case of the Ajax-loaded content, without Web Components, you would need to employ the MutationObserver to watch for added nodes, find target elements, and add listeners. With Web Components, no extra actions are required. The code above will be called for every new instance out of the box!

Behind the Scenes: If you wonder how it works, below you can see a boilerplate used by AVF. It saves you from writing this manually each time. Note: For Web Component Type Classic, this template is skipped if your JS code field has no content.

// your component name is dynamically put here
class MyComponent extends HTMLElement {
    connectedCallback(){
        "loading"===document.readyState?
            document.addEventListener("DOMContentLoaded",this.setup.bind(this)):
            this.setup()
    }
    setup(){
        // content of your JS code field is dynamically put here
    }
}
// your component name is dynamically put here
customElements.define(MyComponent, 'my-component');

B) Web Components with the Shadow DOM

By default, web components are initialized in the non-shadow (classic) way, meaning they act like any other HTML tags. This entails that all global CSS rules (like p { color: blue; }) will be applied to the inner elements if they match.

The Advanced Views Framework provides the 'Shadow DOM' options, which utilizes the 'shadow DOM' feature of web components. This turns your element into an independent entity, preventing the application of any global styles to its internal items. It's akin to drawing on a clean canvas, where only Views CSS is applied.

The shadow DOM option changes the selector of the element in JavaScript from 'this' to 'this.shadowRoot'. So if you have any JavaScript, don't forget to make this change, as the element and its children are now available solely under the 'this.shadowRoot' selector.

This feature can be immensely useful in various scenarios.

Consider the following:

If the website you are working on is built properly, using a modular approach, it will function seamlessly. However, what if you need to add a new element to an existing website that is constructed without adherence to any specific rules, and has an abundance of global styles that introduce unwanted effects to your new element?

The straightforward solution is to override these styles. However, this process can be time-consuming, and in practice, crafting custom styling for a plain 'ul' might take 20 minutes instead of the usual 3 minutes on a website that follows best practices. This setting circumvents such hassle, allowing you to sidestep the overriding process entirely.

Shadow DOM types

There are two ways to create a shadow DOM (with a declarative template or with JavaScript). AVF supports both methods. While both allow encapsulating the markup and CSS, they have some differences. To pick the best option for your case, check the comparison table below.

Type	Description	Best use cases	Limitations
Declarative Shadow DOM	Made using the <template> tag, which is added on the server side. The element will be rendered before the JavaScript is loaded.	Views and Cards that are available on the page since loading.	Parsed only once, on page load. This means elements with this option can't be added later, e.g., via AJAX (like View inside the "Load More" of Card).
JS Shadow DOM	Made using the attachShadow method call. The element will be rendered as plain HTML and turned into a Shadow DOM on the client side when JavaScript is loaded.	Views inside a Card with the pagination feature active, or any Views and Cards added to the page after it has loaded.	May cause minor layout shifts or visual differences during loading, as all the page styles are applied to the element before JavaScript is loaded and are disabled only after JavaScript is loaded.

Type

Description

Best use cases

Limitations

Declarative Shadow DOM

Made using the <template> tag, which is added on the server side. The element will be rendered before the JavaScript is loaded.

Views and Cards that are available on the page since loading.

Parsed only once, on page load. This means elements with this option can't be added later, e.g., via AJAX (like View inside the "Load More" of Card).

JS Shadow DOM

Made using the attachShadow method call. The element will be rendered as plain HTML and turned into a Shadow DOM on the client side when JavaScript is loaded.

Views inside a Card with the pagination feature active, or any Views and Cards added to the page after it has loaded.

May cause minor layout shifts or visual differences during loading, as all the page styles are applied to the element before JavaScript is loaded and are disabled only after JavaScript is loaded.

C) Global styles (e.g. Tailwind) and Shadow DOM

Tailwind styles are dynamically merged on the page level to avoid class duplication. This means that by default, they won't be included inside elements with the WebComponent Shadow type. However, you can use a workaround to achieve the same experience.

Let's review the following case: we have a page and need to add four elements styled with Tailwind. Meanwhile, we need to avoid Tailwind styles appearing at the page level (the default behavior). To achieve this, we can wrap our elements in a View and define a special comment, which will instruct AVF to place the page styles there. See the example below:

<my-page>
    <template shadowrootmode="open">
        <!--advanced-views:styles/custom-location-->
        <div>
            <div class="flex flex-col font-lato">
                [acf_views name="One block" view-id="669137a4e4654"]
                [acf_views name="Another block" view-id="669138190e3ca"]
            </div>
        </div>
    </template>
</my-page>

In this case, we can use Tailwind for any elements, Views and Cards inside this element, and Tailwind CSS styles won't appear at the page level.

Pro tip: You may need to insert a third-party element between the elements. For example, some form that is already styled by the theme or plugin and needs to be available for JavaScript globally. For this case, you can use the Slots feature, as shown in the example below:

<my-page>
    <template shadowrootmode="open">
        <!--advanced-views:styles/custom-location-->
        <div>
            <div class="flex flex-col font-lato">
                [acf_views name="One block" view-id="669137a4e4654"]
                <slot name="ninja-form"></slot>
                [acf_views name="Another block" view-id="669138190e3ca"]
            </div>
        </div>
    </template>
    <div slot="ninja-form">[ninja_form id=1]</div>
</my-page>

In this case, the content inside the slot will be inserted between the elements but will remain at the page level, making it available for any global CSS and JavaScript.

4.2) WordPress Interactivity API

Check this guide to see how to use WP Interactivity API.

4.3) Employing JS libraries

To add complex interactive elements, like sliders, you'll need to use some JS libraries. If you use the Pro edition, read about the Front-end assets management to see the list of built-in libraries.

If you use the Lite edition, or want to employ a specific library that is missing from the built-in list, you need to:

Enqueue it on the target page
Add code to the JS field of the View or Card to create the instance.

The classic enqueuing in WordPress happens with the wp_enqueue_script function, but to avoid sitewide enqueueing (which is bad for performance), it requires manual detection of the target pages.

That's why we recommend harnessing the modules feature. So, you add import x from "/wp-content/themes/theme_name/assets/library.js" to the top of the JS code, and the browser will automatically load the library only for the necessary pages.

You shouldn't worry about duplications; according to the standard, the browser will import the script only once, even if the same import statement appears in several different Views/Cards.

Notes on the modules

You must have the 'Web Component Type' setting set to 'None'; otherwise, Advanced Views will wrap your JS code into a WebComponent, and the import will cause an error.
You must use the correct path to the JS library

4.4) TypeScript usage

In Advanced Views, there is a File System Storage option. If you enable it, you can utilize TypeScript for View and Card JS code. Check this page for details.

PreviousBlade NextBEM Methodology

Last updated 4 days ago