{{ title }}
+ +{{ description }}
+ ++ +{{!-- Start container for docs and table of contents --}} +
+ +
The default styles of this component can be customized using these Sass variables in your project's settings file.
+ +| Name | Type | Default Value | Description |
|---|---|---|---|
${{this.context.name}} |
+ {{sassTypes this.type}} | +{{sassValue this.context.value}} |
+ {{md this.description}} | +
{{/if}} + +
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}} +Added in {{this.since.0.version}}
+ {{/if}} + + {{#if this.deprecated}} +Deprecated in {{this.deprecated}}
+ {{/if}} + +{{writeMixin this}}| Parameter | Type | Default Value | Description |
|---|---|---|---|
${{this.name}} |
+ {{sassTypes this.type}} | +{{sassValue this.default}} |
+ {{md this.description}} | +
{{/unless}} + + {{#if sass.function}} +
+ {{/if}} + + {{/each}} +
+ +
Added in {{this.since.0.version}}
+ {{/if}} + + {{#if this.deprecated}} +Deprecated in {{this.deprecated.version}}
+ {{/if}} + +{{writeFunction this}}| Parameter | Type | Default Value | Description |
|---|---|---|---|
${{this.name}} |
+ {{sassTypes this.type}} | +{{sassValue this.default}} |
+ {{md this.description}} | +
{{/unless}} + {{/each}} +
+ +
var elem = new Foundation.{{this.name}}(element, options);Fires these events: + {{#each this.fires}} + {{this}} + {{/each}} +
+ {{/if}} + + {{#if this.params}} +| Name | Type | Description |
|---|---|---|
{{this.name}} |
+ {{this.type.names.[0]}} | +{{this.description}} | +
+ + {{#if js.member}} +
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.
| Name | Description | Example |
|---|---|---|
| {{this.name}} | +{{this.description}} | +Sample! |
+
+ + {{#if js.event}} +
These events will fire from any element with a {{title}} plugin attached.
+ +| Name | Description |
|---|---|
| {{this.name}}.zf.{{../title}} | +{{this.description}} | +
+ + {{#if js.function}} +
Fires these events: + {{#each this.fires}} + {{this}} + {{/each}} +
+ {{/if}} + + {{#if this.params}} +| Name | Type | Description |
|---|---|---|
{{this.name}} |
+ {{this.type.names.[0]}} | +{{this.description}} | +
{{/unless}} +
+ +
Building Blocks is a ZURB-curated resource with useful code snippets that use Foundation components. Here are a few for this component:
+ +