Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/slavanga/baseguide

Flexible, fluid and fun CSS framework.
https://github.com/slavanga/baseguide

css flexbox framework grid responsive sass scss

Last synced: 2 months ago
JSON representation

Flexible, fluid and fun CSS framework.

Awesome Lists containing this project

README 

        
# [Baseguide](https://basegui.de)



[![npm version](https://badge.fury.io/js/baseguide.svg)](https://www.npmjs.com/package/baseguide)



Baseguide is a lightweight and robust CSS framework for prototyping and production code.



* **Responsive** and scalable components

* **Robust** flexbox grid

* **Extendable** breakpoint system

* **Consistent** vertical rhythm and modular scale



## Table of Contents

* [Install](#install)

* [Development](#development)

* [Breakpoints](#breakpoints)

* [Grid](#grid)

* [Forms](#forms)

* [Typography](#typography)

* [Browser Support](#browser-support)

* [Inspired By](#inspired-by)

* [License](#license)



## Install



### Download



* [baseguide.css](https://raw.githubusercontent.com/slavanga/baseguide/master/dist/css/baseguide.css) (uncompressed)

* [baseguide.min.css](https://raw.githubusercontent.com/slavanga/baseguide/master/dist/css/baseguide.min.css) (compressed)



### CDN



This is great for prototyping, but doesn’t allow any customization. To load Baseguide via [unpkg](https://unpkg.com), add this to your ``````:



```html



```



### Package Managers



[npm](https://www.npmjs.com/package/baseguide): `npm install baseguide`



[yarn](https://yarnpkg.com/en/package/baseguide): `yarn add baseguide`



## Development



### Dependencies

Use `npm install` or `yarn install` to install the dev dependencies.



### Gulp

The included gulpfile takes care of compiling, optimizing and minifying your assets.



| Command           | Description                                                                                              |

| :---------------- | :------------------------------------------------------------------------------------------------------- |

| `gulp`            | Build files, watch for changes and start a local server using [Browsersync](https://www.browsersync.io/) |

| `gulp build`      | Build files once                                                                                         |

| `gulp watch`      | Watch files and build when a change occurs                                                               |

| `gulp lint`       | Lint the scss and js source files                                                                        |



### Sass

Default variables can be changed before importing Baseguide.

Take a look at the [_settings.scss](https://github.com/slavanga/baseguide/blob/master/scss/baseguide/00-settings/_settings.scss) file to see all variables.



```scss

$button-bg: #bada55; // 1. Customize default variables



@import 'baseguide'; // 2. Import Baseguide



// 3. Add your own styles here

```



## Breakpoints

Breakpoints can easily be configured using the ```$mq-breakpoints``` map. Note that the breakpoints have to be sorted from small to large.



The default configuration looks like this:



```scss

$mq-breakpoints: (

  xs: 0,

  sm: 400px,

  md: 680px,

  lg: 960px,

  xl: 1200px

);

```



Baseguide generates all the necessary grid and responsive visibility classes based on these breakpoints.



### Media Queries

Media Queries are handled by [Sass MQ](https://github.com/sass-mq/sass-mq).



```scss

// include the media query mixin and pass the breakpoint key

@include mq(md) {



}

```



The snippet above compiles to the following CSS:



```css

@media (min-width: 42.5em) {



}

```



Check out the [Sass MQ documentation](https://sass-mq.github.io/sass-mq/#mixin-mq) for more details and advanced usage of media queries.



### Breakpoint Loop

The ```loop-breakpoints``` mixin iterates through all breakpoints. It sets three global variables and outputs the ```@content``` for each breakpoint.

```scss

@include loop-breakpoints($breakpoints: $mq-breakpoints, $inclusive: true, $mq: true) {

  @debug $breakpoint;

  @debug $is-first-breakpoint;

  @debug $is-last-breakpoint;

}

```



It’s a powerful tool that for example allows the generation of additional responsive helper classes.

```scss

@include loop-breakpoints {

  .text-#{$breakpoint}-left {

    text-align: left;

  }



  .text-#{$breakpoint}-center {

    text-align: center;

  }



  .text-#{$breakpoint}-right {

    text-align: right;

  }

}

```



## Grid

The grid system is responsive and follows the mobile first pattern. It offers predefined classes for quick layouts as well as powerful mixins for more semantic layouts.



The number of columns is controlled by the ```$grid-columns``` variable which defaults to 12.



### Basic Example



```html



  


    


    


  




```



### Gutters

The gutters are controlled by the ```$grid-gutter``` variable. It can either be a global value across all breakpoints or a map with gutter values per breakpoint.



```scss

// set gutter for all breakpoints

$grid-gutter: 60px;



// start with 20px gutter and increase to 40px from the md breakpoint

// note: breakpoints can be skipped to keep the last defined value

$grid-gutter: (

  xs: 20px,

  md: 40px

);

```



Accessing gutter values is easy using the ```get-gutter``` function. The smallest gutter gets returned by default.



```scss

.col {

  margin-bottom: get-gutter();



  @include mq(md) {

    margin-bottom: get-gutter(md);

  }

}

```



### Mixins

The grid mixins can be used to create custom containers, rows and columns.



```scss

// $gutter: gutter width in pixels or map with gutters, defaults to $grid-gutter

// $size: column width as percentage value, decimal number or column count

// $columns: an integer, the total number of columns, defaults to $grid-columns

// $width: container width in pixels, defaults to $grid-container



@include container($gutter, $width);

@include row($gutter);



@include column-base($gutter, $size, $columns);

@include column($size, $columns);



@include column-push($size, $columns);

@include column-pull($size, $columns);

@include column-offset($size, $columns);



@include column-block($columns);

```



#### Two Column Layout



```scss

@include mq(sm) {

  .col-content {

    @include column(80%);

  }



  .col-sidebar {

    @include column(40%);

  }

}

```



```html



  


    Main Content

    Sidebar

  




```



#### Gallery Layout Using Block Grid



```scss

.col-gallery {

  @include column-base;

  @include column-block(3);



  @include mq(md) {

    @include column-block(6);

  }

}

```



```html



  


    
Gallery item


    
Gallery item


    
Gallery item


    
Gallery item


    
Gallery item


    
Gallery item


  




```



## Forms



### Standard Form Controls

All form controls listed in ```$input-selector``` get styled by default. The variable can be changed to a custom selector like ```.form-control```. This will allow you to selectively style form controls based on that selector.



### Custom Form Controls

The custom forms component was designed with progressive enhancement in mind.

Browsers that support [feature queries](https://caniuse.com/#feat=css-featurequeries) and [appearance](https://caniuse.com/#feat=css-appearance) get the fully enhanced experience.



## Typography



### Headings

The value for ```$type-scale-base``` defines the smallest heading (h6). From there the remaining heading font sizes are calculated using the ```$type-scale```. Major Third (1.25) is the default type scale. Check [type-scale.com](https://type-scale.com/) for more scales.



By using a map for ```$type-scale-base``` you can scale all headings up or down in harmony on a specific breakpoint.



```scss

$type-scale-base: (

  xs: $font-size-base,

  md: $font-size-base * 2

);

```



## Browser Support

* Latest stable: Chrome, Edge, Firefox

* IE 11+

* Safari 9+

* Mobile Safari 9+

* Android Browser 4.4+



Baseguide uses [Autoprefixer](https://github.com/postcss/autoprefixer) to handle CSS vendor prefixes.



## Inspired By…

* [Article: Styling with STRINGS](http://simurai.com/blog/2014/05/04/cssconf)

* [Bootstrap](https://getbootstrap.com)

* [Bourbon](https://www.bourbon.io)

* [Foundation](https://foundation.zurb.com)

* [HTML5 Boilerplate](https://html5boilerplate.com)



## License

The code is released under the [MIT license](https://github.com/slavanga/baseguide/blob/master/LICENSE).