Skip to main content

WVU Design System FAQs

Below is a list of common questions and answers about the WVU Design System. If you have a question that is not listed, file an issue, and be sure to label it as a question.

  1. How do releases of the Design System work?
  2. How does versioning of components work with Super Theme?
  3. What if my theme is based on an old version of Super Theme? How do I get the new components?
  4. If I submit a new component, how does it get included in the Design System?
  5. What happened to the Polyptych pattern?
  6. Do I need to build the partial when submitting a component for the Super Theme? Shared partials are too complicated.
  7. I’ve created my pages but nothing shows up between the masthead and footer when I go to edit my page. Why?
  8. Some regions have no content in them, but display anyways, breaking my site. What’s up with that?
  9. What if I want to use the Super Theme, but have a couple custom components I also want to use?
  10. I'm using a featurettes component and I think I have my pages labeled correctly, but they aren’t showing up. What’s up?
  11. Why is the content in my editable region disappearing after I publish?
  12. When using the Super Theme, when I update Slot 2 in my custom page data, the component doesn’t show up. What’s wrong?

How do releases of the Design System work?

We will release a new version of the Design System whenever we make updates or add new components. You can see the releases on our Github page.

You can compare the version of your core theme files by looking at the version number in the package.json file in the root of your project, with the number listed under each component name in our Components section.

You can also see our change log to see a detailed list of what updates were made for each release.

These resources will allow you to determine why your theme might not have a certain feature, and/or if you need to update your core theme files to get the newest updates. Typically, all you will need to do to keep up-to-date is update your site data in your config.yml file, or update page data in your template files (more on this in the following section).

How does versioning of components work with the Super Theme?

New versions of the core files will reference the newest version of each component that exists at the time of the core files’ release. For example, let’s say there are two versions of the Action Hero component, action-hero and action-hero-v2 . If your core theme files were created at the same time, or before the action-hero-2 component was created, and you select Action Hero in a Super Theme, it will insert the action-hero-v2 component.

If you have an older theme and want to use a newer version of the component, see the next question.

What if my theme is based on an old version of Super Theme? How do I get new versions of components?

If you have an older version of the theme, and want to reference newer versions of components, you can edit your theme’s custom data. This is how your theme knows which components are available. You can keep old versions of components and/or include new ones. For more on this, see our tutorial on Retrofitting an Old Theme with a New Component.

If I submit a component, how does it get included in the Design System?

Just follow the instructions on our Contribute page.

What happened to the Polyptych pattern?

The old Polyptych pattern is now a Featurettes pattern with a “Featurettes style” of editable-regions. Just enter a limit, and you will get a set of featurettes that have editable regions for an image, header, and body for each, just like the old Polyptych. See our tutorial on How Featurettes Work for more info.

Do I need to build the partial when submitting a component for Super Theme? Shared partials are too complicated.

No. Just submit the HTML and Sass and we can take care of the rest.

After you’ve created a new page, you have to re-open the page’s properties and re-save them before any default content regions will display on your pages. This is a bug we are working to fix.

Some regions have no content in them, but display anyways, breaking my site. What’s up with that?

Some content regions display depending on whether a specified editable region contains content. So if you don’t want them to display, you leave the region blank. But sometimes you think you are leaving it blank when it’s really not. For example, if there is a nonbreaking space, or an empty HTML tag in the region, it will not be visible, but nevertheless can “trick” the region into thinking content exists, and will show the region anyways. To fix this, go into the HTML view of your editable region, manually remove any extra spaces or empty HTML tags, and re-publish the page.

Note that some browsers, for example Firefox, like to add spaces to empty editable regions. Firefox is therefore not a preferred browser for editing in CleanSlate if your site utilizes the type of content-dependent element described above.

What if I want to use the Super Theme, but have a couple custom components I also want to use?

Sometimes you start with a Super Theme and realize the available components don’t do exactly what you want. No problem. You can always add custom partials to your theme. You might copy one of our shared partials and tweak it, or create something new from scratch.

Just put your new partial in the views/components directory of your theme. You can then type the name of this new partial in the “Custom pattern” data field associated with the slot in which the pattern should appear (this is found in your page’s properties under the Data tab).

Note, if there is already a component selected in the “Slot” dropdown menu above, your new pattern will display on your page instead of the selected component.

See our section on Adding Custom Components at the bottom of the Using Slots with Super Theme for more info.

I'm using a featurettes component and I think I have my pages labeled correctly, but they aren’t showing up. What’s up?

Did you check the instance number? Sometimes people forget to include the instance number when they label pages that contain content they wish to displpay. For example, if you have a page with the slug home, and are using a featurettes component with an instance number of 2 on this page, you must use home-featurettes-2 to label any pages with content you wish to display.

Why is the content in my editable region disappearing after I publish?

This is usually due to 2 or more of the same type of component having the same instance number. If this is the case, both components will have the same editable region names, and the content in the last instance of the component will override any previous instance. Just change the instance number of one of the components.

When using the Super Theme, when I edit Slot 2 in my custom page data, no component shows up. What’s wrong?

This is usually because you haven’t update the “Where to display:” option. By default, Slot 2 contains a subnav, which is meant to appear in the side bar of the back page component that is in Slot 1 by default. So if you change Slot 2, make sure you change the “Where to display:” option (usually you set this to “As full-width block”).