The Comments List element displays a list of WordPress comments for the currently viewed post.
Add a Comments List element to your post from Add+ > WordPress > Comments List.
Templates
The PHP code in Templates > Template PHP outputs the list of comments. The CSS code in Templates > Template CSS styles the Comments List element and everything within.
Load Preset Template
Load the Templates from the available presets.
Save Current as Preset
If you had made any changes to the template code in either Templates > Template PHP or Templates > Templates CSS and you want to save these changes for use in another Comments List element, enter the name of the new preset and click save.
Style Output
If Selector Detector is enabled, the Style Output button will appear, allowing for further customization of the styles of the Comments List.
Author 诗语
Complete Element Reference
Section, Columns, Div
+Add -> Basics -> Containers
Create page structure and layout.
Further Reading: Layout & Spacing, Basic Elements
Heading, Text, Rich Text
+Add -> Basics -> Text
Further Reading: Basic Elements
Text Link, Link Wrapper, Button
+Add -> Basics -> Links
Further Reading: Basic Elements
Image, Video, Icon
+Add -> Basics -> Visual
Further Reading: Basic Elements
Code Block
+Add -> Basics -> Other
Further Reading: Basic Elements, PHP & HTML, CSS, JavaScript
Inner Content
+Add -> Basics -> Other
Only available for templates; displays the content of the item the template is applied to.
Further Reading: Templating
Slider
+Add -> Helpers -> Slider
Further Reading: Slider
Google Maps
+Add -> Helpers -> Google Maps
Further Reading: Google Maps
Social Icons
+Add -> Helpers -> Social Icons
Further Reading: Social Icons
SoundCloud
+Add -> Helpers -> SoundCloud
Further Reading: SoundCloud
Easy Posts
+Add -> Helpers -> Easy Posts
Simple and flexible way to display posts, pages, or any custom post type in a list, grid, and masonry.
Further Reading: Easy Posts, Templating
Gallery
+Add -> Helpers -> Gallery
Further Reading: Gallery
Testimonial
+Add -> Helpers -> Testimonial
Further Reading: Testimonial
Icon Box
+Add -> Helpers -> Icon Box
Further Reading: Icon Box
Progress Bar
+Add -> Helpers -> Progress Bar
Further Reading: Progress Bar
Pricing Box
+Add -> Helpers -> Pricing Box
Further Reading: Pricing Box
Tabs
+Add -> Helpers -> Tabs
Associate content with multiple tabs, hiding all content but that associated with the active tab.
Further Reading: Tabs
Toggle
+Add -> Helpers -> Toggle
Hide and show any content with a clickable toggle.
Further Reading: Toggle
Superbox
+Add -> Helpers -> Superbox
Two slides of content, with animation options on hover.
Further Reading: Superbox
Header Builder
+Add -> Helpers -> Header Builder
Easily create responsive, sticky, multi-row headers.
Further Reading: Header Builder
Shortcode
+Add -> WordPress -> Shortcode
Display the output of a shortcode in Oxygen.
Further Reading: Embedding Plugins
Shortcode Wrapper
+Add -> WordPress -> Shortcode Wrapper
Place Oxygen elements between the opening and closing tags of a shortcode.
Further Reading: Shortcode Wrapper
Menu
+Add -> WordPress -> Menu
Displays a responsive WordPress menu with various styling options.
Further Reading: Menu
Widgets
+Add -> WordPress -> Widgets
Embed WordPress widgets in Oxygen.
Further Reading: Widgets
Dynamic Data Elements
+Add -> WordPress -> Dynamic Data
Various elements for embedding dynamic data like post title, content, featured image, and more in your pages.
Further Reading: Dynamic Data
Sidebars
+Add -> WordPress -> Sidebars
Display the contents of a WordPress API sidebar in Oxygen.
Further Reading: Widgets
Comments List
+Add -> WordPress -> Comments List
Display the comments made on this post.
Further Reading: Comments List
Comment Form
+Add -> WordPress -> Comment Form
Display a form to leave a comment on this post.
Further Reading: Comment Form
Login Form
+Add -> WordPress -> Login Form
Display a login form.
Further Reading: Login Form
Search Form
+Add -> WordPress -> Search Form
Display a search form.
Further Reading: Search Form
Composite Elements
The Composite Elements library is a paid add-on that introduces an additional collection of elements that can be inserted from the +Add menu.
Composite Elements are different from normal elements in the following ways:
They are marked by an Oxygen logo in the top left corner of their button in the +Add menu
When inserted, they are pulled from our server, similar to the way Design Sets work
Because they are composites, each individual part of a Composite Element can be edited fully within Oxygen
They may include advanced functionality via Code Blocks
The library includes the following composite elements:
Accordion
Back To Top
Dashboard Tabs
Dynamic Slider
Flip Box
Horizontal Divider
Icon Button
Icon List
Image Comparison
Mega Menu
Number Counter
Circular Counter
Review Box
Hover Scroll Image
Section Indicator
Switcher
Table of Contents
Focus Section
Floating Icon Menu
Accordion
View Demo
The Accordion composite behaves like a traditional accordion element, with labels that can be clicked to expand a container and reveal some content.
Configuration Options
By default, only one Accordion content area can be expanded at a time. When a new one is expanded, the previously open Accordion content area is hidden. This behavior can be changed in the Code Block labeled "Accordion Code" within the Accordion container in the Structure Pane. Navigate to the JavaScript editor and find this code on line 4:
var closeOtherToggles = true;
Change "true" to "false" to allow multiple Accordion content areas to be expanded concurrently.
Notes
The accordion content is hidden in the builder by default. To edit the content, you must open the Structure pane and click the eye icon on the right of the Accordion Content.
Back To Top Button
View Demo
The Back To Top Button composite is a button that appears in a fixed location after scrolling a certain distance down the page. Clicking the button brings you back to the top of the page.
Configuration Options
By default, the Back To Top Button composite appears at the bottom right corner of the page after the viewport has scrolled down 300px. The scroll distance can be changed in the Code Block labeled "Back To Top Code" within the Back To Top Button container in the Structure Pane. Navigate to the JavaScript editor and find this code on line 4:
var scrollDistance = 300;
Change 300 to the desired scroll distance.
Dashboard Tabs
View Demo
The Dashboard Tabs composite is a styled Oxygen tabs element with a custom animation for the Tab Contents.
Configuration Options
The Dashboard Tabs composite has no special configuration options.
Dynamic Slider
View Demo
The Dynamic Slider composite is an Oxygen Repeater element that uses swiper.js to convert the Repeater into a slider.
Configuration Options
All elements inside of the Dynamic Slider are normal Oxygen elements using Dynamic Data. The default setup is ideal for displaying a number of posts as a slider, but the elements can be removed or changed to fit your use case.
You can edit the Repeater query by selecting the Repeater in the Structure Pane under Dynamic Slider > Slider Container. This is a normal Repeater element and can be configured in the ordinary way. To learn more about configuring a repeater, review the Repeater documentation.
To change the slider's delay and transition, navigate to the Code Block labeled "Dynamic Slider Code" within the Dynamic Slider container in the Structure Pane. Navigate to the JavaScript editor and find this code on lines 4 and 5:
var delay = 4000;
var transition = 'slide';
Change the delay value to adjust how quickly the slider plays automatically. To change the transition used, change 'slide' to another value supported by swiper.js. The available transitions are "slide", "flip", "cube", and "coverflow".
You can change any other swiper.js configuration by editing the options within the swiper variable in the JavaScript editor of the "Dynamic Slider Code" Code Block. You can learn more about swiper.js configuration options in the swiper.js documentation.
Flip Box
View Demo
The Flip Box composite has a front and back side. When the cursor is hovered over the Flip Box, it rotates with a 3D effect to reveal the back side of the Flip Box.
Configuration Options
The Flip Box composite has no special configuration options.
Horizontal Divider
View Demo
The Horizontal Divider is an icon flanked by two lines and can be used to divide vertical space.
Configuration Options
The Horizontal Divider composite has no special configuration options.
Icon Button
View Demo
The Icon Button composite is a styled link wrapper that contains an icon and a text element.
Configuration Options
The Icon Button composite has no special configuration options.
Icon List
View Demo
The Icon List composite displays a list of text elements and accompanying icons. The list rows alternate in color.
Configuration Options
The Icon List composite has no special configuration options.
Image Comparison
View Demo
The Image Comparison composite displays two images within a single container, and has a draggable icon in the center that allows you to reveal more or less of each image by sliding left and right.
Configuration Options
The Image Comparison composite has a left and right div that contain a background image. These background images are the images used for comparison. To change the images, select the appropriate div and navigate to Advanced > Background to change its background image.
Mega Menu
View Demo
The Mega Menu composite is comprised of a trigger (Mega Menu Link in the Structure Pane) and a wrapper. When the trigger is hovered, the wrapper is positioned beneath the trigger and revealed.
By default, the Mega Menu Wrapper contains a Columns element with 3 columns and some demo content. The Columns element and anything contained within it can all be replaced by any other Oxygen elements to fit your needs.
Configuration Options
In the Structure Pane you will find the Mega Menu Link and Mega Menu Wrapper elements within the Mega Menu container. The Mega Menu Link and Mega Menu Wrapper do not need to reside in the same container. The Mega Menu Wrapper can be moved to the bottom of your design, or anywhere else that you prefer.
To use more than one Mega Menu, start by inserting a second Mega Menu element. Next, select the new Mega Menu Link element and find the megamenu-link-id attribute in the Primary tab of the Properties Pane or under Advanced > Attributes. This attribute is set to 1 by default. Change it to 2 (or any other unique number that is unused by other Mega Menu elements in the page or template design.) Now, select the new Mega Menu Wrapper element and find its megamenu-link-id attribute in the Primary tab of the Properties Pane or under Advanced > Attributes. The value of this attribute needs to match the value of the attribute you just set on the new Mega Menu Link element.
Number Counter
View Demo
The Number Counter composite is comprised of a number and a label. The number counts up to the defined value when the Number Counter becomes visible in the viewport.
Configuration Options
To set the value that the Number Counter should count up to, find the Number element within the Number Counter container in Oxygen, and change the Number element's text to the desired final value. This value must be a number.
To change the speed at which the number increments, navigate to the Code Block labeled "Number Counter Code" within the Number Counter container in the Structure Pane. Next, and find this code on line 13:
var counterSpeed = 50;
To make the Number Counter count up more slowly, change 50 to a higher number. To make it faster, change 50 to a lower number.
Circular Counter
View Demo
The Circular Counter composite is comprised of a circular ring, a number, a unit, a label, and a sub-label. The number counts up and the ring fills with a color when the Circular Counter becomes visible in the viewport.
Configuration Options
The unit is a simple text element. To change the unit from the default % symbol, double click the symbol and replace it with the desired unit.
To set the value that the Circular Counter should count up to, find the Number element within the Circular Counter > Circular Counter Outer > Circular Counter Inner container in Oxygen, and change the Number element's text to the desired final value. This value must be a number.
The circular ring fill will fill to a percentage that corresponds to the Number defined.
To change the color of the ring fill, select the Circular Counter Outer element within the Circular Counter container in the Properties Pane. Next, navigate to Advanced > Typography in the Properties Pane. The typography color defined here is used for the ring's fill color.
To change the speed at which the number increments, navigate to the Code Block labeled "Circular Counter Code" within the Circular Counter container in the Structure Pane. Next, and find this code on line 13:
var counterSpeed = 50;
To make the Number Counter count up more slowly, change 50 to a higher number. To make it faster, change 50 to a lower number.
Review Box
View Demo
The Review Box composite displays a pre-styled review layout including an image, name, title, star rating, and review text.
Configuration Options
The Image Comparison composite has no special configuration options.
Hover Scrolling Image
View Demo
The Hover Scrolling Image composite displays a portion of an image with a large vertical height. When the element is hovered, the image scrolls down. This element is ideal for displaying images such as website screenshots.
Configuration Options
To change the image, select the Hover Scrolling Image Div, ensure you have the Div's ID selected in the Properties Pane, then navigate to Advanced > Background and change the background image there. This element works best with tall images that allow for ample vertical scrolling.
You can adjust the scroll speed of the image by selecting the Hover Scrolling Image element in the Properties Pane and navigating to Advanced > Effects > Transition. There, you can change the transition time to adjust the speed of the image scroll when hovered.
Section Indicator
View Demo
The Section Indicator composite is comprised of a circular div and a label. These elements will be cloned for each Section present on the page when the front-end is loaded.
Note: The Section Indicator element should be used with Sections that are set to 100vh height.
Configuration Options
To change the "active" color of Section Indicator dots, select the Section Indicator Dot element in the Structure Pane, then navigate to Advanced > Typography and change the typography color.
To set the label for Sections, give each Section a data-label attribute (under Advanced > Attributes in the Properties Pane). Set the value to whatever you want the label to be.
To skip indicators for specific Sections, give those sections a si-skip attribute (under Advanced > Attributes in the Properties Pane) with a value of 1. The Section Indicator will ignore these Sections when generating its output.
If you need to use the Section Indicator for Sections that are greater than 100vh, you'll need to adjust the threshold on line 64 in the Section Indicator Code Block's JavaScript editor. To make the Section Indicator work with Sections that are 200vh, for example, the threshold on line 64 must be set to 0.5.
Switcher
View Demo
The Switcher composite is a toggle switch that toggles the visibility of two containers when clicked. This is most commonly used to show different pricing options on pricing pages.
Configuration Options
There are two containers included with the Switcher: Switcher Container 1 and Switcher Container 2. Place any content you want to toggle between in these containers.
Table of Contents
View Demo
The Table of Contents composite generates an automatic, clickable Table of Contents based on the h2-h6 elements present on the page.
Configuration Options
To style the Table of Contents, style the placeholder elements in the builder. These styles will be used when dynamically generating the Table of Contents on the front end.
To make the Table of Contents skip a specific heading or container, add the toc-skip attribute with a value of 1 to the heading or container. If this attribute is added to a container, the Table of Contents will skip all headings within that container when generating its output.
Focus Section
View Demo
The Focus Section is a Section that increases in size and has a backdrop that becomes active when the Section is scrolled into view.
Configuration Options
The Focus Section composite has no special configuration options.
Floating Icon Menu
View Demo
The Floating Icon Menu is an icon-triggered menu that expands when clicked, showing icon-indicated options.
Configuration Options
The Floating Icon Menu composite has no special configuration options.
Easy Posts
Easy Posts makes it easy to display customizable lists of posts, pages, or any custom post type.
Add an Easy Posts to your page from +Add -> Helpers -> Easy Posts.
Presets
Various presets to display posts in list, grid, or masonry layouts are included with Oxygen.
Choose a preset from Load Settings From Preset to load a preset. The current settings for the Easy Posts will be overwritten by the preset.
To add your own presets to this list, simply adjust the settings in the Query, Styles, and Templates sections as you wish. Then enter a preset name in the Save current settings as preset box and click Save.
Query
The query determines which posts will be displayed by Easy Posts.
Default
The default query is generated by WordPress based on the URL you visit. Visiting the URL for your blog post archive will make WordPress generate a query that will return your blog posts. Visiting the URL for a real estate listing will make WordPress generate a query that will return that real estate listing.
This is all done automatically by WordPress.
You can override the default query by choosing custom or manual.
Custom
Post Type - choose the post types returned by the query, or manually specify IDs
Filtering - exclude posts that don't match the specified author or taxonomies
Order - the order the posts are displayed in - alphabetical, by date, etc.
Count - the number of posts to return
Manual
For complete control over the posts returned by query, you can manually specify WP_Query parameters.
https://codex.wordpress.org/Class_Reference/WP_Query#Parameters
Styles
Customize the styles for the title, meta, content, read more, and responsive behavior of the displayed posts.
Note: some styles are not applicable or not supported by certain preset templates.
Templates
Template PHP
This code is used to render a single item in the list of posts output by the Easy Posts.
This code behaves as if it was running inside the WordPress loop and the_post() has already been called.
Customization of this code allows you to add any data you want, such as Custom Field values, to the Easy Posts output.
Template CSS
This code works in conjunction with the settings specified in the Styles section to control the way the list of posts is displayed.
%%EPID%% is replaced with the ID of the current Easy Posts element, which prevents different Easy Posts styles from conflicting with each other if multiple Easy Posts are used on the same page.
Pagination
Pagination of an Easy Posts element is controlled by Reading Settings specified at Settings -> Reading in your WordPress admin panel.
Gallery
The Gallery element displays a customizable image gallery with options for captions, hover effects, and a lightbox.
Add a Gallery element to your page from Add+ > Helpers > Gallery.
Adding Images to the Gallery
Gallery Source
The Gallery Source is where you populate your Gallery with images. You have three options:
Media Library - specify Image IDs that exist in your WordPress media library. Click Browse to select images from your WordPress media library.
ACF - use a Gallery field from the Advanced Custom Fields plugin
WooCommerce - display the images product gallery for the specified WooCommerce product
Link Images
Choose yes to link the image to its full size image file, or no to disable the link.
Add Lightbox
This option appears when Link Images is set to yes. Instead of linking to the image file itself, the image will be displayed in a lightbox.
Gallery Styling
Layout
This controls the layout of the gallery, including the image aspect ratio, number of images per row, and spacing between images.
Layout - choose either flex or masonry. Flex keeps all images in orderly rows, while masonry arranges images based on their own sizes and the number of images per row.
Image Aspect Ratio - if flex is chosen for the Layout, specify an image aspect ratio like 16:9 (widescreen), 21:9 (cinematic), 1:1 (square), etc.
Images Per Row - set the maximum number of images displayed in each row.
Space Around Image - control the spacing between each image.
Image Min Width - Use this property to make the gallery responsive. Images will not be displayed narrower than this width.
Captions
Show Captions - choose yes or no.
Caption Color - set the text color of the captions.
Caption Background Color - set the background color where captions are displayed.
Show Captions Only On Hover - choose yes or no.
Hide Captions Below - set a screen size below which captions will not be displayed.
Hover
Image Opacity - the image opacity when not hovered.
Hover Image Opacity - the image opacity when hovering over it with the mouse.
Transition Duration - set the duration of the transition for the image hover opacity, and the display of the caption if it is present.
Google Maps
The Google Maps element displays a map embedded from Google Maps.
Add this element to your page by clicking +Add -> Helpers -> Google Maps.
Google Maps Settings
Address
Enter the address of the location you want to display.
Zoom
Adjust the zoom with your location centered in the map.
Height
Control the height of the Google Maps element as displayed on the page.
Entering Your API Key
Google requires you to have an API key to display a Google Map. They have instructions on creating a Maps Embed API key here: https://developers.google.com/maps/documentation/embed/get-api-key.
Enter the API key on the Oxygen -> Settings page in your WordPress admin panel.
Header Builder
Header Builder makes it easy to create responsive, sticky, multi-row headers.
Add a Header Builder to your page from +Add > Helpers > Header Builder.
Positioning Elements
Each Header Builder element is made up of multiple Header Row elements. Each Header Row element is divided into three subsections - left, center, and right.
You can position the elements inside each header row by dragging them with the mouse. You can also use the Structure panel for positioning.
Multiple Rows
To add another Header Row to a Header Builder, activate the Header Builder and then click Primary > Add Another Row in the Header Builder settings.
Sticky Headers
To stick a header to the top of the page so that it remains at the top of the browser viewport when the user scrolls down the page, follow these steps:
Select Header Builder in the Structure panel on the right-hand side.
Click Sticky in the left panel.
Check the Sticky checkbox.
Configuration Options for Sticky Header
scroll distance - how far the user must scroll before the sticky header is shown.
sticky background color - a background color that will be applied to the Header Builder only when it is sticky - useful for making transparent headers overlaid on a hero background image sticky.
sticky above - the header will only be sticky above this screen width - used to hide the sticky header on mobile devices.
sticky box shadow - CSS code to customize the shadow displayed below the header when it is sticky.
sticky header z-index - define a z-index for your sticky header - useful to prevent other elements on the page from appearing on top of the sticky header while scrolling.
fade in sticky - check this box to use a fade animation when the header becomes sticky.
fade in speed - the speed of the fade in animation.
Header Row Visibility Based On Sticky State
Each individual Header Row in a Header Builder element can be configured to display or not display depending on the Header Builder's sticky state. To change these settings, select a Header Row in the Structure panel on the right side. In the Properties Pane on the left, under the Primary tab, you'll see a section called Sticky Display. There, you can choose to only show in sticky or hide in sticky.
Overlay Headers
To make your header overlay the content below it on the page, follow these steps:
Select Header Builder in the Structure panel on the right-hand side.
Click Overlay in the left panel.
Use the Overlay Header drop down to choose a viewport width above which you'd like to have the header overlay the page content.
This will result in an overlay header on all pages and posts where this header is present. You can also determine the Header Builder's overlay state on a per-page basis by going to Manage -> Settings -> Page Settings while editing an individual page or post.
Header Row Visibility Based On Overlay State
Each individual Header Row in a Header Builder element can be configured to display or not display depending on the Header Builder's overlay state. To change these settings, select a Header Row in the Structure panel on the right side. In the Properties Pane on the left, under the Primary tab, you'll see a section called Overlay Display. There, you can choose to only show in overlay or hide in overlay.
Responsive Headers
Elements in a header are stacked horizontally by default. The left, right, and center elements of the Header Row will appear side by side in a single row. However, on smaller screens you may want your header's elements to stack vertically instead of horizontally.
To stack your entire Header Builder or an individual Header Row vertically, select the Header Builder or Header Row and go to Primary. Then choose a screen width in the Stack Vertically Below dropdown. When the screen width falls below the chosen value, the elements inside the Header Row or Header Builder will stack vertically.
To hide a specific Header Row below a certain screen width, just choose the width in the Hide Row Below dropdown.
Icon Box
The Icon Box element displays an icon with a heading and text.
Add a Icon Box element to your page from Add+ > Helpers > Icon Box.
Layout & Spacing
Content Alignment - align all content within the element left, center, or right.
Icon Position - positions the icon relative to the text and link content: top, right, left, or bottom.
Icon Vertical Alignment - aligns the icon vertically within the Icon Box element top, middle, or bottom. This parameter is visible only when Icon Position is set to left or right.
Icon Space Before - sets the spacing before the icon. If Icon Position is set to either top or bottom, this controls the spacing on top of the icon. Otherwise, if Icon Position is set to either right or left, this controls the spacing to the left of the icon.
Icon Space After - sets the spacing after the icon. If Icon Position is set to either top or bottom, this controls the spacing on the bottom of the icon. Otherwise, if Icon Position is set to either right or left, this controls the spacing to the right of the icon.
Heading Space Above - sets the spacing above the heading.
Heading Space Below - sets the spacing below the heading.
Text Space Above - sets the spacing above the text.
Text Space Below - sets the spacing below the text.
Link Space Above - sets the spacing above the link area of the Icon Box.
Link Space Below - sets the spacing below the link area of the Icon Box.
Responsive
In this tab, you can control the responsiveness of the alignment of the elements within the Icon Box element.
Vertical Layout Below - set the screen width below which the Icon Box contents will be aligned based on the Content Alignment in this tab.
Content Alignment - the alignment set here will only applies to screen widths below the width set in Vertical Layout Below.
Typography
In this tab you can control the typography for the Heading and Text inside the Icon Box.
Each of these three tabs have identical typography settings, which are the same as those found at Advanced > Typography.
Link Area
Drag a button or link into the icon box to nest it inside of the icon box. It will be displayed below the Text.
Login Form
The Login Form element displays the WordPress login form.
Add a Login Form element to your page from Add+ > WordPress > Login Form.
Form Fields
Border Color - set the color of the field borders.
Text Color - set the color of text typed into the fields.
Border Radius - set the border radius of the fields.
Submit Button
Background Color - set the color of the submit button.
Text Color - set the color of text within the submit button.
Style Output
If Selector Detector is enabled, the Style Output button will appear, allowing for further customization of the styles of the Login Form.
Menu
Menu element displays menus created at Appearance > Menus in your WordPress admin panel and provides options for styling, dropdowns, and responsive.
Add a Menu to your page from +Add > WordPress > Menu.
Menu Styling Options
Many options for styling the menu links and controlling the menu layout are available in the Primary tab for the Menu.
Menu Layout
vertical - displays the menu links vertically. Dropdowns open to the side of the menu.
horizontal - displays the menu links horizontally. Dropdowns open below the menu.
Menu
Choose the WordPress menu (created at Appearance > Menus in your WordPress admin panel) to display.
Text
Control the text styles for the menu links. The Styling Options > Typography article explains these settings in more detail.
Spacing
Control the margin and padding around each menu link.
Hover & Active
Create special styles that only apply when the menu link is hovered or active.
Active means the page that the link links to is currently displayed.
Dropdowns
Choose whether or not to include dropdowns in your menu and control their styles.
Mobile Responsive
Choose the screen width at which the menu collapses into a responsive toggle.
Options are available to hide dropdowns in the responsive menu, create custom styles that only apply to the responsive menu, and customize the toggle icon.