@moncareyws/foundation-select

1.0.1 • Public • Published

foundation-select

Select plugin for Foundation sites 6

Installation

npm install --save @moncareyws/foundation-select

Add all nessesary files to your html. This plugin only works with foundation and requires foundation-perfect-scrollbar and font-awesome.

<link rel="stylesheet" type="text/css" href="node_modules/foundation-sites/dist/css/foundation.min.css"> 
<link rel="stylesheet" type="text/css" href="node_modules/@moncareyws/foundation-perfect-scrollbar/dist/css/foundation-perfect-scrollbar.min.css">
<link rel="stylesheet" type="text/css" href="node_modules/@moncareyws/foundation-select/dist/css/foundation-select.min.css">
<link rel="stylesheet" type="text/css" href="node_modules/@fortawesome/fontawesome-free/css/all.min.css">
...
<script src="node_modules/jquery/dist/jquery.js"></script>
<script src="node_modules/what-input/dist/what-input.js"></script>
<script src="node_modules/foundation-sites/dist/js/foundation.min.js"></script>
<script src="node_modules/perfect-scrollbar/dist/perfect-scrollbar.min.js"></script>
<script src="node_modules/@moncareyws/foundation-perfect-scrollbar/dist/js/foundation.perfectScrollbar.min.js"></script>
<script src="node_modules/@moncareyws/foundation-select/dist/js/foundation.select.min.js"></script>

If you are using foundation's scss with gulp, the best way add the styles is by adding it to the sass paths in your gulpfile.

var gulp = require('gulp');
var $    = require('gulp-load-plugins')();

var sassPaths = [
    'node_modules/foundation-sites/scss',
    'node_modules/motion-ui/src',
    'node_modules/@moncareyws/foundation-perfect-scrollbar/src/scss/plugin',
    'node_modules/@moncareyws/foundation-select/src/scss/plugin',
    'node_modules/@fortawesome/fontawesome-free/scss'
];

gulp.task('sass', function() {
    ...

Then add these settings to your _settings.scss file for customization

$select-background: $input-background !default;
$select-border: $input-border !default;
$select-color: $input-color !default;
$select-dropdown-height: rem-calc(300);

Usage

Just add a data-select attribute to your select tag.

<select data-select>
    <option value="">Placeholder<option>
    <option value="0">Option 1<option>
    <option value="1">Option 2<option>
    ...
</select>

Run foundation and it will automaticaly initialize all the selects

$(document).foundation();

Plugin options

Name Default Descrition
data-icon-class 'fa-caret-down' The FontAwesome class for the select triangle icon.
data-placeholder '' Custom placeholder.
data-value '' The default value of the select.
data-mousewheel true If set to true scrolling over the element will change the value if the element has focus.

Licence

MIT Licence

Dependencies (5)

Dev Dependencies (10)

Package Sidebar

Install

npm i @moncareyws/foundation-select

Weekly Downloads

3

Version

1.0.1

License

MIT

Unpacked Size

105 kB

Total Files

10

Last publish

Collaborators

  • moncareyws