forked from oddbird/susy
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathx-version.html
4 lines (4 loc) · 11.1 KB
/
x-version.html
1
2
3
4
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>susy Documentation</title><link href="assets/img/favicon.ico" rel="shortcut icon"><link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:400,700|Source+Sans+Pro:400,400i,700,700i" rel="stylesheet"><link rel="stylesheet" href="assets/css/main.css"></head><body><svg xmlns="http://www.w3.org/2000/svg" hidden><symbol id="icon-menu" viewBox="0 0 24 28"><title>menu icon</title><path d="M24 21v2c0 .547-.453 1-1 1H1c-.547 0-1-.453-1-1v-2c0-.547.453-1 1-1h22c.547 0 1 .453 1 1zm0-8v2c0 .547-.453 1-1 1H1c-.547 0-1-.453-1-1v-2c0-.547.453-1 1-1h22c.547 0 1 .453 1 1zm0-8v2c0 .547-.453 1-1 1H1c-.547 0-1-.453-1-1V5c0-.547.453-1 1-1h22c.547 0 1 .453 1 1z"/></symbol><symbol id="icon-search" viewBox="0 0 24 28"><title>search icon</title><path d="M24 21v2c0 .547-.453 1-1 1H1c-.547 0-1-.453-1-1v-2c0-.547.453-1 1-1h22c.547 0 1 .453 1 1zm0-8v2c0 .547-.453 1-1 1H1c-.547 0-1-.453-1-1v-2c0-.547.453-1 1-1h22c.547 0 1 .453 1 1zm0-8v2c0 .547-.453 1-1 1H1c-.547 0-1-.453-1-1V5c0-.547.453-1 1-1h22c.547 0 1 .453 1 1z"/></symbol></svg><div data-sassdoc-region="app"><header role="banner" data-sassdoc-region="banner"><button data-nav-toggle="small" data-toggle="button" aria-controls="nav-small" aria-pressed="false" data-toggle-synced="false"><svg data-icon="menu" data-icon-size="icon-small"><title>menu</title><use xlink:href="#icon-menu"/></svg></button> <button data-nav-toggle="large" data-toggle="button" aria-controls="nav-large" aria-pressed="true" data-toggle-synced="false"><svg data-icon="menu" data-icon-size="icon-small"><title>menu</title><use xlink:href="#icon-menu"/></svg></button><h1 data-sassdoc="project-title"><a href="index.html" rel="home" data-sassdoc="project-name">susy</a> <span data-sassdoc="project-version">3.0.1</span></h1></header><div data-sassdoc-region="container"><nav role="navigation" data-nav-menu="small" data-toggle="target" id="nav-small" data-target-id="nav-small" aria-expanded="false" data-auto-closing="false" data-auto-closing-on-any-click="false"><h3 data-sassdoc="nav-title"><a href="index.html" data-sassdoc-nav="is-not-active">susy</a></h3><ul><li data-sassdoc="nav-item"><a href="a-config.html" data-sassdoc-nav="is-not-active">Configuration</a></li><li data-sassdoc="nav-item"><a href="b-api.html" data-sassdoc-nav="is-not-active">Grid Functions</a></li><li data-sassdoc="nav-item"><a href="plugin-utils.html" data-sassdoc-nav="is-not-active">Plugin Utilities</a></li><li data-sassdoc="nav-item"><a href="plugin_svg-grid.html" data-sassdoc-nav="is-not-active">Plugin: SVG Grid Image</a></li><li data-sassdoc="nav-item"><a href="su-math.html" data-sassdoc-nav="is-not-active">Su: Core Math Engine</a></li><li data-sassdoc="nav-item"><a href="x-normal.html" data-sassdoc-nav="is-not-active">[Susy Normalization]</a></li><li data-sassdoc="nav-item"><a href="x-parser.html" data-sassdoc-nav="is-not-active">[Susy Syntax Parser]</a></li><li data-sassdoc="nav-item"><a href="x-validation.html" data-sassdoc-nav="is-not-active">[Su Input Validation]</a></li><li data-sassdoc="nav-item"><a href="x-version.html" data-sassdoc-nav="is-active">[Release Notes]</a></li></ul></nav><nav role="navigation" data-nav-menu="large" data-toggle="target" id="nav-large" data-target-id="nav-large" aria-expanded="true" data-auto-closing="false" data-auto-closing-on-any-click="false"><h3 data-sassdoc="nav-title"><a href="index.html" data-sassdoc-nav="is-not-active">susy</a></h3><ul><li data-sassdoc="nav-item"><a href="a-config.html" data-sassdoc-nav="is-not-active">Configuration</a></li><li data-sassdoc="nav-item"><a href="b-api.html" data-sassdoc-nav="is-not-active">Grid Functions</a></li><li data-sassdoc="nav-item"><a href="plugin-utils.html" data-sassdoc-nav="is-not-active">Plugin Utilities</a></li><li data-sassdoc="nav-item"><a href="plugin_svg-grid.html" data-sassdoc-nav="is-not-active">Plugin: SVG Grid Image</a></li><li data-sassdoc="nav-item"><a href="su-math.html" data-sassdoc-nav="is-not-active">Su: Core Math Engine</a></li><li data-sassdoc="nav-item"><a href="x-normal.html" data-sassdoc-nav="is-not-active">[Susy Normalization]</a></li><li data-sassdoc="nav-item"><a href="x-parser.html" data-sassdoc-nav="is-not-active">[Susy Syntax Parser]</a></li><li data-sassdoc="nav-item"><a href="x-validation.html" data-sassdoc-nav="is-not-active">[Su Input Validation]</a></li><li data-sassdoc="nav-item"><a href="x-version.html" data-sassdoc-nav="is-active">[Release Notes]</a></li></ul></nav><main role="main"><nav data-sassdoc-region="breadcrumb"><a href="index.html">susy</a> » <strong>[Release Notes]</strong></nav><div data-sassdoc-region="main" data-sassdoc-page="x-version"><section class="item" id="function--susy-version"><header data-item-section="header"><h2 class="item-title"><span class="item-type">@function</span> <a href="#function--susy-version" class="item-name">susy-version()</a></h2></header><div data-item-section="summary"><h3 class="item-subtitle">Description</h3><div class="text-block"><p>Returns the current version of Susy as a string in the common <code>major.minor.patch</code> format – or returns one part (major | minor | patch) as a number for version comparisons. Since version numbers aren't actual decimals, there is no simple way to return the full version as a comparable number in Sass.</p></div></div><div data-item-section="parameter"><h3 class="item-subtitle">Parameters</h3><div class="param-list"><h4 class="param-title"><span class="item-name">$part:</span> <span class="item-value">null</span> <span class="value-type">('major' | 'minor' | 'patch')</span></h4><div class="param-details text-block"><p>The part (major | minor | patch) to return as a number. Any other value will return the full version as a string.</p></div></div></div><div data-item-section="examples"><h3 class="item-subtitle">Example</h3><div class="example"><div class="example-code"><div class="code-block"><div class="code-header"><span class="code-language">scss </span><span class="code-description">Current Susy Version</span></div><pre data-sassdoc="hljs"><code class="lang-scss">/* Full Version: #{susy-version()} */
/* Major Release: #{susy-version('major')} */</code></pre></div><div class="code-block"><div class="code-header"><span class="code-language">css </span><span class="code-description">compiled</span></div><pre data-sassdoc="hljs"><code class="lang-css">/* Full Version: 3.0.1 */
/* Major Release: 3 */
</code></pre></div></div></div></div><div data-item-section="requires"><h3 class="item-subtitle">requires</h3><div class="param-list"><h4 class="param-title"><span class="item-name">$_susy-version</span> <span class="item-note">[private]</span></h4></div></div></section><section class="item"><div data-item-section="prose" class="text-block"><h1 id="release-notes-for-susy-v3-0-0-and-3-0-1-">Release Notes for Susy v3.0.0 (and 3.0.1)</h1><ul><li>BREAKING: No More Mixins! <code>span</code>, <code>container</code>, <code>gutters</code>, <code>last</code>, <code>gallery</code>, etc. have all been removed from Susy. Web layout has become too powerful & flexible to contain in a simple set of shortcuts.</li><li>BREAKING: Remove rubygems/bower, to distribute on npm only.</li><li>BREAKING: Trim down to the core math, and a thin layer of api functions:<ul><li><code>susy-span()</code> (aliased as <code>span</code>) to return a column-spanning width.</li><li><code>susy-gutter()</code> (aliased as <code>gutter</code>) to return a gutter width.</li><li><code>susy-slice()</code> (aliased as <code>slice</code>) to return a slice of asymmetrical grid.</li></ul></li><li>BREAKING: Simplify to four settings:<ul><li><code>columns</code> to define the grid columns as a list of lengths or unitless relative numbers.</li><li><code>gutters</code> to define the length or relative size of a gutter.</li><li><code>spread</code> to define the default spread of a span across adjacent gutters.</li><li><code>container-spread</code> to define the default spread of a container across side-edge gutters.</li></ul></li><li>BREAKING: Add support for <code>calc()</code> output, so mixed-unit grids are possible. This means the old inside-static solution has been replaced by calc() output as well.</li><li>BREAKING: Shorthand syntax for on-the-fly span and settings. This is similar to the previous shorthand, but has been simplified to remove mixin-related features.<ul><li>starting with a count, length, or column-list "span"</li><li><code>at $n</code>, <code>first</code>, or <code>last</code> location on asymmetrical grids</li><li><code>narrow</code>, <code>wide</code>, or <code>wider</code> for spread</li><li><code>of $n <spread></code> for available grid columns and container-spread</li><li><code>set-gutters $n</code> shorthand to override global gutter settings</li></ul></li><li>NEW: <code>susy-repeat()</code> function to generate repeating gradients with the same syntax provided in CSS Grid templates</li><li>NEW: SVG Grid plugin (<code>susy/plugins/svg-grid</code>), to provide grid-debugging options when applied as a background image to any container element:<ul><li><code>svg-grid-colors</code> global setting accepts one or more colors</li><li><code>susy-svg-grid()</code> function returns inline svg for use in the <code>background</code> or generated <code>content</code> properties</li></ul></li><li>NEW: <code>susy-compile()</code> and <code>su-call()</code> plugin helpers, to aide with conversions between the user API and internal math functions. This is primarily useful for anyone building Susy extensions or mixins.</li><li>NEW: prefixed and unprefixed versions of all major API functions.</li><li>NEW: <code>susy-version()</code> function for accessing the active version number.</li></ul></div><div data-item-section="related"><h3 class="item-subtitle">related</h3><div class="param-list"><h4 class="param-title"><a href="http://oddbird.net/susy/" class="item-name">Official Site</a> <span class="item-note">[external]</span></h4></div><div class="param-list"><h4 class="param-title"><a href="http://oddbird.net/susy/docs/" class="item-name">Latest Docs</a> <span class="item-note">[external]</span></h4></div><div class="param-list"><h4 class="param-title"><a href="https://github.com/oddbird/susy/blob/master/CHANGELOG.md" class="item-name">Full Changelog</a> <span class="item-note">[external]</span></h4></div><div class="param-list"><h4 class="param-title"><a href="http://oddbird.net/2017/06/28/susy3" class="item-name">Introducing Susy3 [article]</a> <span class="item-note">[external]</span></h4></div><div class="param-list"><h4 class="param-title"><a href="http://oddbird.net/2017/06/13/susy-spread/" class="item-name">Understanding Spread in Susy3 [article]</a> <span class="item-note">[external]</span></h4></div></div></section></div></main></div></div><script type="text/javascript" src="assets/js/jquery-3.1.1.slim.js"></script><script type="text/javascript" src="assets/js/srcdoc-polyfill.min.js"></script><script type="text/javascript" src="assets/js/highlight.js"></script><script type="text/javascript" src="assets/js/base.js"></script><script type="text/javascript" src="assets/js/init.js"></script></body></html>