Jump to Nav

{{ title }}

{{#if js}} JavaScript {{/if}} {{#if mui}} Motion UI {{/if}} {{#if library}} Library {{/if}}

{{ description }}


{{!-- Start container for docs and table of contents --}}
{{!-- Start container for docs --}}
{{ docs }} {{#if sass}}
{{#heading 2}}Sass Reference{{/heading}} {{#if sass.variable}}
{{#heading 3 'sass-variables'}}Variables{{/heading}}

The default styles of this component can be customized using these Sass variables in your project's settings file.

{{#each sass.variable}} {{/each}}
NameTypeDefault ValueDescription
${{this.context.name}} {{sassTypes this.type}} {{sassValue this.context.value}} {{md this.description}}
{{/if}} {{#if sass.mixin}} {{#if sass.variable}}
{{/if}}
{{#heading 3 'sass-mixins'}}Mixins{{/heading}}

We use these mixins to build the final CSS output of this component. You can use the mixins yourself to build your own class structure out of our components.

{{#each sass.mixin}}{{#filter this}}
{{#heading 4}}{{this.context.name}}{{/heading}} {{#if this.since}}

Added in {{this.since.0.version}}

{{/if}} {{#if this.deprecated}}

Deprecated in {{this.deprecated}}

{{/if}}
{{writeMixin this}}
{{md this.description}} {{#if this.aliased}}

Aliases: {{#each this.aliased}}{{this}}(){{/each}}

{{/if}} {{externalLink this.link}} {{#if this.parameter}} {{#each this.parameter}} {{/each}}
ParameterTypeDefault ValueDescription
${{this.name}} {{sassTypes this.type}} {{sassValue this.default}} {{md this.description}}
{{/if}}
{{#unless @last}}
{{/unless}} {{#if sass.function}}
{{/if}} {{/filter}}{{/each}}
{{/if}} {{#if sass.function}}
{{#heading 3 'sass-functions'}}Functions{{/heading}} {{#each sass.function}}{{#filter this}}
{{#heading 4}}{{this.context.name}}{{/heading}} {{#if this.since}}

Added in {{this.since.0.version}}

{{/if}} {{#if this.deprecated}}

Deprecated in {{this.deprecated.version}}

{{/if}}
{{writeFunction this}}
{{md this.description}} {{externalLink this.link}} {{#if this.parameter}} {{#each this.parameter}} {{/each}}
ParameterTypeDefault ValueDescription
${{this.name}} {{sassTypes this.type}} {{sassValue this.default}} {{md this.description}}
{{/if}}
{{#unless @last}}
{{/unless}} {{/filter}}{{/each}}
{{/if}}
{{/if}} {{#if js}}
{{#heading 2}}JavaScript Reference{{/heading}} {{#if js.module}}{{#with js.module.[0]}}
{{#heading 3 'js-module'}}Initializing{{/heading}}

The file {{meta.filename}} must be included in your JavaScript to use this plugin, along with foundation.core.js.{{#if requires}} This plugin also requires these utility libraries:{{/if}}

{{#if requires}}{{#each requires}}
  • {{jsModuleName this}}
{{/each}}{{/if}}
{{/with}}{{/if}} {{#each js.class}}
{{#heading 3 'js-class'}}Foundation.{{this.name}}{{/heading}} {{md this.description}}
var elem = new Foundation.{{this.name}}(element);
{{#if this.fires}}

Fires these events: {{#each this.fires}} {{this}} {{/each}}

{{/if}} {{#if this.params}} {{#each this.params}} {{/each}}
NameTypeDescription
{{this.name}} {{this.type.names.[0]}} {{this.description}}
{{/if}}
{{/each}}
{{#if js.member}}
{{#heading 3 'js-options'}}Plugin Options{{/heading}}

Use these options to customize an instance of {{title}}. Plugin options can be set as individual data attributes, one combined data-options attribute, or as an object passed to the plugin's constructor. Learn more about how JavaScript plugins are initialized.

{{#each js.member}} {{/each}}
NameDescriptionExample
{{this.name}} {{this.description}} {{this.examples}}
{{/if}}
{{#if js.event}}
{{#heading 3 'js-events'}}Events{{/heading}}

These events will fire from any element with a {{title}} plugin attached.

{{#each js.event}} {{/each}}
NameDescription
{{this.name}}.zf.{{toLower ../title}} {{this.description}}
{{/if}}
{{#if js.function}}
{{#heading 3 'js-functions'}}Functions{{/heading}} {{#each js.function}}
{{#heading 4 this.name}}{{../../js.class.0.name}}.{{this.name}}{{/heading}} {{md this.description}} {{#if this.fires}}

Fires these events: {{#each this.fires}} {{this}} {{/each}}

{{/if}} {{#if this.params}} {{#each this.params}} {{/each}}
NameTypeDescription
{{this.name}} {{this.type.names.[0]}} {{this.description}}
{{/if}} {{#unless @last}}
{{/unless}}
{{/each}}
{{/if}}
{{/if}} {{#if sass}} {{/if}}
{{!-- End container for docs --}} {{!-- Start container for table of contents --}}
{{!-- End container for table of contents --}}
{{!-- End container for docs and table of contents --}}