_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
- [mixin]
manage-palette
- [variable]
palette-color
shape-classes
@mixin shape-classes() { ... }
Description
Mixin for shape classes.
Parameters
None.
Requires
- [mixin]
arrow
- [mixin]
shape-cross
- [variable]
shape-arrow-size
- [variable]
shape-arrow-size
- [variable]
shape-arrow-color
- [variable]
shape-arrow-thickness
- [variable]
shape-arrow-thickness
- [variable]
arrow-shape-direction
- [variable]
shape-checkmark-size
- [variable]
shape-checkmark-size
- [variable]
shape-checkmark-color
- [variable]
shape-checkmark-thickness
- [variable]
shape-cross-size
- [variable]
shape-cross-thickness
- [variable]
shape-cross-color
foundation-grid
@mixin foundation-grid() { ... }
Description
Foundation Float Grid. No rem
conversion for the gutters.
Parameters
None.
Requires
- [mixin]
grid-row
- [mixin]
grid-row-nest
- [mixin]
grid-row-size
- [mixin]
grid-layout
- [mixin]
grid-column-margin
- [variable]
grid-column-gutter
- [variable]
grid-column-gutter
- [variable]
grid-column-align-edge
- [variable]
grid-column-count
- [variable]
grid-column-count
- [variable]
block-grid-max
- [variable]
grid-column-alias
- [variable]
grid-column-alias
Links
global-fonts
@mixin global-fonts() { ... }
Description
Mixin for importing Google Fonts and/or @font-face
fonts globally.
Parameters
None.
Requires
- [mixin]
font-face
- [variable]
google-fonts-load
- [variable]
google-fonts-family
- [variable]
font-face-load
- [variable]
font-face-map
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
- [mixin]
fields-style
- [mixin]
fields-validation-style
- [mixin]
autofill-style
- [mixin]
placeholder-style
- [mixin]
select-style
- [mixin]
textarea-style
- [mixin]
label-style
- [variable]
form-input-custom-autofill
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
- [mixin]
checkbox-radio-style
- [mixin]
checkbox-shape
- [mixin]
checkbox-attr
- [mixin]
checkbox-validation
- [mixin]
radio-shape
- [mixin]
radio-attr
- [mixin]
radio-validation
- [variable]
custom-checkbox-radio-align-center
- [variable]
custom-checkbox-radio-size
- [variable]
custom-checkbox-radio-hover-border
- [variable]
custom-checkbox-radio-hover-border-color
- [variable]
custom-checkbox-radio-checked-border
- [variable]
global-form-inputs-error-class
- [variable]
global-custom-checkbox-radio
- [variable]
custom-checkbox-radio-label-gutter
- [variable]
custom-checkbox-radio-cursor
- [variable]
custom-checkbox-radio-background-color
- [variable]
custom-checkbox-radio-border
- [variable]
custom-checkbox-radio-font-family
- [variable]
custom-checkbox-radio-font-size
- [variable]
custom-checkbox-radio-text-transform
- [variable]
custom-checkbox-radio-letter-spacing
- [variable]
custom-checkbox-radio-color
- [variable]
global-custom-checkbox-radio
- [variable]
custom-checkbox-mark-color
- [variable]
custom-checkbox-mark-thick
- [variable]
custom-checkbox-border-radius
- [variable]
custom-checkbox-checked-border-color
- [variable]
custom-checkbox-focus-border-color
- [variable]
custom-checkbox-error-border-color
- [variable]
custom-checkbox-error-background-color
- [variable]
global-custom-checkbox-radio
- [variable]
custom-radio-mark-color
- [variable]
custom-radio-checked-border-color
- [variable]
custom-radio-focus-border-color
- [variable]
custom-radio-error-border-color
- [variable]
custom-radio-error-background-color
accessibility-classes
@mixin accessibility-classes() { ... }
Description
Accessibility classes mixin.
Parameters
None.
Requires
- [mixin]
visuallyhidden
- [mixin]
visuallyhidden-off
- [mixin]
no-text
- [variable]
selection-background-color
- [variable]
selection-color-apply
- [variable]
selection-color
clearfix-classes
@mixin clearfix-classes() { ... }
Description
Clearfix classes.
Parameters
None.
Requires
- [mixin]
clearfix
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
- [mixin]
flex-align
- [mixin]
flex-align
- [mixin]
flex-align-self
- [mixin]
flex-align
- [mixin]
flex-order
- [mixin]
flex-helpers
- [variable]
flex-source-ordering-count-enable
- [variable]
flex-source-ordering-count
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
- [variable]
print-transparent-background
- [variable]
print-color-black
- [variable]
print-link-href-show
- [variable]
print-margin
Links
foundation-visibility-classes
@mixin foundation-visibility-classes() { ... }
Description
Foundation visibilty clasess.
Parameters
None.
Requires
- [mixin]
hide-for
- [mixin]
show-for
- [mixin]
hide-for-only
- [mixin]
show-for-only
- [mixin]
breakpoint
- [mixin]
breakpoint
- [mixin]
breakpoint
- [mixin]
breakpoint
- [variable]
breakpoint-classes
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
- [mixin]
visuallyhidden
- [mixin]
visuallyhidden
- [variable]
global-input-reset-appearence
- [variable]
html-root-font-size
- [variable]
global-font-size
- [variable]
ios-tap-color
- [variable]
body-font-family
- [variable]
body-font-weight
- [variable]
body-root-font-size
- [variable]
global-body-font-size
- [variable]
body-background-color
- [variable]
body-base-color
- [variable]
body-line-height
- [variable]
links-color
- [variable]
global-links-text-decoration
- [variable]
focus-links-outline-hidden
- [variable]
what-input-outline-keyboard-detect
- [variable]
strong-font-family
- [variable]
strong-font-weight
- [variable]
global-text-rendering
- [variable]
global-letter-spacing-apply
- [variable]
global-letter-spacing
- [variable]
global-font-liga-kern
- [variable]
global-text-direction
- [variable]
body-line-height
- [variable]
focus-inputs-outline-hidden
- [variable]
what-input-outline-keyboard-detect
- [variable]
global-custom-checkbox-radio
- [variable]
global-input-search-cancel-button
- [variable]
global-select-reset-appearence
- [variable]
body-base-color
- [variable]
global-select-reset-appearance-options
Links
global-typography
@mixin global-typography() { ... }
Description
Mixin for global typography.
Parameters
None.
Requires
- [mixin]
headers-style
- [mixin]
headers-style-bp
- [mixin]
paragraph-style
- [mixin]
foundation-text-alignment
- [mixin]
text-transform-classes
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
- [mixin]
checkbox-attr
- [mixin]
radio-attr
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
- [mixin]
checkbox-attr
- [mixin]
radio-attr
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
- [mixin]
accessibility-classes
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
- [mixin]
accessibility-classes
selection-color
$selection-color: initial !default;
Description
The color when an item is selected.
Type
Keyword
or Color
Used by
- [mixin]
accessibility-classes
ios-tap-color
$ios-tap-color: transparent !default;
Description
The tap highlight color for iOS devices.
Type
Color
Used by
- [mixin]
scss-normalize
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
- [mixin]
scss-normalize
- [mixin]
scss-normalize
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
- [mixin]
show-for
- [mixin]
show-for-only
- [mixin]
show-for-only
print-breakpoint
$print-breakpoint: large !default;
Description
The largest named breakpoint in which to include print as a media type
Type
Keyword
Used by
- [mixin]
breakpoint
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
- [mixin]
foundation-visibility-classes
- [mixin]
flex-helpers
- [mixin]
foundation-text-alignment
- [mixin]
xy-grid-collapse
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 Name | parameter Description | parameter Type | parameter 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
- [variable]
print-breakpoint
Used by
- [mixin]
foundation-visibility-classes
- [mixin]
foundation-visibility-classes
- [mixin]
foundation-visibility-classes
- [mixin]
foundation-visibility-classes
- [mixin]
flex-helpers
- [mixin]
grid-layout
- [mixin]
foundation-text-alignment
- [mixin]
headers-style-bp
- [mixin]
show-for
- [mixin]
hide-for
- [mixin]
hide-for-only
- [mixin]
xy-grid-collapse
- [mixin]
xy-grid-collapse
- [mixin]
xy-grid-collapse
- [mixin]
xy-grid-collapse
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
- [mixin]
checkbox-radio-classes
custom-checkbox-radio-font-size
$custom-checkbox-radio-font-size: 13px !default;
Description
Default font size for checkbox-radio components.
Type
Number
Used by
- [mixin]
checkbox-radio-classes
custom-checkbox-radio-text-transform
$custom-checkbox-radio-text-transform: none !default;
Description
Default text transform for checkbo-radio components.
Type
Keyword
Used by
- [mixin]
checkbox-radio-classes
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
- [mixin]
checkbox-radio-classes
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
- [mixin]
checkbox-radio-classes
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
- [mixin]
checkbox-radio-classes
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
- [mixin]
checkbox-radio-classes
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
- [mixin]
checkbox-radio-classes
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
- [mixin]
checkbox-radio-classes
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
- [mixin]
checkbox-radio-classes
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
- [mixin]
checkbox-radio-classes
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
- [mixin]
checkbox-radio-classes
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
- [mixin]
checkbox-radio-classes
custom-checkbox-radio-checked-border
$custom-checkbox-radio-checked-border: true !default;
Type
Boolean
Used by
- [mixin]
checkbox-radio-classes
custom-checkbox-border-radius
$custom-checkbox-border-radius: 5px !default;
Description
The border-radius
for custom checkbox component.
Type
Number
Used by
- [mixin]
checkbox-radio-classes
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
- [mixin]
checkbox-radio-classes
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
- [mixin]
checkbox-radio-classes
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
- [mixin]
checkbox-radio-classes
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
- [mixin]
checkbox-radio-classes
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
- [mixin]
checkbox-radio-classes
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
- [mixin]
checkbox-radio-classes
custom-radio-mark-color
$custom-radio-mark-color: #8c8c8c !default;
Description
The color of the radio
mark.
Type
Color
Used by
- [mixin]
checkbox-radio-classes
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
- [mixin]
checkbox-radio-classes
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
- [mixin]
checkbox-radio-classes
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
- [mixin]
checkbox-radio-classes
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
- [mixin]
checkbox-radio-classes
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$center-align | If | Boolean | false |
$checkbox-size | The size in | Keyword | 24px |
$checkbox-mark-color | The color of the | Color | #8c8c8c |
$checkbox-mark-thick | The thickness of the "arrow" shape. | Keyword | 3px |
$checkbox-border-radius | The | Keyword | 5px |
Requires
Used by
- [mixin]
checkbox-radio-classes
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$hover-border | Enable or disable the ability to have a different | Boolean | false |
$hover-border-color | The color of the | Color | #b2b2b2 |
$checked-border | Enable or disable the ability to have a different | Boolean | true |
$checked-border-color | The | Color | #b2b2b2 |
$focus-border-color | The | Color | #b2b2b2 |
Requires
- [variable]
global-input-disabled-opacity
- [variable]
global-input-disabled-cursor
- [variable]
custom-checkbox-radio-outline-detect
- [variable]
custom-checkbox-radio-what-input-outline-detect
Used by
- [mixin]
checkbox-radio-classes
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$error-class | The validation class failed. | String | error |
$error-border-color | The | Color | #c04649 |
$error-background-color | The | Color | #f2c0c1 |
Used by
- [mixin]
checkbox-radio-classes
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$center-text-align | If | Boolean | false |
$radio-size | The size in | Keyword | 24px |
$mark-color | The color of the | Color | #8c8c8c |
Requires
Used by
- [mixin]
checkbox-radio-classes
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$hover-border | Enable or disable the ability to have a different | Boolean | false |
$hover-border-color | The color of the | Color | #b2b2b2 |
$checked-border | Enable or disable the ability to have a different | Boolean | true |
$checked-border-color | The | Color | #b2b2b2 |
$focus-border-color | The | Color | #b2b2b2 |
Requires
- [variable]
global-input-disabled-opacity
- [variable]
global-input-disabled-cursor
- [variable]
custom-checkbox-radio-outline-detect
- [variable]
custom-checkbox-radio-what-input-outline-detect
Used by
- [mixin]
checkbox-radio-classes
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$error-class | The validation class failed. | String | error |
$error-border-color | The | Color | #c04649 |
$error-background-color | The | Color | #f2c0c1 |
Used by
- [mixin]
checkbox-radio-classes
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$center-text-align | If | Boolean | false |
$checkbox-radio-size | The size in | Keyword | 24px |
$gutter | The space between the | Keyword | 10px |
$cursor | The | Keyword | default |
$background-color | The | Color | #efefef |
$border | The | Keyword | 1px solid #d9d9d9 |
Requires
- [function]
rem
Used by
- [mixin]
checkbox-radio-classes
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
- [mixin]
colors-palette
- [function]
palette
- [function]
palette
- [function]
palette
- [mixin]
manage-palette
- [mixin]
manage-palette
Links
body-background-color
$body-background-color: #ffffff !default;
Description
The default body
background color.
Type
Color
Used by
- [mixin]
scss-normalize
body-base-color
$body-base-color: #666666 !default;
Description
The default body
base color.
Type
Color
Used by
- [mixin]
scss-normalize
- [mixin]
scss-normalize
links-color
$links-color: #61afef !default;
Description
The global links color.
Type
Color
Used by
- [mixin]
scss-normalize
functions
palette
@function palette($color) { ... }
Description
Function for catch HEX color in $palette-color
map.
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$color | The key of | Color | — none |
Throws
No color palette found in
$palette-color
map.
Requires
- [variable]
palette-color
- [variable]
palette-color
- [variable]
palette-color
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 namedprimary
.
Requires
- [variable]
palette-color
- [variable]
palette-color
Used by
- [mixin]
colors-palette
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
- [mixin]
foundation-flex-classes
flex-source-ordering-count
$flex-source-ordering-count: 6 !default;
Description
Default value for the count of source ordering.
Type
Number
Used by
- [mixin]
foundation-flex-classes
flexbox-responsive-breakpoints
$flexbox-responsive-breakpoints: true !default;
Description
Quickly disable/enable Responsive breakpoints for Vanilla Flex Helpers.
Type
Boolean
Used by
- [mixin]
flex-helpers
mixins
[private] flex-helpers
@mixin flex-helpers() { ... }
Description
Vanilla flexbox classes.
Parameters
None.
Requires
- [mixin]
flex
- [mixin]
flex-direction
- [mixin]
breakpoint
- [mixin]
flex
- [mixin]
flex-direction
- [variable]
flexbox-responsive-breakpoints
- [variable]
breakpoint-classes
Used by
- [mixin]
foundation-flex-classes
flex
@mixin flex() { ... }
Description
Enables flexbox by adding display: flex
to the element.
Parameters
None.
Used by
- [mixin]
flex-helpers
- [mixin]
flex-helpers
flex-align
@mixin flex-align($x: null, $y: null) { ... }
Description
Horizontally or vertically aligns the items within a flex container.
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$x | Horizontal alignment to use. Can be | Keyword | null |
$y | Vertical alignment to use. Can be | Keyword | null |
Used by
- [mixin]
foundation-flex-classes
- [mixin]
foundation-flex-classes
- [mixin]
foundation-flex-classes
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$y | Vertical alignment to use. Can be | Keyword | null |
Used by
- [mixin]
foundation-flex-classes
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$order | Order number to apply. | Number | 0 |
Used by
- [mixin]
foundation-flex-classes
flex-direction
@mixin flex-direction($direction: row) { ... }
Description
Change flex-direction
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$direction | Flex direction to use. Can be
| Keyword | row |
Used by
- [mixin]
flex-helpers
- [mixin]
flex-helpers
float grid
functions
grid-column
@function grid-column($columns) { ... }
Description
Calculates the width of a column based on a number of factors.
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$columns | — none | Number 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
- [variable]
grid-column-count
Used by
- [mixin]
grid-column-offset
- [mixin]
grid-column-size
mixins
grid-column
@mixin grid-column($columns: $grid-column-count, $gutters: $grid-column-gutter) { ... }
Description
Creates a grid column.
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$columns | Width of the column. Refer to the | Mixed | $grid-column-count |
$gutters | Spacing between columns. Refer to the | Mixed | $grid-column-gutter |
Requires
- [mixin]
grid-column-size
- [mixin]
grid-column-gutter
- [variable]
grid-column-align-edge
Used by
- [mixin]
grid-column-row
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$gutters | Width of the gutters on either side of the column row. Refer to the | Mixed | $grid-column-gutter |
Requires
- [mixin]
grid-row
- [mixin]
grid-column
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$gutter | — none | Number or Keyword | auto |
$gutters | Gutter map or single value to use. Responsive gutter settings by default. | Number or Map | $grid-column-gutter |
Used by
- [mixin]
grid-column
- [mixin]
grid-column-collapse
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
- [mixin]
grid-column-gutter
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$margin | The bottom margin on grid columns, accepts multiple values:
| Number or Keyword | auto |
$margins | Map or single value to use. Responsive gutter settings by default. | Number or Map | $grid-column-gutter |
Used by
- [mixin]
foundation-grid
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 Name | parameter Description | parameter Type | parameter 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: | Number or List | — none |
Requires
- [mixin]
breakpoint
- [function]
strip-unit
Used by
- [mixin]
foundation-grid
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 Name | parameter Description | parameter Type | parameter 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 Name | parameter Description | parameter Type | parameter 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
- [variable]
grid-column-count
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$n | Width to offset by. You can pass in any value accepted by the | Number or List | — none |
Requires
- [function]
grid-column
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$columns | Number of columns to use. | Number | — none |
$root | If | Boolean | false |
Content
This mixin allows extra content to be passed (through the @content
directive).
Requires
- [variable]
grid-column-count
- [variable]
grid-column-count
- [variable]
grid-column-count
Used by
- [mixin]
grid-row
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$columns | Column count for this row. | Number | null |
$behavior | Modifications to the default grid styles. | Keywords | null |
$size | Maximum size of the row. Set to | Keyword or Number | $grid-row-width |
$cf | Whether or not to include a clearfix. | Boolean | true |
$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
- [mixin]
grid-row-nest
- [mixin]
grid-row-size
- [mixin]
clearfix
- [mixin]
grid-context
Used by
- [mixin]
foundation-grid
- [mixin]
grid-column-row
grid-row-nest
@mixin grid-row-nest($:) { ... }
Description
Inverts the margins of a row to nest it inside of a column.
Parameters
parameter Name | parameter Description | parameter Type | parameter 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
- [mixin]
foundation-grid
- [mixin]
grid-row
grid-row-size
@mixin grid-row-size($:) { ... }
Description
Set a grid row size
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$: | {Keyword|Number} $size [$grid-row-width] Maximum size of the row. Set to |
| — none |
Used by
- [mixin]
foundation-grid
- [mixin]
grid-row
grid-column-size
@mixin grid-column-size($width: $grid-column-count) { ... }
Description
Set the width of a grid column.
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$width | Width to make the column. You can pass in any value accepted by the | Number or List | $grid-column-count |
Requires
- [function]
grid-column
Used by
- [mixin]
grid-column
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
- [mixin]
foundation-grid
- [mixin]
foundation-grid
- [function]
grid-column
- [mixin]
grid-column-position
- [mixin]
grid-context
- [mixin]
grid-context
- [mixin]
grid-context
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
- [mixin]
foundation-grid
- [mixin]
foundation-grid
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
- [mixin]
foundation-grid
- [mixin]
grid-column
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
- [mixin]
foundation-grid
- [mixin]
foundation-grid
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
- [mixin]
foundation-grid
fonts
variables
font-dir
$font-dir: '../fonts/' !default;
Description
The default font dir for catch all font file.
Type
String
Used by
- [mixin]
font-face
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
- [mixin]
global-fonts
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
Thefont-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
- [mixin]
global-fonts
- [function]
font
- [function]
font
google-fonts-load
$google-fonts-load: true !default;
Description
Quickly enable or disable the @import
directive for load Google fonts.
Type
Boolen
Used by
- [mixin]
global-fonts
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
- [mixin]
global-fonts
functions
font
@function font($font-family-key) { ... }
Description
Function for catch font family in $font-face-map
.
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$font-family-key | The | Integer | — none |
Returns
String
—The name of the font family.
Requires
- [variable]
font-face-map
- [variable]
font-face-map
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 Name | parameter Description | parameter Type | parameter 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. | String | normal |
$weight | The font weight of your font. | String or Integer | 400 |
$extension | The extensions available for the font. | String | eot woff woff2 ttf svg |
Requires
- [function]
str-replace
- [variable]
font-dir
Used by
- [mixin]
global-fonts
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
- [mixin]
form-style
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
- [mixin]
autofill-style
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
- [mixin]
autofill-style
form-input-height
$form-input-height: 40px !default;
Description
The initial height of the fields.
Type
Number
Used by
- [mixin]
autofill-style
- [mixin]
fields-style
form-input-font-family
$form-input-font-family: 'Josefin Sans', sans-serif !default;
Description
The font-family
of the fields.
Type
Keyword
Used by
- [mixin]
fields-style
form-input-font-size
$form-input-font-size: 14px !default;
Description
The font-size
of the fields.
Type
Number
Used by
- [mixin]
fields-style
form-input-letter-spacing
$form-input-letter-spacing: normal !default;
Description
The letter-spacing
of the fields.
Type
Keyword
or Number
Used by
- [mixin]
fields-style
form-input-text-transform
$form-input-text-transform: none !default;
Description
The text-transform
of the fields.
Type
Keyword
Used by
- [mixin]
fields-style
form-input-background-color
$form-input-background-color: #efefef !default;
Description
The background-color
of the fields.
Type
Color
Used by
- [mixin]
fields-style
form-input-color
$form-input-color: #666666 !default;
Description
The color
of the fields.
Type
Color
Used by
- [mixin]
fields-style
- [mixin]
select-style
form-input-border
$form-input-border: 1px solid #d9d9d9 !default;
Description
The border
of the fields.
Type
Keyword
Used by
- [mixin]
fields-style
form-input-border-radius
$form-input-border-radius: 5px !default;
Description
The border-radius
of the fields.
Type
Number
Used by
- [mixin]
fields-style
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
- [mixin]
fields-style
form-input-padding
$form-input-padding: 10px !default;
Description
The padding
of the fields.
Type
Number
Used by
- [mixin]
fields-style
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
- [mixin]
autofill-style
- [mixin]
fields-style
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
- [mixin]
fields-style
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
- [mixin]
fields-style
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
- [mixin]
fields-style
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
- [mixin]
fields-style
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
- [mixin]
fields-style
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
- [mixin]
fields-style
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
- [mixin]
fields-style
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
- [mixin]
fields-style
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
- [mixin]
label-style
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
- [mixin]
label-style
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
- [mixin]
label-style
form-label-font-size
$form-label-font-size: 11px !default;
Description
The font-size
for the fields label
element.
Type
Number
Used by
- [mixin]
label-style
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
- [mixin]
label-style
form-label-text-transform
$form-label-text-transform: uppercase !default;
Description
The text-transform
style for the fields label
element.
Type
Keyword
Used by
- [mixin]
label-style
form-label-color
$form-label-color: #8c8c8c !default;
Description
The color
for the fields label
element.
Type
Color
Used by
- [mixin]
label-style
form-label-margin
$form-label-margin: 0 0 5px 0 !default;
Description
The global margin
for the fields label
element.
Type
Number
Used by
- [mixin]
label-style
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
- [mixin]
label-style
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
- [mixin]
placeholder-style
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
- [mixin]
placeholder-style
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
- [mixin]
placeholder-style
form-input-placeholder-color
$form-input-placeholder-color: #8c8c8c !default;
Description
The color of the :placeholder
of the fields.
Type
Color
Used by
- [mixin]
placeholder-style
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
- [mixin]
placeholder-style
- [mixin]
placeholder-style
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
- [mixin]
placeholder-style
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
- [mixin]
select-style
form-select-caret-color
$form-select-caret-color: #8c8c8c !default;
Description
The "caret" color of the select
.
Type
Color
Used by
- [mixin]
select-style
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
- [mixin]
select-style
- [mixin]
select-style
- [mixin]
select-style
form-select-caret-size
$form-select-caret-size: 10px !default;
Description
The "caret" size of the select
.
Type
Number
Used by
- [mixin]
select-style
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
- [mixin]
select-style
form-select-caret-background-size
$form-select-caret-background-size: 10px !default;
Description
The size of the custom "caret" shape
Type
Number
Used by
- [mixin]
select-style
form-textarea-height
$form-textarea-height: 110px !default;
Description
The global height
of textarea.
Type
Number
Used by
- [mixin]
textarea-style
form-textarea-resize
$form-textarea-resize: false !default;
Description
Variable that determines whether to have the texarea resizeable or not.
Type
Boolean
Used by
- [mixin]
textarea-style
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
- [mixin]
textarea-style
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
- [mixin]
fields-validation-style
- [mixin]
fields-validation-style
- [mixin]
fields-validation-style
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
- [mixin]
fields-validation-style
- [mixin]
fields-validation-style
- [mixin]
fields-validation-style
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
- [mixin]
fields-validation-style
- [mixin]
fields-validation-style
- [mixin]
fields-validation-style
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
- [mixin]
fields-validation-style
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
- [mixin]
fields-validation-style
mixins
autofill-style
@mixin autofill-style() { ... }
Description
Mixin for styling up the :-webkit-autofill
for the fields.
Parameters
None.
Requires
- [variable]
form-input-height
- [variable]
form-input-autofill-background-color
- [variable]
form-input-autofill-color
- [variable]
form-input-transition
Used by
- [mixin]
form-style
fields-style
@mixin fields-style() { ... }
Description
Mixin for style all cross browsing inputs wrapped in a configurable "box" class.
Parameters
None.
Requires
- [variable]
form-input-height
- [variable]
form-input-font-family
- [variable]
form-input-font-size
- [variable]
form-input-letter-spacing
- [variable]
form-input-text-transform
- [variable]
form-input-background-color
- [variable]
form-input-color
- [variable]
form-input-border
- [variable]
form-input-border-radius
- [variable]
form-input-box-shadow
- [variable]
form-input-padding
- [variable]
form-input-transition
- [variable]
form-input-focus-properties
- [variable]
form-input-focus-background-color
- [variable]
form-input-focus-border-color
- [variable]
form-input-focus-box-shadow
- [variable]
form-input-hover-properties
- [variable]
form-input-hover-background-color
- [variable]
form-input-hover-border-color
- [variable]
form-input-hover-box-shadow
Used by
- [mixin]
form-style
label-style
@mixin label-style() { ... }
Description
Mixin for style the label
for the fields.
Parameters
None.
Requires
- [variable]
form-inputs-labelclass
- [variable]
form-label-font-family
- [variable]
form-label-font-size
- [variable]
form-label-letter-spacing
- [variable]
form-label-text-transform
- [variable]
form-label-color
- [variable]
form-label-margin
- [variable]
form-inputs-label-error-class
- [variable]
form-input-error-label-color
Used by
- [mixin]
form-style
placeholder-style
@mixin placeholder-style() { ... }
Description
Mixin for style the ::placeholder
for the fields.
Parameters
None.
Requires
- [variable]
form-input-placeholder-font-family
- [variable]
form-input-placeholder-font-style
- [variable]
form-input-placeholder-text-transform
- [variable]
form-input-placeholder-color
- [variable]
form-input-placeholder-focus-hidden
- [variable]
form-input-placeholder-focus-color
- [variable]
global-form-inputs-error-class
- [variable]
form-input-error-placeholder-color
- [variable]
form-input-placeholder-focus-hidden
- [variable]
form-input-placeholder-focus-color
Used by
- [mixin]
form-style
select-style
@mixin select-style() { ... }
Description
Mixin for style the select
for the forms.
Parameters
None.
Requires
- [mixin]
select-caret-shape
- [variable]
form-select-caret-shape-render
- [variable]
form-select-caret-color
- [variable]
form-select-caret-shape
- [variable]
form-select-caret-shape
- [variable]
form-select-caret-size
- [variable]
form-select-caret-image-url
- [variable]
form-select-caret-background-size
- [variable]
form-select-caret-shape
- [variable]
form-input-color
Used by
- [mixin]
form-style
textarea-style
@mixin textarea-style() { ... }
Description
Mixin for style the textarea
for the forms.
Parameters
None.
Requires
- [variable]
form-textarea-height
- [variable]
form-textarea-resize
- [variable]
form-textarea-resize-mode
Used by
- [mixin]
form-style
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$select-caret-color | The color in | Color | #000000 |
$select-caret-shape | The shape for the "caret". Could be | Keyword or String | arrow |
Requires
- [variable]
global-select-reset-appearence
Used by
- [mixin]
select-style
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
- [variable]
global-input-disabled-color
- [variable]
global-input-disabled-opacity
- [variable]
global-input-disabled-cursor
- [variable]
global-form-inputs-error-class
- [variable]
form-input-error-background-color
- [variable]
form-input-error-border-color
- [variable]
form-input-error-box-shadow
- [variable]
form-input-error-color
- [variable]
form-input-error-focus-style
- [variable]
form-input-error-background-color
- [variable]
form-input-error-border-color
- [variable]
form-input-error-box-shadow
- [variable]
form-input-error-background-color
- [variable]
form-input-error-border-color
- [variable]
form-input-error-box-shadow
Used by
- [mixin]
form-style
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
- [mixin]
clearfix
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
- [mixin]
scss-normalize
- [function]
unitless-calc
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
- [mixin]
scss-normalize
- [function]
em
- [function]
rem
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
- [mixin]
scss-normalize
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
- [mixin]
scss-normalize
- [mixin]
select-caret-shape
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
- [mixin]
checkbox-radio-classes
- [mixin]
checkbox-radio-classes
- [mixin]
checkbox-radio-classes
- [mixin]
scss-normalize
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
- [mixin]
fields-validation-style
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
- [mixin]
checkbox-attr
- [mixin]
radio-attr
- [mixin]
fields-validation-style
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
- [mixin]
checkbox-attr
- [mixin]
radio-attr
- [mixin]
fields-validation-style
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
- [mixin]
checkbox-radio-classes
- [mixin]
placeholder-style
- [mixin]
fields-validation-style
global-links-text-decoration
$global-links-text-decoration: true !default;
Description
Enable or disable the default text-decoration
for all links.
Type
Boolean
Used by
- [mixin]
scss-normalize
global-text-rendering
$global-text-rendering: optimizeLegibility !default;
Description
Global text rendering applied to body
, button
, input
, select
and textarea
.
Type
Keyword
Used by
- [mixin]
scss-normalize
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
- [mixin]
scss-normalize
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
- [mixin]
scss-normalize
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
- [mixin]
scss-normalize
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
- [mixin]
scss-normalize
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
- [mixin]
scss-normalize
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
- [mixin]
scss-normalize
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
- [variable]
global-flexbox
Used by
- [mixin]
clearfix-classes
- [mixin]
grid-row
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 Name | parameter Description | parameter Type | parameter 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 | String | space |
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
variables
print-transparent-background
$print-transparent-background: false !default;
Description
If true
, all elements will have transparent backgrounds when printed, to save on ink.
Type
Boolean
Used by
- [mixin]
media-print
print-color-black
$print-color-black: false !default;
Description
If true
, all link have black color when printed.
Used by
- [mixin]
media-print
print-link-href-show
$print-link-href-show: false !default;
Description
If true
, all link show your href
attribute when printed.
Used by
- [mixin]
media-print
print-margin
$print-margin: 0.5cm !default;
Description
The global margin that a page can have when printed.
Used by
- [mixin]
media-print
shapes
variables
shape-arrow-size
$shape-arrow-size: 20px !default;
Description
The size for "arrow" shape.
Type
Number
Used by
- [mixin]
shape-classes
- [mixin]
shape-classes
shape-arrow-color
$shape-arrow-color: #666666 !default;
Description
The color for "arrow" shape.
Type
Color
Used by
- [mixin]
shape-classes
shape-arrow-thickness
$shape-arrow-thickness: 3px !default;
Description
The thickness size for "arrow" shape.
Type
Number
Used by
- [mixin]
shape-classes
- [mixin]
shape-classes
shape-checkmark-size
$shape-checkmark-size: 20px !default;
Description
The size for "checkmark" shape.
Type
Number
Used by
- [mixin]
shape-classes
- [mixin]
shape-classes
shape-checkmark-color
$shape-checkmark-color: #666666 !default;
Description
The color for "checkmark" shape.
Type
Color
Used by
- [mixin]
shape-classes
shape-checkmark-thickness
$shape-checkmark-thickness: 3px !default;
Description
The thickness size for "checkmark" shape.
Type
Number
Used by
- [mixin]
shape-classes
shape-cross-size
$shape-cross-size: 20px !default;
Description
The size for "cross" shape.
Type
Number
Used by
- [mixin]
shape-classes
- [mixin]
shape-cross
- [mixin]
shape-cross
shape-cross-color
$shape-cross-color: #666666 !default;
Description
The color for "cross" shape.
Type
Color
Used by
- [mixin]
shape-classes
- [mixin]
shape-cross
shape-cross-thickness
$shape-cross-thickness: 3px !default;
Description
The thickness size for "cross" shape.
Type
Number
Used by
- [mixin]
shape-classes
[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
- [mixin]
shape-classes
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 Name | parameter Description | parameter Type | parameter 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 | 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 Name | parameter Description | parameter Type | parameter 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 | Keyword | null |
Used by
- [mixin]
shape-classes
- [mixin]
checkbox-shape
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 Name | parameter Description | parameter Type | parameter 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
- [function]
rem
- [variable]
shape-cross-size
- [variable]
shape-cross-size
- [variable]
shape-cross-color
Used by
- [mixin]
shape-classes
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
- [mixin]
scss-normalize
body-font-family
$body-font-family: 'Work Sans', sans-serif !default;
Description
The default body font family.
Type
String
or Keyword
Used by
- [mixin]
scss-normalize
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
- [mixin]
scss-normalize
body-font-weight
$body-font-weight: normal !default;
Description
The default font weight applied to the body
.
Type
String
or Integer
Used by
- [mixin]
scss-normalize
body-line-height
$body-line-height: 1.15 !default;
Description
The defaut body
line-height.
Type
Integer
or Float
Used by
- [mixin]
scss-normalize
- [mixin]
scss-normalize
strong-font-family
$strong-font-family: inherit !default;
Description
Font family applied to the strong
andb
tags.
Type
String
or Keyword
Used by
- [mixin]
scss-normalize
strong-font-weight
$strong-font-weight: bolder !default;
Description
Font weight applied to the strong
andb
tags.
Type
String
or Keyword
Used by
- [mixin]
scss-normalize
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
orfs
line-height
orlh
letter-spacing
orls
margin-top
ormt
margin-bottom
ormb
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
- [mixin]
headers-style-bp
headers-font-family
$headers-font-family: inherit !default;
Description
The font-family
applied on each headers.
Type
Keyword
or String
Used by
- [mixin]
headers-style
headers-font-weight
$headers-font-weight: bold !default;
Description
The font-weight
applied on each headers.
Type
Keyword
or Integer
Used by
- [mixin]
headers-style
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
- [mixin]
headers-style-bp
headers-text-transform
$headers-text-transform: uppercase !default;
Description
The text-transform
applied on each headers.
Type
Keyword
Used by
- [mixin]
headers-style
headers-letter-spacing
$headers-letter-spacing: normal !default;
Description
The letter-spacing
applied on each headers.
Type
Keyword
or Number
Used by
- [mixin]
headers-style-bp
headers-color
$headers-color: #666666 !default;
Description
The color
applied on each headers.
Type
Color
Used by
- [mixin]
headers-style
headers-margin-bottom
$headers-margin-bottom: 16px !default;
Description
The color
applied on each headers.
Type
Number
Used by
- [mixin]
headers-style-bp
- [mixin]
headers-style-bp
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
- [mixin]
paragraph-style
paragraph-font-weight
$paragraph-font-weight: normal !default;
Description
The font-weight
applied on each paragraphs.
Type
Keyword
or Integer
Used by
- [mixin]
paragraph-style
paragraph-line-height
$paragraph-line-height: 1.4 !default;
Description
The line-height
applied on each paragraphs.
Type
Integer
or Float
Used by
- [mixin]
paragraph-style
paragraph-letter-spacing
$paragraph-letter-spacing: normal !default;
Description
The letter-spacing
applied on each paragraphs.
Type
String
or Integer
Used by
- [mixin]
paragraph-style
paragraph-text-transform
$paragraph-text-transform: none !default;
Description
The text-transform
applied on each paragraphs.
Type
Keyword
Used by
- [mixin]
paragraph-style
paragraph-color
$paragraph-color: #666666 !default;
Description
The color
applied on each paragraphs.
Type
Color
Used by
- [mixin]
paragraph-style
paragraph-margin
$paragraph-margin: 0 !default;
Description
The margin
applied on each paragraphs.
Type
Integer
or Keyword
Used by
- [mixin]
paragraph-style
mixins
foundation-text-alignment
@mixin foundation-text-alignment() { ... }
Description
Mixin for text alignment.
Parameters
None.
Requires
- [mixin]
breakpoint
- [variable]
breakpoint-classes
Used by
- [mixin]
global-typography
headers-style-bp
@mixin headers-style-bp() { ... }
Description
Mixin for global headers styles in breakpoints.
Parameters
None.
Requires
- [mixin]
breakpoint
- [function]
strip-unit
- [function]
strip-unit
- [function]
strip-unit
- [function]
strip-unit
- [function]
strip-unit
- [function]
strip-unit
- [function]
strip-unit
- [function]
strip-unit
- [function]
strip-unit
- [variable]
header-styles
- [variable]
headers-letter-spacing
- [variable]
headers-margin-bottom
- [variable]
headers-line-height
- [variable]
headers-margin-bottom
Used by
- [mixin]
global-typography
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
- [variable]
headers-font-family
- [variable]
headers-font-weight
- [variable]
headers-text-transform
- [variable]
headers-color
Used by
- [mixin]
global-typography
paragraph-style
@mixin paragraph-style() { ... }
Description
Mixin for set global paragraph style
Parameters
None.
Requires
- [variable]
paragraph-font-family
- [variable]
paragraph-font-weight
- [variable]
paragraph-line-height
- [variable]
paragraph-letter-spacing
- [variable]
paragraph-text-transform
- [variable]
paragraph-color
- [variable]
paragraph-margin
Used by
- [mixin]
global-typography
text-transform-classes
@mixin text-transform-classes() { ... }
Description
Mixin for all text-transform
values with helper classes.
Parameters
None.
Requires
- [mixin]
text-ellipsis
Used by
- [mixin]
global-typography
no-text
@mixin no-text() { ... }
Description
Mixin for no text shown.
Parameters
None.
Used by
- [mixin]
accessibility-classes
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
- [mixin]
text-transform-classes
functions
str-replace
@function str-replace($string, $search, $replace: '') { ... }
Description
Function for string replace.
Parameters
parameter Name | parameter Description | parameter Type | parameter 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
- [mixin]
font-face
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$num | Number to strip unit from. | Number | — none |
Returns
Number
—The same number, sans unit.
Used by
- [mixin]
grid-layout
- [mixin]
headers-style-bp
- [mixin]
headers-style-bp
- [mixin]
headers-style-bp
- [mixin]
headers-style-bp
- [mixin]
headers-style-bp
- [mixin]
headers-style-bp
- [mixin]
headers-style-bp
- [mixin]
headers-style-bp
- [mixin]
headers-style-bp
- [function]
unitless-calc
- [function]
unitless-calc
- [function]
unitless-calc
- [function]
unitless-calc
- [function]
unitless-calc
- [function]
unitless-calc
- [function]
unitless-calc
- [mixin]
show-for-only
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 Name | parameter Description | parameter Type | parameter 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
- [function]
strip-unit
- [function]
strip-unit
- [function]
strip-unit
- [function]
strip-unit
- [function]
strip-unit
- [function]
strip-unit
- [function]
strip-unit
- [variable]
global-font-size
em
@function em($num) { ... }
Description
Function for transform px value to em value.
Only single value in px
are accepted.
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$num | Number in px to convert in em. | Number | — none |
Returns
Number
—em
number.
Requires
- [variable]
global-body-font-size
rem
@function rem($num) { ... }
Description
Function for transform px value to rem value.
Only single value in px
are accepted.
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$num | Number in px to convert in rem. | Number | — none |
Returns
Number
—rem
number.
Requires
- [variable]
global-body-font-size
Used by
- [mixin]
checkbox-shape
- [mixin]
checkbox-shape
- [mixin]
checkbox-shape
- [mixin]
checkbox-shape
- [mixin]
checkbox-shape
- [mixin]
radio-shape
- [mixin]
radio-shape
- [mixin]
radio-shape
- [mixin]
radio-shape
- [mixin]
radio-shape
- [mixin]
checkbox-radio-style
- [mixin]
shape-cross
visibility
mixins
show-for
@mixin show-for($size) { ... }
Description
Hide an element by default, only displaying it above a certain screen size.
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$size | Breakpoint to use. Must be a breakpoint defined in | Keyword | — none |
Requires
- [mixin]
breakpoint
- [variable]
breakpoints
Used by
- [mixin]
foundation-visibility-classes
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$size | Breakpoint to use. Must be a breakpoint defined in | Keyword | — none |
Requires
- [function]
strip-unit
- [variable]
breakpoints
- [variable]
breakpoints
Used by
- [mixin]
foundation-visibility-classes
hide-for
@mixin hide-for($size) { ... }
Description
Show an element by default, and hide it above a certain screen size.
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$size | Breakpoint to use. Must be a breakpoint defined in | Keyword | — none |
Requires
- [mixin]
breakpoint
Used by
- [mixin]
foundation-visibility-classes
hide-for-only
@mixin hide-for-only($size) { ... }
Description
Show an element by default, and hide it above a certain screen size.
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$size | Breakpoint to use. Must be a breakpoint defined in | Keyword | — none |
Requires
- [mixin]
breakpoint
Used by
- [mixin]
foundation-visibility-classes
xy-grid
functions
xy-cell-size
@function xy-cell-size($size: $grid-columns) { ... }
Description
Calculate the percentage size of a cell.
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$size | Size to make the cell. You can pass a value in multiple formats, such as | 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
- [variable]
grid-columns
Used by
- [mixin]
xy-cell-offset
- [mixin]
xy-cell-offset
mixins
xy-cell-base
@mixin xy-cell-base($size: full) { ... }
Description
Sets base flex properties for cells.
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$size | The size of your cell. Accepts | Keyword | full |
Used by
- [mixin]
xy-cell
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$vertical | Set to true to output vertical (height) styles rather than widths. | Boolean | false |
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$size | The size of your cell. Can be | Keyword or Number | full |
$gutter-output | Whether or not to output gutters. Always | Boolean | true |
$gutters | Map or single value for gutters. | Number or Map | $grid-margin-gutters |
$gutter-type | Map or single value for gutters. | Keyword | margin |
$gutter-position | The position to apply gutters to. Accepts | List | right left |
$breakpoint | The name of the breakpoint size in your gutters map to get the size from. If using with the | String | null |
$vertical | Set to true to output vertical (height) styles rather than widths. | Boolean | false |
Requires
- [mixin]
xy-cell-base
- [mixin]
xy-gutters
Used by
- [mixin]
xy-grid-layout
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$size | The size of your cell. Can be | Keyword or Number | full |
$gutter-output | Whether or not to output gutters. Always | Boolean | true |
$gutters | Map or single value for gutters. | Number or Map | $grid-margin-gutters |
$gutter-type | Map or single value for gutters. | Keyword | margin |
$breakpoint | The name of the breakpoint size in your gutters map to get the size from. If using with the | String | null |
$vertical | Set to true to output vertical (height) styles rather than widths. | Boolean | false |
Requires
- [mixin]
xy-gutters
Used by
- [mixin]
xy-grid-collapse
- [mixin]
xy-grid-collapse
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$selector | The child element to remove the gutter from. | String | .cell |
$gutter-type | The type of gutter to remove. | Keyword | margin |
$gutter-position | The positions to remove gutters from. Accepts | List | right left |
$min-breakpoint | Minimum breakpoint in | Keyword | $-zf-zero-breakpoint |
Requires
- [mixin]
breakpoint
- [mixin]
breakpoint
- [mixin]
xy-cell-static
- [mixin]
breakpoint
- [mixin]
xy-cell-static
- [mixin]
breakpoint
- [variable]
breakpoint-classes
- [variable]
grid-columns
- [variable]
grid-columns
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$vertical | Is grid vertical or horizontal. Should match grid. | Boolean | false |
$nested | Is grid nested or not. If nested is true this sets the frame to 100% height, otherwise will be 100vh. | Boolean | false |
$gutters | Map or single value for gutters. | Number or Map | null |
$breakpoint | The name of the breakpoint size in your gutters map to get the size from. | String | null |
$include-base | Include the base styles that don't vary per breakpoint. | Boolean | true |
xy-cell-block
@mixin xy-cell-block($vertical: false) { ... }
Description
Modifies a cell to give it "block" behavior (overflow auto, inertial scrolling)
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$vertical | Is grid vertical or horizontal. Should match grid. | Boolean | false |
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$width | a width to limit the container to. | Number | $grid-container |
$padding | paddings of the container. | Number | $grid-container-padding |
Requires
- [mixin]
xy-gutters
xy-grid
@mixin xy-grid($direction: horizontal, $wrap: true) { ... }
Description
Creates a container for your flex cells.
Parameters
parameter Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$direction | Either | Keyword | horizontal |
$wrap | If the cells within should wrap or not. | Boolean | true |
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 Name | parameter Description | parameter Type | parameter 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. | Keyword | margin |
$gutter-position | The position to apply gutters to. Accepts | List | right left |
$negative | Whether to apply the gutter as a negative value. Commonly used for nested grids. | Boolean | false |
Used by
- [mixin]
xy-cell
- [mixin]
xy-cell-static
- [mixin]
xy-grid-container
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 Name | parameter Description | parameter Type | parameter 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 | Boolean | true |
$gutters | Map or single value for gutters. | Number or Map | $grid-margin-gutters |
$gutter-type | Type of gutter to output. Accepts | Keyword | margin |
$gutter-position | The position to apply gutters to. Accepts | List | right left |
$breakpoint | The breakpoint to use for the cell generation. | String | null |
$vertical | Set to true to output vertical (height) styles rather than widths. | Boolean | false |
Requires
- [mixin]
xy-cell
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 Name | parameter Description | parameter Type | parameter Default value |
---|---|---|---|
$n | Size to offset by. You can pass in any value accepted by the | 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 | Keyword | margin |
$breakpoint | Single value, breakpoint name, or list of breakpoint names to use for | Number or Array or Keyword | $-zf-zero-breakpoint |
$vertical | Sets the direction of the offset. If set to true will apply margin-top instead. | Boolean | false |
Requires
- [function]
xy-cell-size
- [function]
xy-cell-size
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
- [function]
xy-cell-size
- [mixin]
xy-grid-collapse
- [mixin]
xy-grid-collapse
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