_global renderkit

mixins

colors-palette

@mixin colors-palette() { ... }

Description

Mixin for global palette classes.

This mixin generates 2 concordant CSS classes with all the $palette-color keys.

Ex. .palette-color-primary, .background-color-primary.

Parameters

None.

Requires

shape-classes

@mixin shape-classes() { ... }

Description

Mixin for shape classes.

Parameters

None.

Requires

foundation-grid

@mixin foundation-grid() { ... }

Description

Foundation Float Grid. No rem conversion for the gutters.

Parameters

None.

Requires

Links

global-fonts

@mixin global-fonts() { ... }

Description

Mixin for importing Google Fonts and/or @font-face fonts globally.

Parameters

None.

Requires

form-style

@mixin form-style() { ... }

Description

Mixin for style all cross browsing inputs.

The configurable inputs are:

  • input[type="email"],
  • input[type="password"],
  • input[type="search"],
  • input[type="tel"],
  • input[type="text"],
  • input[type="url"]
  • select,
  • textarea

Parameters

None.

Requires

checkbox-radio-classes

@mixin checkbox-radio-classes() { ... }

Description

Checkbox radio classes

Output CSS classes for custom checkboxes and radios.

These classes are exclusive to label with the [for] attribute in agreement with id of the checkbox or radio input.

Parameters

None.

Requires

accessibility-classes

@mixin accessibility-classes() { ... }

Description

Accessibility classes mixin.

Parameters

None.

Requires

clearfix-classes

@mixin clearfix-classes() { ... }

Description

Clearfix classes.

Parameters

None.

Requires

foundation-flex-classes

@mixin foundation-flex-classes() { ... }

Description

Foundation flex flex classes

The ability to enable or disable flex-source-ordering has been added.

Parameters

None.

Requires

Links

float-classes

@mixin float-classes() { ... }

Description

Float disposition classes.

Parameters

None.

media-print

@mixin media-print() { ... }

Description

Mixin for global @media print elements. From original HTML5 boilerplate.

Parameters

None.

Requires

Links

foundation-visibility-classes

@mixin foundation-visibility-classes() { ... }

Description

Foundation visibilty clasess.

Parameters

None.

Requires

Links

scss-normalize

@mixin scss-normalize() { ... }

Description

From original normalize.css v8.0.0.

Compared to the original normalize, the ability to disable or enable the default appearance for the various fields in the form, or for radio checkboxes has been added. Further reset for the typography have been added.

Parameters

None.

Requires

Links

global-typography

@mixin global-typography() { ... }

Description

Mixin for global typography.

Parameters

None.

Requires

foundation-xy-grid-classes

@mixin foundation-xy-grid-classes() { ... }

Description

Foundation XY-grid. No rem conversion for the gutters.

Parameters

None.

Links

accessibility

variables

custom-checkbox-radio-outline-detect

$custom-checkbox-radio-outline-detect: true !default;

Description

Enable or disable the ability to have the default outline in focus in the checkbox or radio shapes.

Type

Boolean

Used by

custom-checkbox-radio-what-input-outline-detect

$custom-checkbox-radio-what-input-outline-detect: true !default;

Description

Enables the possibility to preserve the outline in focus at the click or touch for the checkbox andradio shapes

And to enable it only if the event derives from the keyboard. The what-input plugins is required.

Type

Boolean

Used by

Links

selection-background-color

$selection-background-color: #b3d4fc !default;

Description

The default background-color selection for text and other elements.

Type

Keyword or Color

Used by

selection-color-apply

$selection-color-apply: false !default;

Description

If true the color will be applied based on the value of $selection-color of a selected element.

Type

Boolean

Used by

selection-color

$selection-color: initial !default;

Description

The color when an item is selected.

Type

Keyword or Color

Used by

ios-tap-color

$ios-tap-color: transparent !default;

Description

The tap highlight color for iOS devices.

Type

Color

Used by

focus-inputs-outline-hidden

$focus-inputs-outline-hidden: true !default;

Description

Enable or disable the default outline in focus for button,input,select,textarea.

Type

Boolean

Used by

what-input-outline-keyboard-detect

$what-input-outline-keyboard-detect: true !default;

Description

This variable preserves the default outline for links or fields of a form if the event is intercepted by the keyboard so the basic outline is not shown in focus if the event is determined by a mouse or touch.

The installation of what-input js is required.

Type

Boolean

Used by

Links

breakpoint

variables

breakpoints

$breakpoints: (
    small: 0,
    medium: 640px,
    large: 1024px,
    xlarge: 1200px,
    xxlarge: 1440px
) !default;

Description

A list of named breakpoints. You can use these with the breakpoint() mixin to quickly create media queries.

Type

Map

Used by

print-breakpoint

$print-breakpoint: large !default;

Description

The largest named breakpoint in which to include print as a media type

Type

Keyword

Used by

breakpoint-classes

$breakpoint-classes: (small medium large) !default;

Description

All of the names in this list will be output as classes in your CSS, like .small-12, .medium-6, and so on. Each value in this list must also be in the $breakpoints map.

Type

List

Used by

mixins

breakpoint

@mixin breakpoint($value) { ... }

Description

Wraps a media query around the content you put inside the mixin. This mixin accepts a number of values:

  • If a string is passed, the mixin will look for it in the $breakpoints map, and use a media query there.
  • Unlike the Foundation default mixin every value is passed will not be converted to em values.

If multiple values are passed, the mixin will generate a media query for each of them as described above. Since the content is duplicated for each breakpoint, this mixin should only be used with properties that change across breakpoints.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$value

Breakpoint name or px value to process.

Keyword or Number none

Content

This mixin allows extra content to be passed (through the @content directive).

Output

If the breakpoint is "0px and larger", outputs the content as-is. Otherwise, outputs the content wrapped in a media query.

The only parameter has been added. Ex. @media only screen().

Requires

Used by

checkbox & radio

variables

custom-checkbox-radio-font-family

$custom-checkbox-radio-font-family: 'Josefin Sans', sans-serif !default;

Description

Default font family for checkbox-radio components.

Type

String or Keyword

Used by

custom-checkbox-radio-font-size

$custom-checkbox-radio-font-size: 13px !default;

Description

Default font size for checkbox-radio components.

Type

Number

Used by

custom-checkbox-radio-text-transform

$custom-checkbox-radio-text-transform: none !default;

Description

Default text transform for checkbo-radio components.

Type

Keyword

Used by

custom-checkbox-radio-letter-spacing

$custom-checkbox-radio-letter-spacing: 0.5px !default;

Description

Default letter spacing for checkbox-radio components.

Type

Keyword or Number

Used by

custom-checkbox-radio-color

$custom-checkbox-radio-color: #8c8c8c !default;

Description

The color of the label for custom checkbox-radio component

Type

Color

Used by

custom-checkbox-radio-cursor

$custom-checkbox-radio-cursor: default !default;

Description

The cursor of the label for custom checkbox-radio component.

Type

Keyword

Used by

custom-checkbox-radio-label-gutter

$custom-checkbox-radio-label-gutter: 10px !default;

Description

The space between the label text and the shape of the custom checkbox-radio component.

Type

Number

Used by

custom-checkbox-radio-align-center

$custom-checkbox-radio-align-center: false !default;

Description

If set to true the alignment of the checkbox-radio components will line up in the middle of the text.

Type

Boolean

Used by

custom-checkbox-radio-size

$custom-checkbox-radio-size: 24px !default;

Description

The size the global dimension of the checkbox-radio components.

Type

Number

Used by

custom-checkbox-radio-background-color

$custom-checkbox-radio-background-color: #efefef !default;

Description

The background-color of the checkbox-radio shape.

Type

Color

Used by

custom-checkbox-radio-border

$custom-checkbox-radio-border: 1px solid #d9d9d9 !default;

