Documentation
Documentation

# Layout

Atlantis utilizes JSF templating APIs and provides a main template.xhtml along with additional topbar, menu, footer fragments for the base layout. These xhtml files must be placed under WEB-INF folder and client pages should reference the template.xhtml as their template. Provided empty.xhtml is a sample content page using the main template.xhtml that defines "content" as the main ui:define placeholder. By default template defines 3 placeholders (page title, header content and actual content)to insert content and you can add more as per your requirements.

Sample page below uses the main template from Atlantis.

    <ui:composition xmlns="http://www.w3.org/1999/xhtml"
                    xmlns:h="http://java.sun.com/jsf/html"
                    xmlns:f="http://java.sun.com/jsf/core"
                    xmlns:ui="http://java.sun.com/jsf/facelets"
                    xmlns:p="http://primefaces.org/ui"
                    template="/WEB-INF/template.xhtml">

        <ui:define name="title">Test Page</ui:define>

        <ui:define name="content">
            Content goes here
        </ui:define>
    </ui:composition>

Other required resources are the css, js and images that are located inside resources/atlantis-layout folder, simply copy the atlantis-layout folder to your %WEB-APP-FOLDER%/resources folder so that final path would be %WEB-APP-FOLDER%/resources/atlantis-layout/. Please refer to demo app or maven project of the demo app as the reference.

# Theme

Atlantis provides 8 PrimeFaces themes out of the box, setup of a theme simple as including the theme jar in your classpath and defining primefaces.THEME context parameter in web.xml such as "primefaces-Atlantis-green". Full list of available themes are;

- primefaces-atlantis-blue
- primefaces-atlantis-cyan
- primefaces-atlantis-green
- primefaces-atlantis-orange
- primefaces-atlantis-pink
- primefaces-atlantis-purple
- primefaces-atlantis-steel
- primefaces-atlantis-turquoise

A custom theme can be developed by the following steps.

- Choose a custom theme name such as primefaces-atlantis-myown.
- Create a folder named primefaces-atlantis-myown and place an empty theme.scss inside
- Copy the sass folder from the distribution to your application.
- Define the variables listed below and import the /sass/theme/_theme.scss file.
- Build the scss to generate css
- Set primefaces.THEME context parameter as atlantis-myown
- Either bundle the css in a jar file or serve from webapp/resources/primefaces-atlantis-myown folder

Here are the variables required to create a theme, you may need to change the last line according to the relative path of the sass folder in your application.

    $primaryColor:#f16383;

    @import '../sass/theme/_theme';

An example sass command to compile the css would be;

    sass src/main/webapp/resources/primefaces-atlantis-myown/theme.scss src/main/webapp/resources/primefaces-atlantis-myown/theme.css  --sourcemap=none

Watch mode is handy to avoid compiling everytime when a change is made, instead use the following command so that sass generates the file whenever you make a customization. This builds all css files whenever a change is made to any scss file.

    sass -w src/main/webapp/resources/ --sourcemap=none

Same can also be applied to layout itself;

- Choose a layout name such as layout-myown.
- Create an empty file named layout-myown.scss inside resources/atlantis-layout/css folder.
- Define the variables listed below and import the /sass/layout/_layout.scss file.
- Build the scss to generate css
- Serve the css by importing it using a link tag or h:outputStylesheet.

Here are the variables required to create a layout, you may need to change the last line according to the relative path of the sass folder in your application.

    $topbarBgColor:#3192e1;
    $topbarBgColorDark:#1b6bad;
    $badgeColor:#e42a7b;
    $primaryColor:#3192e1;

    @import '../../sass/layout/_layout';

For both cases, several .scss files such as _layout.scss, _theme.scss or _variables.scss has to be present relative to your scss files, these are available inside the sass folder in the distribution.

