Wondering what’s next for npm?Check out our public roadmap! »

    coffeekraken-s-dropdown-component

    1.0.2 • Public • Published

    Coffeekraken s-dropdown-component

    Full stack dropdown styling component with dropup, right aligned and colors support. Fully customizable as well.

    Table of content

    1. Demo
    2. Features
    3. Install
    4. Get Started
    5. SASS API
    6. Browsers support
    7. Contribute
    8. Who are Coffeekraken?
    9. Licence

    Features

    1. Fully customizable dropdown menu
    2. Colors support
    3. Dropup support
    4. Right aligned dropdown support

    Install

    npm install coffeekraken-s-dropdown-component --save
    

    Get Started

    First, import the component into your scss file like so:

    @import 'node_modules/coffeekraken-s-dropdown-component/index';

    Then, generate the classes using the provided mixins like so:

    @include s-dropdown-classes( 
        $colors: default primary secondary
    );

    Then simply use it inside your html like so:

    <div class="dropdown">
        <a class="btn">Display dropdown</a>
        <ul class="dropdown__menu">
            <li class="dropdown__item">
                <a href="#" title="...">
                    Item 1
                </a>
            </li>
            <li class="dropdown__item">
                <a href="#" title="...">
                    Item 2
                </a>
            </li>
            <li class="dropdown__item">
                <a href="#" title="...">
                    Item 3
                </a>
            </li>
        </ul>
    </div>

    Browsers support

    IE / Edge
    IE / Edge
    Firefox
    Firefox
    Chrome
    Chrome
    Safari
    Safari
    IE11+ last 2 versions last 2 versions last 2 versions

    As browsers are automatically updated, we will keep as reference the last two versions of each but this component can work on older ones as well.

    The webcomponent API (custom elements, shadowDOM, etc...) is not supported in some older browsers like IE10, etc... In order to make them work, you will need to integrate the corresponding polyfill.

    Contribute

    This is an open source project and will ever be! You are more that welcomed to contribute to his development and make it more awesome every day. To do so, you have several possibilities:

    1. Share the love ❤️
    2. Declare issues
    3. Fix issues
    4. Add features
    5. Build web component

    Who are Coffeekraken

    We try to be some cool guys that build some cool tools to make our (and yours hopefully) every day life better.

    More on who we are

    License

    The code is available under the MIT license. This mean that you can use, modify, or do whatever you want with it. This mean also that it is shipped to you for free, so don't be a hater and if you find some issues, etc... feel free to contribute instead of sharing your frustrations on social networks like an asshole...

    Install

    npm i coffeekraken-s-dropdown-component

    DownloadsWeekly Downloads

    0

    Version

    1.0.2

    License

    MIT

    Unpacked Size

    311 kB

    Total Files

    22

    Last publish

    Collaborators

    • avatar