<% @side_nav = "buttons" %>
<% @page_title = "Split Buttons" %>

<%= @page_title %>

We've simplified our split buttons by getting rid of the dedicated dropdown associated with them. Instead, you'll use our new dropdown plugin to attach a dropdown to the button style of your choice.

Split Button
Split Button
Split Button
Split Button

Build With Predefined HTML Classes

There are two ways to build buttons in Foundation 4: with our predefined HTML classes or our structure and mixins. Building buttons using our predefined classes is simple, you'll need an <a>, <button> or <input> with a class of .button.split. This will create a default medium button. You can also use size, color and radius classes to control more of the style.

The classes options:

  • The size classes include: .tiny, .small, .medium or .large
  • The color classes include: .secondary, .alert or .success
  • The radius classes include: .radius or .round.
<%= code_example ' Default Button Tiny Button Small Button Large Button Secondary Button Success Button Alert Button Radius Button Round Button ', :html %>

You may chain one class from each group to build up desired default styles. For these styles to take effect, make sure you have the default Foundation CSS package or that you've selected split buttons from a custom package. These should be linked up following our default HTML page structure.


Build with Mixins

We've included SCSS mixins used to style buttons. To use these mixins, you'll need to have the extension installed or grab _variables.scss, _buttons.scss, _global.scss and _split-buttons.scss from Github and throw them into a Foundation folder in your project directory. From there, you can import the files at the top of your own SCSS stylesheet, like so:

<%= code_example ' @import "foundation/variables"; @import "foundation/components/global"; @import "foundation/components/buttons"; @import "foundation/components/split-buttons"; ', :css %>

If you are using the mixins, you may include the styles on whatever class or ID you'd like, just make sure you follow our markup structure:

<%= code_example ' Split Button Text ', :html %>
Quick Mixin

You can quickly build an entire split buttons using our global mixin by including it on your custom class or ID in your stylesheet. The global mixin will create the necessary style for the button. The global mixin looks like this:

<%= code_example ' /* Using the default styles */ .your-class-name { @include button; @include split-button; } ', :css %> Default Split Button

There are also four options you can customize on the fly when writing this mixin. These control things like: padding size, pip color, border color and base styles. Setting any of these options to false will not include the styles.

<%= code_example ' /* Using the available options */ .your-class-name { @include button; @include split-button($padding, $pip-color, $span-border, $base-style); } /* This controls padding around the dropdown buttons. Use tiny, small, medium, or large */ $padding: $button-med /* This controls the dropdown pip color. Set to one of our variables or a custom hex value */ $pip-color: $split-button-pip-color /* This controls the border color of the triangle span area. This can be a variable or color value. */ $span-border: $primary-color /* This controls whether or not base styles come through. Set to false to negate */ /* Handy when you want to have many different styles */ $base-style: true ', :css %>
Default SCSS Variables
<%= code_example ' $include-html-button-classes: $include-html-classes; /* We use these to control different shared styles for Split Buttons */ $split-button-function-factor: 15%; $split-button-pip-color: #fff; $split-button-pip-color-alt: #333; $split-button-active-bg-tint: rgba(0,0,0,0.1); /* We use these to control tiny split buttons */ $split-button-padding-tny: $button-tny * 9; $split-button-span-width-tny: $button-tny * 6.5; $split-button-pip-size-tny: $button-tny; $split-button-pip-top-tny: $button-tny * 2; $split-button-pip-default-float-tny: emCalc(-5); /* We use these to control small split buttons */ $split-button-padding-sml: $button-sml * 7; $split-button-span-width-sml: $button-sml * 5; $split-button-pip-size-sml: $button-sml; $split-button-pip-top-sml: $button-sml * 1.5; $split-button-pip-default-float-sml: emCalc(-9); /* We use these to control medium split buttons */ $split-button-padding-med: $button-med * 6.4; $split-button-span-width-med: $button-med * 4; $split-button-pip-size-med: $button-med - emCalc(3); $split-button-pip-top-med: $button-med * 1.5; $split-button-pip-default-float-med: emCalc(-9); /* We use these to control large split buttons */ $split-button-padding-lrg: $button-lrg * 6; $split-button-span-width-lrg: $button-lrg * 3.75; $split-button-pip-size-lrg: $button-lrg - emCalc(6); $split-button-pip-top-lrg: $button-lrg + emCalc(5); $split-button-pip-default-float-lrg: emCalc(-9); ', :css %>

Note: emCalc(); is a function we wrote to convert px to em. It is included in _variables.scss.


Using the JavaScript

You don't need this JS to create dropdown button styles with Foundation. The only reason you'll need to include foundation.dropdown.js is if you want to add one of our dropdowns to the button. You'll also need to make sure to include zepto.js and foundation.js above the dropdown plugin.

Above your closing </body> tag include the following line of code and make sure you have the JS file in your directory:

Read how to install Foundation JavaScript

Required Foundation Library: foundation.dropdown.js

Creating the Dropdown

To create a dropdown, you'll need to attach a data-attribute to whatever element you want the dropdown attached to (in this case a button). From there, you'll create a list that holds the links or content and add another data-attribute that associates with the element it belongs to. Here's an example of that markup:

<%= code_example ' Dropdown Button
', :html %> Dropdown Button

You'll notice that data-dropdown="drop1" and id="drop1" have similar values. This is what tells the dropdown plugin where to look to find the position to attach the dropdown element to.

Optional JavaScript Configuration

Dropdown button options can only be passed in during initialization at this time.

<%= code_example "{ // specify the class used for active sections activeClass: 'open' }", :js %>
<%= render "_sidebar-components.html.erb" %>