Description

The border-color for custom checkbox-radio component.

Type

Keyword

Used by

custom-checkbox-radio-hover-border

$custom-checkbox-radio-hover-border: false !default;

Description

Enable or disable the ability to have a different border in hover on the checkbox or radio shape.

Type

Boolean

Used by

custom-checkbox-radio-hover-border-color

$custom-checkbox-radio-hover-border-color: #b2b2b2 !default;

Description

The border color in hover on the checkbox or radio shape.

Type

Color

Used by

custom-checkbox-radio-checked-border

$custom-checkbox-radio-checked-border: true !default;

Type

Boolean

Used by

custom-checkbox-border-radius

$custom-checkbox-border-radius: 5px !default;

Description

The border-radius for custom checkbox component.

Type

Number

Used by

custom-checkbox-mark-thick

$custom-checkbox-mark-thick: 3px !default;

Description

The thickness of the "arrow" shape for custom checkbox component.

Type

Number

Used by

custom-checkbox-mark-color

$custom-checkbox-mark-color: #8c8c8c !default;

Description

The "mark" color of the checkbox shape for custom checkbox component.

Type

Color

Used by

custom-checkbox-checked-border-color

$custom-checkbox-checked-border-color: #b2b2b2 !default;

Description

The border-color of the checkbox shape when input[type="checkbox"] is :checked.

Type

Color

Used by

custom-checkbox-focus-border-color

$custom-checkbox-focus-border-color: #b2b2b2 !default;

Description

The border-color of the checkbox shape when input[type="checkbox"] is in :focus but not :checked.

Type

Color

Used by

custom-checkbox-error-border-color

$custom-checkbox-error-border-color: #c04649 !default;

Description

The border-color when input[type="checkbox"] is in validation failed.

Type

Color

Used by

custom-checkbox-error-background-color

$custom-checkbox-error-background-color: #f2c0c1 !default;

Description

The background-color when input[type="checkbox"] is in validation failed.

Type

Color

Used by

custom-radio-mark-color

$custom-radio-mark-color: #8c8c8c !default;

Description

The color of the radio mark.

Type

Color

Used by

custom-radio-checked-border-color

$custom-radio-checked-border-color: #b2b2b2 !default;

Description

The border-color of the checkbox shape when input[type="radio"] is :checked.

Type

Color

Used by

custom-radio-focus-border-color

$custom-radio-focus-border-color: #b2b2b2 !default;

Description

The border-color of the checkbox shape when input[type="radio"] is in :focus but not :checked.

Type

Color

Used by

custom-radio-error-border-color

$custom-radio-error-border-color: #c04649 !default;

Description

The border-color when input[type="radio"] is in validation failed.

Type

Color

Used by

custom-radio-error-background-color

$custom-radio-error-background-color: #f2c0c1 !default;

Description

The background-color when input[type="radio"] is in validation failed.

Type

Color

Used by

mixins

checkbox-shape

