Note: Academies requires an Academies subscription. If you're interested in Academies, please contact your sales representative or email sales@workramp.com.
Looking to customize the look/feel of our default Academy landing site template? We now offer admins the ability to add CSS and Javascript code directly to their Academy. Read ahead for an overview of the page elements that you can customize with custom code!
Prerequisite
In order to use Custom CSS, your Academy will need to be using a custom domain. To setup a custom domain for your Academy, please follow the steps in our help article.
How to add custom code in the Admin Console
Head over to your Academy Theming Editor to get started!
Javascript: Custom Script Tags
For use cases like installing third-party scripts and snippets, input Javascript code directly into the Custom Script Tags field.
CSS: Master List of Supported CSS Classes
Part I: Header
Part II: Tab Bar
Part III: Footer
Part IV: Body
Collections List (Trainings)
Collection Detail
Guide Overview
Certifications List
Paths List (note: Same as Certifications List)
Path or Certification Overview
NOTE: † = elements that are only visible at the mobile breakpoint (<= 767px width)
Part I: Header
No. | Description | Official ClassName | Notes |
1 | Whole Navigation Area |
| put this on |
2 | Logo anchor <a> (contains logo image) |
|
|
3 | Custom Links List (optional) |
| put on the |
4 | Individual links in Custom Links |
| put this class on the |
5 | Search Bar (contains Input) |
| put on the |
6 | 🔍 icon that opens Search Bar † |
|
|
7 | Close Button for Search † |
|
|
8 | Menu Button † |
|
|
9 | Close Button for Menu † |
|
|
10 | Login Link for Mobile (inside Menu) † |
|
|
11 | Academy Banner Main Heading |
| Appears on multiple pages |
12 | Academy Banner Subheading |
|
|
13 | Nav image background (note that it doesn’t contain the whole nav, though it appears to. It comes after the nav in the DOM) |
| put it on |
14 | Backdrop when the mobile menu is open † |
| this will need to be applied dynamically because it’s not a separate element, but the academy-nav itself that gets this appearance using styled components |
15 | Person icon - Account menu trigger (logged-in view) |
|
|
16 | Login Button (logged-out view) |
|
|
17 | Account Menu Popup |
|
|
18 | Items within Account Popup |
|
|
Part II: Tab Bar
No. | Description | Official ClassName | Notes |
1 | Tab bar itself |
| use the |
2 | Tab within the tab bar |
| use the |
3 | Tab that’s selected |
| note that we don’t have to add a class for this, we should just let the true active class be used by the customer together with the class from #2 |
Part III: Footer
No. | Description | Official ClassName | Notes |
1 | Footer bar itself |
| use the |
2 | Link List |
| use the |
3 | Each Link |
| use the |
4 | Powered by WR Logo |
| use the |
Part IV: Body
Collections List (Trainings)
This is the default landing page.
Note that two sections, Featured and All, will be present if you have “featured” any content. Each one uses these same classes.
No. | Description | Official ClassName | Notes |
1 | Container for all cards |
|
|
2 | Single Card |
| Use the |
3 | Card Image |
|
|
4 | Card body |
|
|
5 | Card footer |
|
|
6 | Card Title |
|
|
7 | Card description |
|
|
8 | Content Type Label |
|
|
9 | Items Count |
|
|
10 | Decorative Shadow elements |
| Customer Note: These elements show a visual hint of how many items are contained in this piece of content. |
14 | Section title |
| Customer Note: This is present if you have set any of your content as Featured. The sections will be labeled “Featured” and “All.” |
15 | Duration (Time Estimate) |
|
|
Collection Detail
No. | Description | Official ClassName | Notes |
1 | Container for all cards |
|
|
2 | Single Card |
| Use the |
3 | Card Image |
|
|
4 | Card body |
|
|
5 | Card footer |
| Customer Note: This element has the top border that makes the visible line |
6 | Card Title |
|
|
7 | Card description |
|
|
8 | Content Type Label |
|
|
11 | Breadcrumb Bar |
|
|
12 | Each Breadcrumb |
|
|
13 | Card CTA |
|
|
Guide Overview
No. | Description | Official ClassName | Notes |
1 | The words “Course Outline” |
|
|
2 | Section Container |
|
|
3 | Section Title |
|
|
4 | Section Tasks Container |
|
|
5 | Module Title |
|
|
6 | Breadcrumb Bar |
|
|
7 | Each Breadcrumb |
|
|
Certifications List
Note that two sections, Featured and All, will be present if you have “featured” any content. Each one uses these same classes.
No. | Description | Official ClassName | Notes |
1 | Container for all cards |
|
|
2 | Single Card |
| Use the |
3 | Card Image |
|
|
4 | Card body |
|
|
5 | Card footer |
| Customer Note: This element has the top border that makes the visible line |
6 | Card Title |
|
|
7 | Card description |
|
|
8 | Content Type Label |
|
|
9 | Items Count |
|
|
10 | Decorative Shadow elements |
| Customer Note: These elements show a visual hint of how many items are contained in this piece of content. |
11 | Breadcrumb Bar |
|
|
12 | Each Breadcrumb |
|
|
13 | Card CTA |
|
|
Paths List (note: Same as Certifications List)
Note that two sections, Featured and All, will be present if you have “featured” any content. Each one uses these same classes.
No. | Description | Official ClassName | Notes |
1 | Container for all cards |
|
|
2 | Single Card |
| Use the |
3 | Card Image |
|
|
4 | Card body |
|
|
5 | Card footer |
| Customer Note: This element has the top border that makes the visible line |
6 | Card Title |
|
|
7 | Card description |
|
|
8 | Content Type Label |
|
|
9 | Items Count |
|
|
10 | Decorative Shadow elements |
| Customer Note: These elements show a visual hint of how many items are contained in this piece of content. |
11 | Breadcrumb Bar |
|
|
12 | Each Breadcrumb |
|
|
13 | Card CTA |
|
|
14 | Section title |
| Customer Note: This is present if you have set any of your content as Featured. The sections will be labeled “Featured” and “All.” |
Path or Certification Overview
No. | Description | Official ClassName | Notes |
1 | Path or Certification Detail Page Body |
| Customer Note: This is an ancestor container for all the below elements. You can prefix your rules with one of these if you want them to apply only for paths or only for certs. Otherwise, you don’t need these classes. |
2 | Summary Box |
|
|
3 | Title |
|
|
4 | Module Count |
|
|
5 | Summary CTA |
|
|
6 | Module Box |
| Customer Note: The thick top border of this box will be gray for uncompleted steps, and green for completed steps. It’s suggested not to theme that bar. INTERNAL DEV NOTE: Put this class on the div that is a sibling of the “dotted line” element (14), not on the parent of the box and dotted line. |
7 | Module Title |
|
|
8 | Module Description |
|
|
9 | Guide Section |
|
|
10 | Guide Task Title |
|
|
11 | Breadcrumb Bar |
|
|
12 | Each Breadcrumb |
|
|
13 | Show/Hide Content Toggle |
|
|
14 | “Dotted Line” |
|
|
General Guidelines for CSS customization
Do:
Target the documented classes
Use pseudoselectors such as :first-child, :before, :hover, etc.
Use these media queries to target mobile or desktop device breakpoints specifically
Use
@media (max-width: 767px)
to target the mobile device breakpointUse
@media (min-width: 768px)
to target the desktop breakpointMost of our elements are present on both views, so if you have a customization for mobile only or desktop only, using these values will sync your changes with the rest of the layout for a consistent experience. (A few elements only exist on one or the other – see reference tables for details)
For best results, avoid:
Targeting elements by a specific tag name when not absolutely necessary (use
.AL_Custom_NavSearchBar
notdiv.AL_Custom_NavSearchBar
)Targeting a specific element using descendent notation (a space) instead of direct child notation (
>
)Bad:
.AL_Custom_NavSearchBar div
Better:.AL_Custom_NavSearchBar > *
Targeting elements that have class names that look like gibberish
e.g. -
sc-gsNilK
These will absolutely change randomly with every code release.
Using tricks like
order
to dramatically relayout the pageThis is pretty brittle and could lead to complete breakage.
Also can cause some unexpected behavior for accessibility.