General

functions

[private] gutter-width

@function gutter-width($gutters, $gutter-ratio) { ... }

Description

Return the gutter width for the current settings

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$gutters`	Number of gutters in grid, equivalent to number of columns generally	`Integer`	—none
`$gutter-ratio`	Floating number representing the width of a gutter compared to the width of a column	`Float`	—none

Returns

Percentage —

Width equivalent with gutters requested

Used by

[function] gutters
[function] span-math
[function] span
[mixin] span

gutters

@function gutters($gutters: 1) { ... }

Description

Use when a width equivalent to a gutter or multiple gutters is needed

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$gutters`	Number of gutter widths to return	`Integer`	`1`

Returns

Percentage —

Width equivalent to number of gutters requested

Requires

[function] layout
[function] gutter-width

layout

@function layout($map: $condo) { ... }

Description

Sets up the current layout, ensuring all $condo keys are mapped and have values

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$map`	Map to be merged into $condo-defaults	`Map`	`$condo`

Returns

Map —

Result of merging the supplied $map with $condo-defaults

Requires

[variable] condo-defaults

Used by

[function] gutters
[function] raw-column-width
[function] span-math
[function] span
[mixin] container
[mixin] last
[mixin] push
[mixin] span
[mixin] unlast
[mixin] unpush
[mixin] with-layout

[private] raw-column-width

@function raw-column-width($columns, $gutter-width) { ... }

Description

Return a column width measured as if there were no gutters

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$columns`	Number of columns in grid	`Integer`	—none
`$gutter-width`	Width of one gutter	`Percentage`	—none

Returns

Percentage —

Width equivalent with columns requested

Requires

[function] layout

Used by

[function] span-math
[function] span

[private] span-math

@function span-math($spans) { ... }

Description

Return the width and margins given the current settings

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$spans`	Number of column widths to return	`Integer`	—none

Returns

Map —

Map with width and margin values

Requires

[function] layout
[function] gutter-width
[function] raw-column-width

Used by

[mixin] push
[mixin] span
[mixin] unlast
[mixin] unpush

span

@function span($spans: 1, $keyword: null) { ... }

Description

Use when a width equivalent to the spans and keywords provided is needed

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$spans`	Number of column widths to return	`Integer`	`1`
`$keyword`	Options: wide, wider; Increases width by 1 or 2 gutter-widths respectively	`String`	`null`

Returns

Percentage —

Width equivalent to number of columns requested

Requires

[function] layout
[function] gutter-width
[function] raw-column-width

mixins

container

@mixin container($max-width, $position: null) { ... }

Description

Set the max-width and margins for a container

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$max-width`	Any valid width value	`Number`	—none
`$position`	Options: left, center, right; will set margins accordingly.	`String`	`null`

Output

Sets a max-width, margin-left and margin-right to auto if container position is center, and clearfixes the container so you don't have to

Requires

[function] layout

last

@mixin last() { ... }

Description

Use to set float to right and remove right margin.

Parameters

None.

Output

Sets opposite float and removes margin right

Requires

[function] layout

push

@mixin push($columns) { ... }

Description

Increase margin-left in order to "push" block over a supplied number of spans.

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$columns`	Number of columns to push block over	`Integer`	—none

Output

Sets margin-left so such a size as to "push" it the width of the columns specified

Requires

[function] layout
[function] span-math

span

@mixin span($spans, $keyword: null) { ... }

Description

Set the float, width and margins for a block

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$spans`	Number of columns width should span	`Integer`	—none
`$keyword`	Options are: wide, wider; Will add the width of one or two gutters respectively.	`String`	`null`

Output

Sets float, width, and appropriate margins

Requires

[function] layout
[function] span-math
[function] gutter-width

unlast

@mixin unlast() { ... }

Description

Use to reset settings after using the last mixin.

Parameters

None.

Output

Resets both float and margin-right to non-last position values

Requires

[function] layout
[function] span-math

unpush

@mixin unpush() { ... }

Description

Use to reset settings after using the push mixin

Parameters

None.

Output

Resets margin-left on item

Requires

[function] layout
[function] span-math

with-layout

@mixin with-layout($map) { ... }

Description

Temporarily use a different settings map

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$map`	A map consisting of some or all $condo settings.	`Map`	—none

Content

This mixin allows extra content to be passed (through the @content directive). Role: [Merges the $map with the $condo settings and uses this new map to do all Condo math within this content block. Restores the $condo settings after the block.]

Requires

[function] layout

variables

condo-defaults

$condo-defaults: (
  container: auto,
  container-position: center,
  columns: 4,
  gutters: .25,
  gutter-position: after
);

Description

Default $condo settings

Map structure

keyName	keyDescription	keyType	keyValue
`$condo-defaults`	—none	`Map`	—none
`$condo-defaults.container`	Can be any valid width value	`String`	`auto`
`$condo-defaults.container-position`	Options: left, center, right; Determines the position of the container.	`String`	`center`
`$condo-defaults.columns`	Number of columns to used for grid settings	`Number`	`4`
`$condo-defaults.gutters`	Percentage of a column that the width of a gutter will be	`Float`	`.25`
`$condo-defaults.gutter-position`	Options: after, split; Determines width and position of gutters.	`String`	`after`

Used by

[function] layout