1.0.0 • Published 4 years ago

@miraidesigns/layout v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
4 years ago

Layout

Layout classes help you structure your webpage and content.


Sass

// Include default styles without configuration
@forward '@miraidesigns/layout/styles';
// Configure appearance
@use '@miraidesigns/layout' with (
    $variable: value
);

@include layout.styles();

Examples

Some basic examples on how the module can be used.

Columns & Rows

Columns and rows allow you to decide whether content will flow horizontally or vertically.

<!-- Elements will be aligned vertically, like in a column. -->
<div class="mdf-column">
    <!-- Element -->
    <!-- Element -->
    <!-- Element -->
</div>

<!-- Elements will be aligned horizontally, like in a row. -->
<div class="mdf-row">
    <!-- Element --><!-- Element --><!-- Element -->
</div>

Containers

Containers wrap your content limiting its max width and allow for easy positioning.

<!-- Container aligned left -->
<div class="mdf-container mdf-container--left"></div>

<!-- Container centered -->
<div class="mdf-container mdf-container--center"></div>

<!-- Container aligned right -->
<div class="mdf-container mdf-container--right"></div>

Groups

Groups allow you to organize a collection of elements.

<div class="mdf-group">
    <div class="mdf-container"></div>
    <div class="mdf-container"></div>
    <div class="mdf-container"></div>
</div>

RTL

RTL (Right To Left) layouts are fully supported and every module is 100% compatible. Add the mdf-rtl class to the <html> element and your website will be served in RTL mode.

<html class="mdf-rtl">
    <body>
        <!-- All content will be in RTL mode. -->
    </body>
</html>

Implementation

Classes

NameTypeDescription
mdf-columnParentContainer element, all content inside will flow vertically
mdf-rowParentContainer element, all content inside will flow horizontally
mdf-containerParentContainer element, use to restrict content width and allow for easy positioning
mdf-container--leftModifierMove container to the left of its parent
mdf-container--centeredModifierMove container to the center of its parent
mdf-container--rightModifierMove container to the right of its parent
mdf-groupParentContainer element, use to organize a collection of items
mdf-group--stackedModifierContent will flow vertically, like a list
mdf-group--wrapModifierContent will wrap around to the next line if not enough space is available
mdf-group--gap-noneModifierRemoves the gap between items
mdf-group--gap-*ModifierSet gap size according to $gaps map