#XFrame (BETA)#
##A responsive front end framework for websites and web applications.##
XFrame's main goals are:
- Create a visually pleasing foundation for semantic HTML markup.
- Provide smart handling of large data sets by default.
- Ensure that websites and apps render appropriately across various screen sizes.
- Provide a suite of UI tools to enable optimal workflows.
XFrame is currently in development and there may be still some significant changes, however it is mostly stable in test and I'm using it on projects now. If you wish to use it please be aware of any updates. Please star and/or watch this repo for updates. I would love to hear feedback if you have comments or recommendations.
###Features###
- Supports semantic HTML.
- Built in responsive navigation based on an standard unordered list (UL). Supports sub navigations items (nested ULs).
- Responsive 12 column grid system with breakpoints for small, medium and large screens.
- Auto leveling of column heights for layout consistency.
- Automatic full screen overlays for wide tables.
- Clean, readable formatting of all markup including forms and form elements.
- Easy themeimg with SASS.
- Built with SASS and JQuery.
###Usage###
Link to XFrame's xframe.css and xframe.js files from your web page and mark up your html by referring to the included example php pages or to the documentation below.
###Documentation###
XFrame comes with a sample PHP site to preview a working example. Just view the index.php file in a PHP enabled location.
###Themeing###
To use a custom color scheme just edit the $brandcolor (for the header, navigation, footer and link colors) and $themecolor (for the main content colors) in the xframe.scss file.
/*
Set your brand color here.
This will set the color of the header, nav, footer and links.
*/
$brandcolor: #336699;
/*
Set your theme color here.
This will set the overall color of the site.
*/
$themecolor: #ffffff;###Head###
Include the meta viewport tag to ensure pages render appropriately on all screen sizes. Include a link to XFrame's xframe.css file.
<head>
<title>XFrame</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="stylesheet" type="css" href="/css/xframe.css">
</head>###Overlays###
Include the xover div to enable full screen overlays.
<div class="xover">
<a href="#" class="close">X</a>
<div class="xdata"></div>
</div>###Action Menu###
Include the xactions div to enable the Action Menu. The Action Menu will style a standard unordered list but the contents of the xdata div can be whatever is appropriate for that page's specific menu.
<div class="xactions">
<a href="#" class="open">❯</a> <div class="title">Actions</div>
<a href="#" class="close">X</a>
<div class="xdata">
<ul>
<li>Save Preferences</li>
<li>Tabulate Sum</li>
<li>Delete</li>
<li>Send an Alert</li>
<li>Change Status</li>
</ul>
</div>
</div>###Header and Navigation###
These are optional. You can include just the xheader by itself if you wish. The layout will adjust if there's no navigation present. If you include the navigation you must include but the xmenu and xnav divs. The xnav div must contain an unordered list with the xnav id. Nested ULs will be treated as sub-menu items.
<div class="xheader">
<h1>
<img src="/img/xframe-logo.png" alt="XFrame" class="xlogo">
<a href="/">XFrame</a>
</h1>
</div>
<div id="xmenu">
<a href="#">☰ Menu</a>
</div>
<div class="xnav">
<ul id="xnav">
<li><a href="/">Home</a></li>
<li><a href="/">Network Performance</a></li>
<li class="subnav"><a href="/">All Systems</a>
<ul>
<li><a href="/">System 1</a></li>
<li><a href="/">System 2</a></li>
</ul>
</li>
<li><a href="/">Reporting</a></li>
<li><a href="/">Documentation</a>
<ul>
<li><a href="/">Networks</a></li>
<li><a href="/">Systems</a></li>
</ul>
</li>
<li><a href="/">Contact</a></li>
</ul>
</div>###Content###
The page's main content must be contained in an xcontent div.
<div class="xcontent">
<!-- Main Content -->
</div>###Groups and Posts###
Posts are individual boxes of content within an xpost classed div. All Posts must be contained within an xgroup div. An xgroup can contain one post or all posts on a page. It allows for better grouping of content as needed.
<div class="xgroup">
<div class="xpost xlg-3 xmed-6">
<p>Lorem Ipsum</p>
</div>
<div class="xpost xlg-3 xmed-6">
<p>Lorem Ipsum</p>
</div>
<div class="xpost xlg-3 xmed-6">
<p>Lorem Ipsum</p>
</div>
<div class="xpost xlg-3 xmed-6">
<p>Lorem Ipsum</p>
</div>
</div>###12 Column Grid System###
XFrame has breakpoints for small, medium and large screens. To establish a layout for each case use the xlg- and xmed- classes for posts. If neither class is set the post will be the full with of the enclosing div. You specify the number of columns a post should take up by appending a number to the classes like xlg-6 for 6 columns on large screens.
In the example below there will be a row of 4 boxes on large screens (3 columns + 3 columns + 3 columns + 3 columns = 12 columns) and a row of 2 boxes on medium screens (6 columns + 6 columns = 12 columns). The heights of all posts in the same row will be equalized, based on the tallest content, automatically.
Big thanks to Zurb's Foundation Framework for the inspiration behind the 12 column grid format. I recommend taking a look at Foundation if you have not yet and are interested in front end frameworks.
<div class="xgroup">
<div class="xpost xlg-3 xmed-6">
<p>Lorem Ipsum</p>
</div>
<div class="xpost xlg-3 xmed-6">
<p>Lorem Ipsum</p>
</div>
<div class="xpost xlg-3 xmed-6">
<p>Lorem Ipsum</p>
</div>
<div class="xpost xlg-3 xmed-6">
<p>Lorem Ipsum</p>
</div>
</div>###Forms###
Form content should use fieldset and label tags to ensure appropriate formatting.
<form method="post" action="/">
<fieldset>
<label for="name">Name</label>
<input type="text" name="name">
</fieldset>
<fieldset>
<input type="submit" value="submit">
</fieldset>
</form>###Footer###
Place a link to JQuery followed by a link XFrame's xframe.js file right before the closing body tag. Use an xfooter classed div for footer content.
</div><!- closing xcontent div -->
<div class="xfooter">
<p>© 2014 XFrame</p>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.8.2/jquery.min.js"></script>
<script type="text/javascript" src="/js/xframe.js"></script>
</body>
</html>