In case you'd like to customize the structure not just the colors, the _variables.scss is where the structural variables (e.g. font size, paddings) for the layout are defined.

    /* Common */
    $fontSize:13px;
    $textColor:#2d353c;
    $textSecondaryColor:lighten($textColor,25%);
    $borderRadius:2px;
    $dividerColor:#e3e3e3;
    $iconWidth:16px;
    $iconHeight:16px;
    $highlightTextColor:#ffffff;

    /* Layout */
    $bodyBgColor:#f1f3f6;
    $logoBgColor:#2d353c;
    $footerBgColor:#dee0e3;

    /* Topbar */
    $topbarMenuTextColor:#ffffff;
    $topbarMenuTextHoverColor:#e3e3e3;
    $topbarSubmenuBgColor:#f7f7f7;
    $topbarSubmenuItemHoverBgColor:#e3e3e3;

    /* Menu */
    $darkMenuBgColor:#63696e;
    $darkMenuItemTextColor:#dee0e3;
    $menuitemColor:#545b61;

    /******************************/
    /*           THEME            */
    /******************************/

    /* Headers */
    $headerPadding:6px 12px;
    $headerBgColor:#efefef;
    $headerTextColor:#2d353c;
    $headerHoverBgColor:#d1d1d1;
    $headerBorderColor:#c7c7c7;
    $headerIconColor:#767b7f;
    $headerIconHoverColor:#2d353c;

    /* Contents */
    $contentPadding:6px 12px;
    $contentBorderColor:#c7c7c7;

    /* Forms */
    $inputBgColor:#ffffff;
    $inputPadding:4px;
    $inputBorderColor:#c7c7c7;
    $inputHoverBorderColor:#b3b3b3;
    $inputInvalidBorderColor:#e13131;

    /* Buttons */
    $buttonTextColor:#ffffff;

    /* List Items */
    $listItemPadding:6px 12px;
    $listItemHoverBgColor:#f7f7f7;
    $listItemHoverTextColor:#2d353c;

    /* Messages */
    $infoMessageBgColor:#3192e1;
    $infoMessageTextColor:#ffffff;
    $warnMessageBgColor:#f1b263;
    $warnMessageTextColor:#ffffff;
    $errorMessageBgColor:#e13131;
    $errorMessageTextColor:#ffffff;
    $fatalMessageBgColor:#2d353c;
    $fatalMessageTextColor:#ffffff;
    $messagesCloseIconColor:#ffffff;
    $messagesCloseIconHoverColor:#e3e3e3;

    /* Data */
    $paginatorBgColor:#ffffff;
    $paginatorHoverBgColor:#e3e3e3;
    $datableOddRowBgColor:#f7f7f7;
    $datatableHoverBgColor:#e3e3e3;

    /* Predefined Colors */
    $turquoise:#47c5d4;
    $blue:#3192e1;
    $orange:#ff9c59;
    $purple:#985edb;
    $pink:#e42a7b;
    $green:#5ea980;
    $steel:#58799f;
    $black:#545b61;

# Menu

Menu is a regular JSF component that supports PrimeFaces MenuModel API allowing both declarative and programmatic approaches. State is saved via a cookie and to remove it define a widgetVar to the menu and call PF('yourwidgetvar').clearMenuState(). To use the menu add the primefaces-atlantis-{version}.jar to your classpath and import the http://primefaces.org/Atlantis namespace.

    xmlns:pa="http://primefaces.org/atlantis">

    >pa:tabMenu>
        <pa:tab icon="fa fa-cube" title="Features">
            <h:form id="menu-form">
                <pa:menu widgetVar="menu">
                </pa:menu>
            </h:Form>
        </pa:tab>
        <pa:tab icon="fa fa-inbox" title="Inbox">
        </pa:tab>
        <pa:tab icon="fa fa-calendar-o" title="Calendar">
        </pa:tab>
    </pa:tabMenu>

Menu has 2 modes, inline and overlay. Layout wrapper element in template.xhtml is used to define which mode to use by adding specific classes. List below indicates the style classes for each mode.

- Static: Default mode
- Overlay: "layout-overlay-menu"

For example to create an overlay menu, the div element should be in following form;

    <div class="layout-wrapper layout-overlay-menu">
        ...
    </div>

# Icons

Atlantis Layout uses font awesome icons for layout so enable font awesome support in PrimeFaces by setting primefaces.FONT_AWESOME context parameter in web.xml as true. If your PrimeFaces version does not have the font awesome integration, include the font-awesome manually in your application.

# Card

Card is a section to group content and layout provides a built-in css for it. Apply .card style class to your container to use it. If the card has a title defined with h1 tag, add card-w-title to adjust paddings.

    <div class="card">
        Content here
    </div>

    <div class="card card-w-title">
        <h1>Card with Title<h1>
        Content here
    </div>

# Grid CSS

Atlantis uses new PrimeFaces Grid CSS (ui-g-*) throughout the samples, we strongly suggest using Grid CSS as your layout framework as it is well tested and supported by PrimeFaces. Grid CSS is automatically included on newer versions however if your PrimeFaces version is older than 5.3.14, add the provided grid.css file under /Atlantis-layout/css/ folder to your template manually.

# Tips

- Familiarity with SASS is required to make customizations to the layout and theme.
- Demo application war and the maven project tag are included in distribution however you don't necessarily need them to install Atlantis, the actual artifacts required are the layout zip file and the theme jar.
- Sample demo application war includes the JSF libraries so it is suggested to remove them from the war file when you deploy to an appserver.
- When running the maven project, you need to build the sass with (sass --update src/main/webapp/resources/ --sourcemap=none) command.

# Migration Guide

1.0 to 1.0.1

- Update layout and theme css files.