@mixin checkbox-shape($center-align: false, $checkbox-size: 24px, $checkbox-mark-color: #8c8c8c, $checkbox-mark-thick: 3px, $checkbox-border-radius: 5px) { ... }

Description

Mixin for generate a checkbox shape input.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$center-align

If true the checkbox shape it will be displayed half on the height of the text occupying the label.

Booleanfalse
$checkbox-size

The size in px for the checkbox shape.

Keyword24px
$checkbox-mark-color

The color of the checkbox mark.

Color#8c8c8c
$checkbox-mark-thick

The thickness of the "arrow" shape.

Keyword3px
$checkbox-border-radius

The border-radius of the checkbox shape.

Keyword5px

Requires

Used by

checkbox-attr

@mixin checkbox-attr($hover-border: false, $hover-border-color: #b2b2b2, $checked-border: true, $checked-border-color: #b2b2b2, $focus-border-color: #b2b2b2) { ... }

Description

Mixin for generate all the attributes needed to agree with checkbox shape.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$hover-border

Enable or disable the ability to have a different border in hover.

Booleanfalse
$hover-border-color

The color of the border of the radio shape in hover.

Color#b2b2b2
$checked-border

Enable or disable the ability to have a different border-color when input[type="checkbox"] is :checked.

Booleantrue
$checked-border-color

The border-color of the checkbox shape when input[type="checkbox"] is :checked.

Color#b2b2b2
$focus-border-color

The border-color of the checkbox shape when input[type="checkbox"] is in :focus but not :checked.

Color#b2b2b2

Requires

Used by

checkbox-validation

@mixin checkbox-validation($error-class: error, $error-border-color: #c04649, $error-background-color: #f2c0c1) { ... }

Description

Mixin for generate all validation attributes needed to agree with checkbox shape.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$error-class

The validation class failed.

Stringerror
$error-border-color

The border-color when input[type="checkbox"] is in validation failed.

Color#c04649
$error-background-color

The background-color when input[type="checkbox"] is in validation failed.

Color#f2c0c1

Used by

radio-shape

@mixin radio-shape($center-text-align: false, $radio-size: 24px, $mark-color: #8c8c8c) { ... }

Description

Mixin for generate a radio shape input.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$center-text-align

If true the radio shape it will be displayed half on the height of the text occupying the label.

Booleanfalse
$radio-size

The size in px for the radio shape.

Keyword24px
$mark-color

The color of the radio mark.

Color#8c8c8c

Requires

Used by

radio-attr

@mixin radio-attr($hover-border: false, $hover-border-color: #b2b2b2, $checked-border: true, $checked-border-color: #b2b2b2, $focus-border-color: #b2b2b2) { ... }

Description

Mixin for generate all the attributes needed to agree with radio shape.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$hover-border

Enable or disable the ability to have a different border in hover.

Booleanfalse
$hover-border-color

The color of the border of the radio shape in hover.

Color#b2b2b2
$checked-border

Enable or disable the ability to have a different border-color when input[type="radio"] is :checked.

Booleantrue
$checked-border-color

The border-color of the radio shape when input[type="radio"] is :checked.

Color#b2b2b2
$focus-border-color

The border-color of the radio shape when input[type="radio"] is in :focus but not :checked.

Color#b2b2b2

Requires

Used by

radio-validation

@mixin radio-validation($error-class: error, $error-border-color: #c04649, $error-background-color: #f2c0c1) { ... }

Description

Mixin for generate all validation attributes needed to agree with radio shape.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$error-class

The validation class failed.

Stringerror
$error-border-color

The border-color when input[type="radio"] is in validation failed.

Color#c04649
$error-background-color

The background-color when input[type="radio"] is in validation failed.

Color#f2c0c1

Used by

checkbox-radio-style

@mixin checkbox-radio-style($center-text-align: false, $checkbox-radio-size: 24px, $gutter: 10px, $cursor: default, $background-color: #efefef, $border: 1px solid #d9d9d9) { ... }

Description

Mixin for create the basic style for custom checkboxes & radios.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$center-text-align

If true the checkbox or radio shape it will be displayed half on the height of the text occupying the label.

Booleanfalse
$checkbox-radio-size

The size in px for the checkbox and radio shape.

Keyword24px
$gutter

The space between the label text and the shape of the custom checkbox or radio component.

Keyword10px
$cursor

The CSS value of the cursor for the label that hosts the checkbox or radio shape.

Keyworddefault
$background-color

The background-color that will be applied to the checkbox or radio shape.

Color#efefef
$border

The border that will be applied to the checkbox or radio shape.

Keyword1px solid #d9d9d9

Requires

Used by

colors & palette

variables

palette-color

$palette-color: (
    primary: #666666,
    suvagrey: #8c8c8c,
    darkgray: #b2b2b2,
    gainsboro: #d9d9d9,
    whitesmoke: #efefef,
    cornflowerblue: #61afef,
    sunset: #c04649,
    coralcandy: #f2c0c1
) !default;

Description

Global default palette color used by RenderKit.

To help the keys nomenclature of the map, you can use this online tool http://www.color-blindness.com/color-name-hue/ to find the most suitable name for the hexadecimal.

Each key of this map agrees with 2 classes to be used in the templates.

Type

Map

Example

.palette-color-primary, .background-color-primary

Used by

Links

body-background-color

$body-background-color: #ffffff !default;

Description

The default body background color.

Type

Color

Used by

body-base-color

$body-base-color: #666666 !default;

Description

The default body base color.

Type

Color

Used by

functions

palette

@function palette($color) { ... }

Description

Function for catch HEX color in $palette-color map.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$color

The key of $palette-color map.

Color none

Throws

  • No color palette found in $palette-color map.

Requires

mixins

[private] manage-palette

@mixin manage-palette() { ... }

Description

Mixin for mixin to intercept the primary key in $palette-color map. This mixin avoids having empty keys in $palette-color map.

Parameters

None.

Throws

  • In $palette-color, you must have a key named primary.

Requires

Used by

flexbox utilities

variables

flex-source-ordering-count-enable

$flex-source-ordering-count-enable: false !default;

Description

Quickly disable/enable count of flexbox source ordering.

Type

Boolean

Used by

flex-source-ordering-count

$flex-source-ordering-count: 6 !default;

Description

Default value for the count of source ordering.

Type

Number

Used by

flexbox-responsive-breakpoints

$flexbox-responsive-breakpoints: true !default;

Description

Quickly disable/enable Responsive breakpoints for Vanilla Flex Helpers.

Type

Boolean

Used by

mixins

[private] flex-helpers

@mixin flex-helpers() { ... }

Description

Vanilla flexbox classes.

Parameters

None.

Requires

Used by

flex

@mixin flex() { ... }

Description

Enables flexbox by adding display: flex to the element.

Parameters

None.

Used by

flex-align

@mixin flex-align($x: null, $y: null) { ... }

Description

Horizontally or vertically aligns the items within a flex container.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$x

Horizontal alignment to use. Can be left, right, center, justify, or spaced. Or, set it to null (the default) to not set horizontal alignment.

Keywordnull
$y

Vertical alignment to use. Can be top, bottom, middle, or stretch. Or, set it to null (the default) to not set vertical alignment.

Keywordnull

Used by

flex-align-self

@mixin flex-align-self($y: null) { ... }

Description

Vertically align a single column within a flex row. Apply this mixin to a flex column.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$y

Vertical alignment to use. Can be top, bottom, middle, or stretch. Or, set it to null (the default) to not set vertical alignment.

Keywordnull

Used by

flex-order

@mixin flex-order($order: 0) { ... }

Description

Changes the source order of a flex child. Children with lower numbers appear first in the layout.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$order

Order number to apply.

Number0

Used by

flex-direction

@mixin flex-direction($direction: row) { ... }

Description

Change flex-direction

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$direction

Flex direction to use. Can be

  • row (default): same as text direction
  • row-reverse: opposite to text direction
  • column: same as row but top to bottom
  • column-reverse: same as row-reverse top to bottom
Keywordrow

Used by

float grid

functions

grid-column

@function grid-column($columns) { ... }

Description

Calculates the width of a column based on a number of factors.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$columns noneNumber or List none

Returns

Number

A calculated percentage value.

Throws

  • Wrong syntax for grid-column(). Use the format

  • Wrong syntax for grid-column(). Use a number, decimal, percentage, or

Requires

Used by

mixins

grid-column

@mixin grid-column($columns: $grid-column-count, $gutters: $grid-column-gutter) { ... }

Description

Creates a grid column.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$columns

Width of the column. Refer to the grid-column() function to see possible values.

Mixed$grid-column-count
$gutters

Spacing between columns. Refer to the grid-column-gutter() function to see possible values.

Mixed$grid-column-gutter

Requires

Used by

grid-column-row

@mixin grid-column-row($gutters: $grid-column-gutter) { ... }

Description

Creates a grid column row. This is the equivalent of adding .row and .column to the same element.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$gutters

Width of the gutters on either side of the column row. Refer to the grid-column-gutter() function to see possible values.

Mixed$grid-column-gutter

Requires

grid-column-gutter

@mixin grid-column-gutter($gutter: auto, $gutters: $grid-column-gutter) { ... }

Description

Set the gutters on a column Spacing between columns, accepts multiple values:

  • A single value will make the gutter that exact size.
  • A breakpoint name will make the gutter the corresponding size in the $gutters map.
  • "auto" will make the gutter responsive, using the $gutters map values.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$gutter noneNumber or Keywordauto
$gutters

Gutter map or single value to use. Responsive gutter settings by default.

Number or Map$grid-column-gutter

Used by

grid-column-collapse

@mixin grid-column-collapse() { ... }

Description

Collapse the gutters on a column by removing the padding. Only use this mixin within a breakpoint. To collapse a column's gutters on all screen sizes, use the $gutter parameter of the grid-column() mixin instead.

Parameters

None.

Requires

grid-column-margin

@mixin grid-column-margin($margin: auto, $margins: $grid-column-gutter) { ... }

Description

Sets bottom margin on grid columns to match gutters

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$margin

The bottom margin on grid columns, accepts multiple values:

  • A single value will make the margin that exact size.
  • A breakpoint name will make the margin the corresponding size in the $margins map.
  • "auto" will make the margin responsive, using the $margins map values.
Number or Keywordauto
$margins

Map or single value to use. Responsive gutter settings by default.

Number or Map$grid-column-gutter

Used by

grid-layout

@mixin grid-layout($n, $selector: '.column', $gutter) { ... }

Description

Sizes child elements so that $n number of items appear on each row.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$n

Number of elements to display per row.

Number none
$selector

Selector(s) to use for child elements.

String'.column'
$gutter

The gutter to apply to child elements. Accepts multiple values: $grid-column-gutter will use the values in the `$grid-column-gutter map/, including breakpoint sizes. A fixed numeric value will apply this gutter to all breakpoints.

Number or List none

Requires

Used by

grid-layout-center-last

@mixin grid-layout-center-last($n) { ... }

Description

Adds extra CSS to block grid children so the last items in the row center automatically. Apply this to the columns, not the row.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$n

Number of items that appear in each row.

Number none

grid-column-position

@mixin grid-column-position($position) { ... }

Description

Reposition a column.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$position

Direction and amount to move. The column will move equal to the width of the column count specified. A positive number will push the column to the right, while a negative number will pull it to the left. Set to center to center the column.

Number or Keyword none

Requires

grid-column-unposition

@mixin grid-column-unposition() { ... }

Description

Reset a position definition.

Parameters

None.

grid-column-offset

@mixin grid-column-offset($n) { ... }

Description

Offsets a column to the right by $n columns.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$n

Width to offset by. You can pass in any value accepted by the grid-column() mixin, such as 6, 50%, or 1 of 2.

Number or List none

Requires

grid-column-end

@mixin grid-column-end() { ... }

Description

Disable the default behavior of the last column in a row aligning to the opposite edge.

Parameters

None.

grid-context

@mixin grid-context($columns, $root: false) { ... }

Description

Change the behavior of columns defined inside this mixin to use a different column count.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$columns

Number of columns to use.

Number none
$root

If false, selectors inside this mixin will nest inside the parent selector. If true, selectors will not nest.

Booleanfalse

Content

This mixin allows extra content to be passed (through the @content directive).

Requires

Used by

grid-row

@mixin grid-row($columns: null, $behavior: null, $size: $grid-row-width, $cf: true, $gutters: $grid-column-gutter) { ... }

Description

Creates a grid row.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$columns

Column count for this row. null will use the default column count.

Numbernull
$behavior

Modifications to the default grid styles. nest indicates the row will be placed inside another row. collapse indicates that the columns inside this row will not have padding. nest collapse combines both behaviors.

Keywordsnull
$size

Maximum size of the row. Set to expand to make the row taking the full width.

Keyword or Number$grid-row-width
$cf

Whether or not to include a clearfix.

Booleantrue
$gutters

Gutter map or single value to use when inverting margins. Responsive gutter settings by default.

Number or Map$grid-column-gutter

Content

This mixin allows extra content to be passed (through the @content directive).

Requires

Used by

grid-row-nest

@mixin grid-row-nest($:) { ... }

Description

Inverts the margins of a row to nest it inside of a column.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$:

{Number|Map} $gutters [$grid-column-gutter] Gutter map or single value to use when inverting margins. Responsive gutter settings by default.

none

Used by

grid-row-size

@mixin grid-row-size($:) { ... }

Description

Set a grid row size

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$:

{Keyword|Number} $size [$grid-row-width] Maximum size of the row. Set to expand to make the row taking the full width.

none

Used by

grid-column-size

@mixin grid-column-size($width: $grid-column-count) { ... }

Description

Set the width of a grid column.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$width

Width to make the column. You can pass in any value accepted by the grid-column() function, such as 6, 50%, or 1 of 2.

Number or List$grid-column-count

Requires

Used by

variables

grid-row-width

$grid-row-width: 1200px !default;

Description

The maximum width of a row.

Type

Number

grid-column-count

$grid-column-count: 12 !default;

Description

The default column count of a grid. Changing this value affects the logic of the grid mixins, and the number of CSS classes output.

Type

Number

Used by

grid-column-gutter

Since 6.1.0
$grid-column-gutter: (
    small: 20px,
    medium: 30px,
) !default;

Description

The amount of space between columns at different screen sizes. To use just one size, set the variable to a number instead of a map.

Type

Map or Length

Used by

grid-column-align-edge

$grid-column-align-edge: true !default;

Description

If true, the last column in a row will align to the opposite edge of the row.

Type

Boolean

Used by

grid-column-alias

$grid-column-alias: 'columns' !default;

Description

Selector used for an alias of column (with @extend). If false, no alias is created.

Type

String

Used by

block-grid-max

$block-grid-max: 8 !default;

Description

The highest number of .x-up classes available when using the block grid CSS.

Type

Number

Used by

fonts

variables

font-dir

$font-dir: '../fonts/' !default;

Description

The default font dir for catch all font file.

Type

String

Used by

font-face-load

$font-face-load: false !default;

Description

Quickly enable or disable the @font-face directive for load "font face" fonts.

If it is true the values ​​of the $font-face-map will be read.

Type

Boolen

Used by

font-face-map

$font-face-map: (
    'MyFontFamily': ('myfilename', normal, 400, eot woff woff2 ttf svg)
) !default;

Description

The default $font-face-map used by RenderKit.

The parameters of the map are detailed below:

  • MyFontFamily The font-family of your font.
  • myfilename The file name of your font. If the files are in a folder you can simply edit the string by adding the correct path ex: pathtofile/myfilename
  • normal The font style of your font.
  • 400 The font weight of your font.
  • eot woff woff2 ttf svg The available extensions of your font.

Type

Map

Used by

google-fonts-load

$google-fonts-load: true !default;

Description

Quickly enable or disable the @import directive for load Google fonts.

Type

Boolen

Used by

google-fonts-family

$google-fonts-family: 'Work+Sans:400,700|Josefin+Sans:400,400i,700|Abril+Fatface' !default;

Description

The default Google Fonts used by by RenderKit.

$google-fonts-family accept the name of the font after string ?family=.

Type

String

Used by

functions

font

@function font($font-family-key) { ... }

Description

Function for catch font family in $font-face-map.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$font-family-key

The nth key of $font-face-map.

Integer none

Returns

String

The name of the font family.

Requires

mixins

font-face

@mixin font-face($font-name, $font-file, $style: normal, $weight: 400, $extension: eot woff woff2 ttf svg) { ... }

Description

Mixin for generate a @font-face rule.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$font-name

The font family name.

String none
$font-file

The name of font file.

String none
$style

The style of your font.

Stringnormal
$weight

The font weight of your font.

String or Integer400
$extension

The extensions available for the font.

Stringeot woff woff2 ttf svg

Requires

Used by

form

variables

form-input-custom-autofill

$form-input-custom-autofill: false !default;

Description

Variable that determines whether or not to enable a custom inputs autofill.

Type

Boolean

Used by

form-input-autofill-color

$form-input-autofill-color: $form-input-color !default;

Description

The color for the custom autofill.

Type

Color or Keyword

Used by

form-input-autofill-background-color

$form-input-autofill-background-color: $form-input-background-color !default;

Description

The background-color for the custom autofill.

Type

Color or Keyword

Used by

form-input-height

$form-input-height: 40px !default;

Description

The initial height of the fields.

Type

Number

Used by

form-input-font-family

$form-input-font-family: 'Josefin Sans', sans-serif !default;

Description

The font-family of the fields.

Type

Keyword

Used by

form-input-font-size

$form-input-font-size: 14px !default;

Description

The font-size of the fields.

Type

Number

Used by

form-input-letter-spacing

$form-input-letter-spacing: normal !default;

Description

The letter-spacing of the fields.

Type

Keyword or Number

Used by

form-input-text-transform

$form-input-text-transform: none !default;

Description

The text-transform of the fields.

Type

Keyword

Used by

form-input-background-color

$form-input-background-color: #efefef !default;

Description

The background-color of the fields.

Type

Color

Used by

form-input-color

$form-input-color: #666666 !default;

Description

The color of the fields.

Type

Color

Used by

form-input-border

$form-input-border: 1px solid #d9d9d9 !default;

Description

The border of the fields.

Type

Keyword

Used by

form-input-border-radius

$form-input-border-radius: 5px !default;

Description

The border-radius of the fields.

Type

Number

Used by

form-input-box-shadow

$form-input-box-shadow: 0 0 6px rgba(0, 0, 0, 0) !default;

Description

The box-shadow of the fields.

Type

Keyword

Used by

form-input-padding

$form-input-padding: 10px !default;

Description

The padding of the fields.

Type

Number

Used by

form-input-transition

$form-input-transition: border-color 0.3s ease, color 0.3s ease, background-color 0.3s ease, box-shadow 0.3s ease, text-shadow 0.3s ease !default;

Description

The global transition of the fields.

By default, the text-shadow property has been added to fix the :-moz-focusring for select in Firefox.

Type

Keyword

Used by

form-input-hover-properties

$form-input-hover-properties: true !default;

Description

Variable that determines whether to have a different properties in :hover for all fields except fields with [disabled] attribute.

Type

Boolean

Used by

form-input-hover-background-color

$form-input-hover-background-color: #efefef !default;

Description

The background-color of the fields when they are in :hover.

Type

Color

Used by

form-input-hover-border-color

$form-input-hover-border-color: #b2b2b2 !default;

Description

The color of the border of the fields when they are in :hover.

Type

Color

Used by

form-input-hover-box-shadow

$form-input-hover-box-shadow: 0 0 6px rgba(0, 0, 0, 0) !default;

Description

The box-shadow of the fields when they are in :hover.

Type

Keyword

Used by

form-input-focus-properties

$form-input-focus-properties: true !default;

Description

Variable that determines whether to have a different properties in focus for all fields.

Type

Boolean

Used by

form-input-focus-background-color

$form-input-focus-background-color: #efefef !default;

Description

The background-color of the fields when they are in :focus.

Type

Color

Used by

form-input-focus-border-color

$form-input-focus-border-color: #b2b2b2 !default;

Description

The color of the border of the fields when they are in :focus.

Type

Color

Used by

form-input-focus-box-shadow

$form-input-focus-box-shadow: 0 0 6px rgba(#666666, 0.25) !default;

Description

The box-shadow of the fields.

Type

Keyword

Used by

form-inputs-labelclass

$form-inputs-labelclass: 'form-label' !default;

Description

The class that will be applied to the label for the fields.

Type

String

Used by

form-inputs-label-error-class

$form-inputs-label-error-class: 'error';

Description

The class that will be applied to the label when validation has failed.

Type

String

Used by

form-label-font-family

$form-label-font-family: 'Josefin Sans', sans-serif !default;

Description

The font-family for the fields label element.

Type

Keyword or String

Used by

form-label-font-size

$form-label-font-size: 11px !default;

Description

The font-size for the fields label element.

Type

Number

Used by

form-label-letter-spacing

$form-label-letter-spacing: 0.5px !default;

Description

The letter-spacing for the fields label element.

Type

Number or Keyword

Used by

form-label-text-transform

$form-label-text-transform: uppercase !default;

Description

The text-transform style for the fields label element.

Type

Keyword

Used by

form-label-color

$form-label-color: #8c8c8c !default;

Description

The color for the fields label element.

Type

Color

Used by

form-label-margin

$form-label-margin: 0 0 5px 0 !default;

Description

The global margin for the fields label element.

Type

Number

Used by

form-input-error-label-color

$form-input-error-label-color: #c04649 !default;

Description

The color for the label of the fields when it have a failed validation.

Type

Color

Used by

form-input-placeholder-font-family

$form-input-placeholder-font-family: inherit !default;

Description

The font-family of the :placeholder of the fields.

Type

Keyword or String

Used by

form-input-placeholder-font-style

$form-input-placeholder-font-style: italic !default;

Description

The font-style of the :placeholder of the fields.

Type

Keyword

Used by

form-input-placeholder-text-transform

$form-input-placeholder-text-transform: capitalize !default;

Description

The text-transform style of the :placeholder of the fields.

Type

Keyword

Used by

form-input-placeholder-color

$form-input-placeholder-color: #8c8c8c !default;

Description

The color of the :placeholder of the fields.

Type

Color

Used by

form-input-placeholder-focus-hidden

$form-input-placeholder-focus-hidden: true !default;

Description

Variable that determines whether to hide or not, the :placeholder of the fields when they are in :focus.

Type

Boolean

Used by

form-input-placeholder-focus-color

$form-input-placeholder-focus-color: #8c8c8c !default;

Description

The color of the :placeholder of the fields when they are in :focus.

Type

Color

Used by

form-input-error-placeholder-color

$form-input-error-placeholder-color: #c04649 !default;

Description

The color for the :placeholder of the fields when they have a failed validation.

Type

Color

Used by

form-select-caret-shape-render

$form-select-caret-shape-render: true !default;

Description

Variable that determines whether to render the "caret" shape for the select.

Type

Boolean

Used by

form-select-caret-color

$form-select-caret-color: #8c8c8c !default;

Description

The "caret" color of the select.

Type

Color

Used by

form-select-caret-shape

$form-select-caret-shape: 'arrow' !default;

Description

The "caret" shape of the select.

The possible values ​​to pass are:

  • 'arrow'
  • 'triangle'
  • 'empty'

Type

String or Keyword

Used by

form-select-caret-size

$form-select-caret-size: 10px !default;

Description

The "caret" size of the select.

Type

Number

Used by

form-select-caret-image-url

$form-select-caret-image-url: 'path/to/shape' !default;

Description

If $form-select-caret-shape-render is set to false it is possible to load a custom "caret" shape.

This variable determines the pat of the custom "shape" for the select.

Type

String

Used by

form-select-caret-background-size

$form-select-caret-background-size: 10px !default;

Description

The size of the custom "caret" shape

Type

Number

Used by

form-textarea-height

$form-textarea-height: 110px !default;

Description

The global height of textarea.

Type

Number

Used by

form-textarea-resize

$form-textarea-resize: false !default;

Description

Variable that determines whether to have the texarea resizeable or not.

Type

Boolean

Used by

form-textarea-resize-mode

$form-textarea-resize-mode: vertical !default;

Description

Variable that determines the resize mode of the textarea.

It goes to act only if $form-textarea-resize is set to true.

Type

Keyword

Used by

form-input-error-background-color

$form-input-error-background-color: #f2c0c1 !default;

Description

The background-color for the fields when they have a failed validation.

Type

Color

Used by

form-input-error-border-color

$form-input-error-border-color: #c04649 !default;

Description

The border-color for the fields when they have a failed validation.

Type

Color

Used by

form-input-error-box-shadow

$form-input-error-box-shadow: 0 0 6px rgba(#c04649, 0.35) !default;

Description

The box-shadow for the fields when they have a failed validation.

Type

Keyword

Used by

form-input-error-color

$form-input-error-color: #666666 !default;

Description

The color for the fields when they have a failed validation.

Type

Color

Used by

form-input-error-focus-style

$form-input-error-focus-style: true !default;

Description

Variable that determines whether to maintain the style of "error" even at the time of focus or less.

Type

Boolean

Used by

mixins

autofill-style

@mixin autofill-style() { ... }

Description

Mixin for styling up the :-webkit-autofill for the fields.

Parameters

None.

Requires

Used by

fields-style

@mixin fields-style() { ... }

Description

Mixin for style all cross browsing inputs wrapped in a configurable "box" class.

Parameters

None.

Requires

Used by

label-style

@mixin label-style() { ... }

Description

Mixin for style the label for the fields.

Parameters

None.

Requires

Used by

placeholder-style

@mixin placeholder-style() { ... }

Description

Mixin for style the ::placeholder for the fields.

Parameters

None.

Requires

Used by

select-style

@mixin select-style() { ... }

Description

Mixin for style the select for the forms.

Parameters

None.

Requires

Used by

textarea-style

@mixin textarea-style() { ... }

Description

Mixin for style the textarea for the forms.

Parameters

None.

Requires

Used by

select-caret-shape

@mixin select-caret-shape($select-caret-color: #000000, $select-caret-shape: arrow) { ... }

Description

Mixin for generate an "caret" for custom select without js added.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$select-caret-color

The color in hex value for the "caret" color.

Color#000000
$select-caret-shape

The shape for the "caret". Could be triangle, arrow, empty.

Keyword or Stringarrow

Requires

Used by

fields-validation-style

@mixin fields-validation-style() { ... }

Description

Mixin to apply the style of the fields with failed validation.

It will be applied to: input, select & textarea

Parameters

None.

Requires

Used by

global

variables

global-flexbox

$global-flexbox: true !default;

Description

Variable to determine if we want to include flexbox utilities in our layout and to include mixins such as foundation-xy-grid-classes and foundation-flex-classes.

If set to false the settings for the XY Grid & Flexbox Utilities will be ignored.

Type

Boolean

Used by

global-font-size

$global-font-size: 100% !default;

Description

Global font size apply to html.

This value is valid only if $html-root-font-size is true.

Type

Number

Used by

global-body-font-size

$global-body-font-size: 16px !default;

Description

The default font size applied to the body.

This value is valid only if $body-root-font-size is true.

Type

Number

Used by

global-text-direction

$global-text-direction: ltr !default;

Description

Sets the text direction of the CSS. Can be either ltr or rtl.

Type

Keyword

Used by

global-select-reset-appearence

$global-select-reset-appearence: true !default;

Description

If true the default appearance will be set to none.

If you decide to enable this rule it will be easier to cross-browse the select on the various browsers and iOS devices.

Type

Boolean

Used by

global-custom-checkbox-radio

$global-custom-checkbox-radio: true !default;

Description

If true all the checkboxes and radios will be visually hidden in order to apply the mixin checkbox-radio-classess style.

Type

Boolean

Used by

global-input-disabled-color

$global-input-disabled-color: inherit !default;

Description

Global disabled input color value.

The color of the fields when they have the disabled attribute.

Type

Color or Keyword

Used by

global-input-disabled-opacity

$global-input-disabled-opacity: 0.5 !default;

Description

Global disabled input opacity value.

This value is valid only if $global-select-reset-appearence is true.

Type

Integer or Float

Used by

global-input-disabled-cursor

$global-input-disabled-cursor: not-allowed !default;

Description

Global disabled input cursor value.

The type of cursor when the fields have the disabled attribute.

Type

Keyword

Used by

global-form-inputs-error-class

$global-form-inputs-error-class: 'error' !default;

Description

The global class that is applied in the validation of the forms, usually via js.

This global class will be applied, if validation has failed to:

  • input[type="email"],
  • input[type="password"],
  • input[type="search"],
  • input[type="tel"],
  • input[type="text"],
  • input[type="url"]
  • select,
  • textarea

Type

String

Used by

global-text-rendering

$global-text-rendering: optimizeLegibility !default;

Description

Global text rendering applied to body, button, input, select and textarea.

Type

Keyword

Used by

global-letter-spacing-apply

$global-letter-spacing-apply: false !default;

Description

If true the $global-letter-spacing will be applied to body, button, input, select and textarea.

Type

Boolean

Used by

global-letter-spacing

$global-letter-spacing: normal !default;

Description

Global letter-spacing applied to body, button, input, select and textarea.

Type

Keyword or Number

Used by

global-font-liga-kern

$global-font-liga-kern: true !default;

Description

The font-feature-settings: 'liga','kern' rule is be applied to: body,button, input,select and textarea, which determines the "kering" between the various characters.

Type

Boolean

Used by

Links

global-input-reset-appearence

$global-input-reset-appearence: true !default;

Description

The default appearence for body,button, input,select and textarea it be set to none.

If you decide to enable this rule it will be easier to cross-browse the field styles on the various browsers and iOS devices.

Type

Boolean

Used by

global-input-search-cancel-button

$global-input-search-cancel-button: true !default;

Description

If false the default search-cancel-button will be hidden in all type="search" inputs.

Type

Boolean

Used by

global-select-reset-appearance-options

$global-select-reset-appearance-options: false !default;

Description

If true the all select it will be visually hidden in order to generate a select with custom options via js.

Type

Boolean

Used by

layout

mixins

clearfix

@mixin clearfix() { ... }

Description

Applies the micro clearfix hack popularized by Nicolas Gallagher. Include this mixin on a container if its children are all floated, to give the container a proper height. The clearfix is augmented with specific styles to prevent borders in flexbox environments.

Parameters

None.

Requires

Used by

Links

layer

@mixin layer() { ... }

Description

Mixin for create a "layer" position can be used for modals.

Parameters

None.

ios-scroll

@mixin ios-scroll() { ... }

Description

Mixin for simplify the syntax for iOS smooth scroll.

Parameters

None.

counter-increment

@mixin counter-increment($separator, $space: space) { ... }

Description

Counter Increment Mixin, create a numerated list. Include this on a child selector on ::before or ::after.

The parent selector need counter-reset: section;

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$separator

Any character as a type of separator is accepted.

String none
$space

It is possible to create a space after the separator or not. If set to no-space the space will not be present.

Stringspace

polyfills

mixins

fix-firefox

@mixin fix-firefox() { ... }

Description

Mixin for fix rules in Firefox. This mixin creates exclusive rules for Firefox.

Parameters

None.

Content

This mixin allows extra content to be passed (through the @content directive). Role: Exclusive fix rules for Firefox.

fix-old-ie

@mixin fix-old-ie() { ... }

Description

Mixin for fix rules in very old IE browsers like IE6/7.

Parameters

None.

Content

This mixin allows extra content to be passed (through the @content directive). Role: Exclusive fix rules for IE6/7.

print

shapes

variables

shape-arrow-size

$shape-arrow-size: 20px !default;

Description

The size for "arrow" shape.

Type

Number

Used by

shape-arrow-color

$shape-arrow-color: #666666 !default;

Description

The color for "arrow" shape.

Type

Color

Used by

shape-arrow-thickness

$shape-arrow-thickness: 3px !default;

Description

The thickness size for "arrow" shape.

Type

Number

Used by

shape-checkmark-size

$shape-checkmark-size: 20px !default;

Description

The size for "checkmark" shape.

Type

Number

Used by

shape-checkmark-color

$shape-checkmark-color: #666666 !default;

Description

The color for "checkmark" shape.

Type

Color

Used by

shape-checkmark-thickness

$shape-checkmark-thickness: 3px !default;

Description

The thickness size for "checkmark" shape.

Type

Number

Used by

shape-cross-size

$shape-cross-size: 20px !default;

Description

The size for "cross" shape.

Type

Number

Used by

shape-cross-color

$shape-cross-color: #666666 !default;

Description

The color for "cross" shape.

Type

Color

Used by

shape-cross-thickness

$shape-cross-thickness: 3px !default;

Description

The thickness size for "cross" shape.

Type

Number

Used by

[private] arrow-shape-direction

$arrow-shape-direction: (
    down: 45deg,
    up: -135deg,
    right: -45deg,
    left: 135deg
);

Description

Local map for all arrow shape directions.

Type

Map

Used by

mixins

triangle

@mixin triangle($triangle-size, $triangle-color, $triangle-direction) { ... }

Description

Creates a CSS triangle, which can be used for dropdown arrows, dropdown pips, and more. Use this mixin inside a &::before or &::after selector, to attach the triangle to an existing element.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$triangle-size

Width of the triangle.

Number none
$triangle-color

Color of the triangle.

Color none
$triangle-direction

Direction the triangle points. Can be up, right, down, or left.

Keyword none

arrow

@mixin arrow($arrow-width, $arrow-height, $arrow-color, $arrow-border-width, $arrow-direction: null) { ... }

Description

Creates a CSS arrow, which can be used for dropdown arrows, dropdown pips, and more. Use this mixin inside a &::before or &::after selector, to attach the arrow to an existing element.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$arrow-width

Width of the arrow.

Number none
$arrow-height

Height of the arrow.

Number none
$arrow-color

Color of the arrow.

Color none
$arrow-border-width

The border width of the arrow.

Number none
$arrow-direction

The direction of the arrow. Can be up, right, down, or left.

Keywordnull

Used by

shape-cross

@mixin shape-cross($shape-cross-size, $shape-cross-line-size, $shape-cross-color) { ... }

Description

Creates a CSS "cross" shape, which can be used for modals and more.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$shape-cross-size

Size of the "cross" shape.

Number none
$shape-cross-line-size

Size of lines "cross" shape.

Number none
$shape-cross-color

Color of the "cross" shape.

Color none

Requires

Used by

typography

variables

global-text-direction

$global-text-direction: ltr !default;

Description

Sets the text direction of the CSS. Can be either ltr or rtl.

Type

Keyword

html-root-font-size

$html-root-font-size: true !default;

Description

The basic font size ($global-font-size) will be applied to html.

Type

Boolean

Used by

body-font-family

$body-font-family: 'Work Sans', sans-serif !default;

Description

The default body font family.

Type

String or Keyword

Used by

body-root-font-size

$body-root-font-size: false !default;

Description

If it is true the basic font size ($global-body-font-size) will be applied to body.

Type

Boolean

Used by

body-font-weight

$body-font-weight: normal !default;

Description

The default font weight applied to the body.

Type

String or Integer

Used by

body-line-height

$body-line-height: 1.15 !default;

Description

The defaut body line-height.

Type

Integer or Float

Used by

strong-font-family

$strong-font-family: inherit !default;

Description

Font family applied to the strong andb tags.

Type

String or Keyword

Used by

strong-font-weight

$strong-font-weight: bolder !default;

Description

Font weight applied to the strong andb tags.

Type

String or Keyword

Used by

header-styles

$header-styles: (
    small: (
        'h1': ('font-size': 24),
        'h2': ('font-size': 20),
        'h3': ('font-size': 19),
        'h4': ('font-size': 18),
        'h5': ('font-size': 17),
        'h6': ('font-size': 16),
    ),
    medium: (
        'h1': ('font-size': 48),
        'h2': ('font-size': 40),
        'h3': ('font-size': 31),
        'h4': ('font-size': 25),
        'h5': ('font-size': 20),
        'h6': ('font-size': 16),
    ),
) !default;

Description

Styles for headings at various screen sizes. Each key is a breakpoint, and each value is a map of heading styles.

The possible values to pass to the map are:

  • font-size or fs
  • line-height or lh
  • letter-spacing or ls
  • margin-top or mt
  • margin-bottom or mb

Each value must obviously be comma separated. Only integers are accepted. Any value passed in rem or em will be ignored. The output will always be in px, except for the line-height property. Except for the line-height or lh value, in addition to integers, floats are also accepted.

Type

Map

Used by

headers-font-family

$headers-font-family: inherit !default;

Description

The font-family applied on each headers.

Type

Keyword or String

Used by

headers-font-weight

$headers-font-weight: bold !default;

Description

The font-weight applied on each headers.

Type

Keyword or Integer

Used by

headers-line-height

$headers-line-height: 1.4 !default;

Description

The line-height applied on each headers.

Type

Float or Integer or Keyword

Used by

headers-text-transform

$headers-text-transform: uppercase !default;

Description

The text-transform applied on each headers.

Type

Keyword

Used by

headers-letter-spacing

$headers-letter-spacing: normal !default;

Description

The letter-spacing applied on each headers.

Type

Keyword or Number

Used by

headers-color

$headers-color: #666666 !default;

Description

The color applied on each headers.

Type

Color

Used by

headers-margin-bottom

$headers-margin-bottom: 16px !default;

Description

The color applied on each headers.

Type

Number

Used by

paragraph-font-family

$paragraph-font-family: 'Josefin Sans', sans-serif !default;

Description

The font-family applied on each paragraphs.

Type

String or Keyword

Used by

paragraph-font-weight

$paragraph-font-weight: normal !default;

Description

The font-weight applied on each paragraphs.

Type

Keyword or Integer

Used by

paragraph-line-height

$paragraph-line-height: 1.4 !default;

Description

The line-height applied on each paragraphs.

Type

Integer or Float

Used by

paragraph-letter-spacing

$paragraph-letter-spacing: normal !default;

Description

The letter-spacing applied on each paragraphs.

Type

String or Integer

Used by

paragraph-text-transform

$paragraph-text-transform: none !default;

Description

The text-transform applied on each paragraphs.

Type

Keyword

Used by

paragraph-color

$paragraph-color: #666666 !default;

Description

The color applied on each paragraphs.

Type

Color

Used by

paragraph-margin

$paragraph-margin: 0 !default;

Description

The margin applied on each paragraphs.

Type

Integer or Keyword

Used by

mixins

foundation-text-alignment

@mixin foundation-text-alignment() { ... }

Description

Mixin for text alignment.

Parameters

None.

Requires

Used by

headers-style-bp

@mixin headers-style-bp() { ... }

Description

Mixin for global headers styles in breakpoints.

Parameters

None.

Requires

Used by

headers-style

@mixin headers-style() { ... }

Description

Mixin for global headers style

Each header has in association a class to invoke in the templates.

Parameters

None.

Requires

Used by

paragraph-style

@mixin paragraph-style() { ... }

Description

Mixin for set global paragraph style

Parameters

None.

Requires

Used by

text-transform-classes

@mixin text-transform-classes() { ... }

Description

Mixin for all text-transform values with helper classes.

Parameters

None.

Requires

Used by

no-text

@mixin no-text() { ... }

Description

Mixin for no text shown.

Parameters

None.

Used by

text-ellipsis

@mixin text-ellipsis() { ... }

Description

Mixin for create "ellipsis text".

When the space for the text is no longer available in a large size for a button, for example.

Parameters

None.

Example

Lorem ipsum dolor sit amet....

Used by

functions

str-replace

@function str-replace($string, $search, $replace: '') { ... }

Description

Function for string replace.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$string

Initial string

String none
$search

Substring to replace

String none
$replace

New value to replace

String''

Returns

String

Updated string with new value.

Used by

units

functions

strip-unit

@function strip-unit($num) { ... }

Description

Removes the unit (e.g. px, em, rem) from a value, returning the number only.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$num

Number to strip unit from.

Number none

Returns

Number

The same number, sans unit.

Used by

unitless-calc

@function unitless-calc($value, $base) { ... }

Description

Converts a pixel, percentage, rem or em value to a unitless value based on a given font size. Ideal for working out unitless line heights.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$value

Value to convert to a unitless line height

Number none
$base

The font size to use to work out the line height - defaults to $global-font-size

Number none

Returns

Number

Unitless number

Requires

em

@function em($num) { ... }

Description

Function for transform px value to em value.

Only single value in px are accepted.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$num

Number in px to convert in em.

Number none

Returns

Number

em number.

Requires

rem

@function rem($num) { ... }

Description

Function for transform px value to rem value.

Only single value in px are accepted.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$num

Number in px to convert in rem.

Number none

Returns

Number

rem number.

Requires

Used by

visibility

mixins

show-for

@mixin show-for($size) { ... }

Description

Hide an element by default, only displaying it above a certain screen size.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size

Breakpoint to use. Must be a breakpoint defined in $breakpoints.

Keyword none

Requires

Used by

show-for-only

@mixin show-for-only($size) { ... }

Description

Hide an element by default, only displaying it within a certain breakpoint.

Removed unnecessary media query if value is 0.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size

Breakpoint to use. Must be a breakpoint defined in $breakpoints.

Keyword none

Requires

Used by

hide-for

@mixin hide-for($size) { ... }

Description

Show an element by default, and hide it above a certain screen size.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size

Breakpoint to use. Must be a breakpoint defined in $breakpoints.

Keyword none

Requires

Used by

hide-for-only

@mixin hide-for-only($size) { ... }

Description

Show an element by default, and hide it above a certain screen size.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size

Breakpoint to use. Must be a breakpoint defined in $breakpoints.

Keyword none

Requires

Used by

visuallyhidden

@mixin visuallyhidden() { ... }

Description

Mixin for visuallyhidden.

This hide the target element visually only, but not it's interaction.

Parameters

None.

Used by

visuallyhidden-off

@mixin visuallyhidden-off() { ... }

Description

Mixin for restores the style applied by visuallyhidden mixin.

Parameters

None.

Used by

xy-grid

functions

xy-cell-size

@function xy-cell-size($size: $grid-columns) { ... }

Description

Calculate the percentage size of a cell.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size

Size to make the cell. You can pass a value in multiple formats, such as 6, 50%, 1 of 2 or 1/3.

Number or List$grid-columns

Throws

  • Wrong syntax for xy-cell-size(). Use the format

  • Wrong syntax for xy-cell-size(). Use a number, decimal, percentage, or

Requires

Used by

mixins

xy-cell-base

@mixin xy-cell-base($size: full) { ... }

Description

Sets base flex properties for cells.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size

The size of your cell. Accepts full, auto, shrink or grow.

Keywordfull

Used by

xy-cell-reset

@mixin xy-cell-reset($vertical: false) { ... }

Description

Resets a cells width (or height if vertical is true) as well as strips its gutters.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$vertical

Set to true to output vertical (height) styles rather than widths.

Booleanfalse

xy-cell

@mixin xy-cell($size: full, $gutter-output: true, $gutters: $grid-margin-gutters, $gutter-type: margin, $gutter-position: right left, $breakpoint: null, $vertical: false) { ... }

Description

Creates a cell for your grid.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size

The size of your cell. Can be full (default) for 100% width, auto to use up available space and shrink to use up only required space.

Keyword or Numberfull
$gutter-output

Whether or not to output gutters. Always true for margin gutters.

Booleantrue
$gutters

Map or single value for gutters.

Number or Map$grid-margin-gutters
$gutter-type

Map or single value for gutters.

Keywordmargin
$gutter-position

The position to apply gutters to. Accepts top, bottom, left, right in any combination.

Listright left
$breakpoint

The name of the breakpoint size in your gutters map to get the size from. If using with the breakpoint() mixin this will be set automatically unless manually entered.

Stringnull
$vertical

Set to true to output vertical (height) styles rather than widths.

Booleanfalse

Requires

Used by

xy-cell-static

@mixin xy-cell-static($size: full, $gutter-output: true, $gutters: $grid-margin-gutters, $gutter-type: margin, $breakpoint: null, $vertical: false) { ... }

Description

Creates a single breakpoint sized grid. Used to generate our grid classes.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size

The size of your cell. Can be full (default) for 100% width, auto to use up available space and shrink to use up only required space.

Keyword or Numberfull
$gutter-output

Whether or not to output gutters. Always true for margin gutters.

Booleantrue
$gutters

Map or single value for gutters.

Number or Map$grid-margin-gutters
$gutter-type

Map or single value for gutters.

Keywordmargin
$breakpoint

The name of the breakpoint size in your gutters map to get the size from. If using with the breakpoint() mixin this will be set automatically unless manually entered.

Stringnull
$vertical

Set to true to output vertical (height) styles rather than widths.

Booleanfalse

Requires

Used by

xy-grid-collapse

@mixin xy-grid-collapse($selector: .cell, $gutter-type: margin, $gutter-position: right left, $min-breakpoint: $-zf-zero-breakpoint) { ... }

Description

Collapses the grid a cells within it.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$selector

The child element to remove the gutter from.

String.cell
$gutter-type

The type of gutter to remove.

Keywordmargin
$gutter-position

The positions to remove gutters from. Accepts top, bottom, left, right in any combination.

Listright left
$min-breakpoint

Minimum breakpoint in $breakpoint-classes for which to collapse the gutter.

Keyword$-zf-zero-breakpoint

Requires

xy-grid-frame

@mixin xy-grid-frame($vertical: false, $nested: false, $gutters: null, $breakpoint: null, $include-base: true) { ... }

Description

Modifies a grid to give it "frame" behavior (no overflow, no wrap, stretch behavior)

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$vertical

Is grid vertical or horizontal. Should match grid.

Booleanfalse
$nested

Is grid nested or not. If nested is true this sets the frame to 100% height, otherwise will be 100vh.

Booleanfalse
$gutters

Map or single value for gutters.

Number or Mapnull
$breakpoint

The name of the breakpoint size in your gutters map to get the size from.

Stringnull
$include-base

Include the base styles that don't vary per breakpoint.

Booleantrue

xy-cell-block

@mixin xy-cell-block($vertical: false) { ... }

Description

Modifies a cell to give it "block" behavior (overflow auto, inertial scrolling)

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$vertical

Is grid vertical or horizontal. Should match grid.

Booleanfalse

xy-cell-block-container

@mixin xy-cell-block-container() { ... }

Description

Container for inside a grid frame containing multiple blocks. Typically used as a modifier for a .cell to allow the cell to pass along flex sizing constraints / from parents to children.

Parameters

None.

xy-grid-container

@mixin xy-grid-container($width: $grid-container, $padding: $grid-container-padding) { ... }

Description

Creates a max width container, designed to house your grid content.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$width

a width to limit the container to.

Number$grid-container
$padding

paddings of the container.

Number$grid-container-padding

Requires

xy-grid

@mixin xy-grid($direction: horizontal, $wrap: true) { ... }

Description

Creates a container for your flex cells.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$direction

Either horizontal or vertical direction of cells within.

Keywordhorizontal
$wrap

If the cells within should wrap or not.

Booleantrue

xy-gutters

@mixin xy-gutters($gutters: $grid-margin-gutters, $gutter-type: margin, $gutter-position: right left, $negative: false) { ... }

Description

Create gutters for a cell/container.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$gutters

Map or single value for gutters.

Number or Map$grid-margin-gutters
$gutter-type

Type of gutter to output. Accepts either margin or padding.

Keywordmargin
$gutter-position

The position to apply gutters to. Accepts top, bottom, left, right in any combination.

Listright left
$negative

Whether to apply the gutter as a negative value. Commonly used for nested grids.

Booleanfalse

Used by

xy-grid-layout

@mixin xy-grid-layout($n, $selector: '.cell', $gutter-output: true, $gutters: $grid-margin-gutters, $gutter-type: margin, $gutter-position: right left, $breakpoint: null, $vertical: false) { ... }

Description

Sizes child elements so that $n number of items appear on each row.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$n

Number of elements to display per row.

Number none
$selector

Selector(s) to use for child elements.

String'.cell'
$gutter-output

Whether or not to output gutters. Always true for margin gutters.

Booleantrue
$gutters

Map or single value for gutters.

Number or Map$grid-margin-gutters
$gutter-type

Type of gutter to output. Accepts margin or padding.

Keywordmargin
$gutter-position

The position to apply gutters to. Accepts top, bottom, left, right in any combination.

Listright left
$breakpoint

The breakpoint to use for the cell generation.

Stringnull
$vertical

Set to true to output vertical (height) styles rather than widths.

Booleanfalse

Requires

xy-cell-offset

@mixin xy-cell-offset($n, $gutters: $grid-margin-gutters, $gutter-type: margin, $breakpoint: $-zf-zero-breakpoint, $vertical: false) { ... }

Description

Offsets a column to the right/bottom by $n columns.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$n

Size to offset by. You can pass in any value accepted by the zf-cell() mixin, such as 6, 50%, or 1 of 2.

Number or List none
$gutters

Map of gutters or single value to use for responsive gutters.

Number or Map$grid-margin-gutters
$gutter-type

The type of gutter to use. Can be margin or padding

Keywordmargin
$breakpoint

Single value, breakpoint name, or list of breakpoint names to use for $gutters. See -zf-breakpoint-value().

Number or Array or Keyword$-zf-zero-breakpoint
$vertical

Sets the direction of the offset. If set to true will apply margin-top instead.

Booleanfalse

Requires

variables

grid-container

$grid-container: 1200px !default;

Description

The maximum width of a grid container.

Type

Number

grid-columns

$grid-columns: 12 !default;

Description

The number of columns used in the grid.

Type

Number

Used by

grid-margin-gutters

$grid-margin-gutters: (
    small: 20px,
    medium: 30px
) !default;

Description

The amount of margin between cells at different screen sizes when using the margin grid. To use just one size, set the variable to a number instead of a map.

Type

Map or Length

grid-padding-gutters

$grid-padding-gutters: $grid-margin-gutters !default;

Description

The amount of padding in cells at different screen sizes when using the padding grid. To use just one size, set the variable to a number instead of a map.

Type

Map or Length

grid-container-padding

$grid-container-padding: $grid-padding-gutters !default;

Description

The amount of padding to use when padding the grid-container.

Type

Map or Length

grid-container-max

$grid-container-max: $grid-container !default;

Description

The maximum width to apply to a grid container

Type

Number

xy-block-grid-max

$xy-block-grid-max: 8 !default;

Description

The maximum number of cells in an XY block grid.

Type

Number