Skip to content

Latest commit

 

History

History
170 lines (119 loc) · 4.58 KB

README.md

File metadata and controls

170 lines (119 loc) · 4.58 KB

flex-grids

A lightweight CSS grid system uses for making responsive websites.

Features

  • Pure CSS.
  • Lightweight Just 8 Kilobytes.
  • Easy To Install.
  • Easy To Use.
  • Use Flexbox.
  • Great For Multilanguage Websites.

Installation

As normal plugin

Clone the repo in your PC.

Then, copy the css folder into your project directory.

Then, include the flex-grids.min.css file in your html file.

<link rel="stylesheet" href="css/flex-grids.min.css" />

Hint: I assume that your html file is in the root directory.

As NPM package

Install the package in your project.

npm install flex-grids

Then, include the flex-grids.min.css file in your view file.

<link
   rel="stylesheet"
   href="../node_modules/flex-grids/dist/css/flex-grids.min.css"
/>

Hint: I assume that your view file is in the views directory.

Usage

Once you include flex-grids.min.css in your html file you are all set to use flex-grids, now just you need to add some classes.

flex-grids is a rows and columns grid-based, each row represents a grid system, and each column represents a grid element, each row divided into 12 grid elements that can be represented by columns.

Class Description
.container You can use it as a container for your content.
.row Container of your grid elements, all grid elements must be inside it.
.col-* Represents a grid element.
.order-* Uses to order your grid elements.

.container

You can use it as a container of your content, it holds and centers the content.

.row

A container of your grid elements, all grid elements must be inside it.

.col-*

Represents a grid element.

<div class="container">
   <div class="row">
      <div class="col">1</div>
      <div class="col">2</div>
      <div class="col">3</div>
      <div class="col">4</div>
   </div>
</div>

Using ".col" without any suffix that shows how many grids the element will span like .col-2 or .col-sm-2 will adjust all the columns to be all the same width.

You can suffix the .col with a hyphen followed by a number that shows how many grids the column will span.

<div class="container">
   <div class="row">
      <div class="col-3">1</div>
      <div class="col-3">2</div>
      <div class="col-3">3</div>
      <div class="col-3">4</div>
   </div>
</div>

All items have the same width because I gave each column 3 grids, so the sum is 12.

You can suffix the ".col" with a hyphen followed by a breakpoint that shows the screens you target.

<div class="container">
   <div class="row">
      <div class="col-1">1</div>
      <div class="col-sm-2">2</div>
      <div class="col-md-3">3</div>
      <div class="col-lg-3">4</div>
      <div class="col-xl-3">5</div>
   </div>
</div>

col-1: Targets all the screens.

col-sm-2: Targets the screens from 576px and above.

col-md-3: Targets the screens from 768px and above.

col-lg-3: Targets the screens from 992px and above.

col-xl-3: Targets the screens from 1200px and above.

Hint: Using .col-sm or something similar without suffixing the number of grids you want like .col-sm-3 doesn't make any sense.

.order-*

Uses to order your grid elements since grids are 12 so order-* are 12, so they will cover all grid elements.

<div class="container">
   <div class="row">
      <div class="col-6 order-2">1</div>
      <div class="col-6 order-1">2</div>
   </div>
</div>

Accepts all the breakpoints that .col-* accepts.

<div class="container">
   <div class="row">
      <div class="col-md-6 order-md-2">1</div>
      <div class="col-md-6 order-md-1">2</div>
   </div>
</div>

Hint: Consuming flex-grids classes is just like bootstrap framework.

Hint: .container class doesn't support breakpoints.

Breakpoints

Here are what widths are breakpoints target.

Breakpoint Description
.col For all widths.
.col-sm For widths 576px and above.
.col-md For widths 768px and above.
.col-lg For widths 992px and above.
.col-xl For widths 1200 and above.

Support

Thank you for using flex-grids if you experienced any issue feel free to describe it here.