Notoriously Pedantic Magistrate
    Have ideas to improve npm?Join in the discussion! »

    solstice

    0.0.11 • Public • Published

    Solstice

    Build Status

    Solstice is a vanilla Javascript date picker that requires minimal set up.

    work in progress:

    • the example in build/index.html is currently supported
    • fix in progress for requiring via es5 require and es6 import

    Installation

    npm install solstice

    npm scripts

    • npm run build - Creates es5 bundle via webpack and Babel6.
    • npm run watch - Watch files continuously, rebuild incrementally.
    • npm run test - Runs es6 tests in Karma, live watch mode for devs.
    • npm start - Hot reloading via the webpack dev server.
    • npm run clean - Clean out coverage directory

    Usage

    If you're not using Node for your project you'll need to make sure that you've built out the dist directory. Then you should be able to access solstice by including a script tag.

    <script type="text/javascript" src="{path_to_directory}/solstice.js"></script>
    

    Solstice attaches itself to the window object when included in the script tag. Now you should be able to access it's functionality by just specifying a container element to Solstice's constructor. At this point you may want to also add css around either the built in classes for Solstice or you can specify your own classes in the options object.

    var containerEl = document.getElementById('container-el');
    // Could be window.Solstice
    var solsticeObject = new Solstice(containerEl);
    

    If you're using node you can just include it in your project.

    var Solstice = require('solstice');
    

    Full example (found in build/index.html):

    <!DOCTYPE html>
    <html>
    <head>
        <meta charset="utf-8">
        <title>solstice demo</title>
        <link rel="stylesheet" href="solstice.min.css" />
    </head>
    <body>
     
      <div>
        <div id="container-el"></div>
        <button id="okay">Ok</button>
        <div>Date Selected: <span id="aSpanOfDate"></span></div>
      </div>
     
      <script src="solstice-bundle.js"></script> 
      <script type="text/javascript">
        if (Solstice) {
          var containerEl = document.getElementById('container-el'),
            okayBtn = document.getElementById('okay'),
            theSpan = document.getElementById('aSpanOfDate'),
            sols = new Solstice(containerEl);
          okayBtn.onclick = function(){
            theSpan.innerText = sols.getDate();
          };
        }
      </script> 
    </body>
    </html>

    Options

    • date: The default date that is shown in the calendar. This is optional and will default to today's date and time.
    • showYearCtrls: This boolean is to show whether or not the the year controls. Optional and defaults to false.
    • timeSeparator: This is the separation between Hours/Minutes/Seconds and is by default a colon ":".
      var exampleSolstice = Solstice('containerEl', { date: 'January 1, 2015 12:00:00 AM PST', showYearCtrls: true, timeSeparator: '.'});
    

    Install

    npm i solstice

    DownloadsWeekly Downloads

    11

    Version

    0.0.11

    License

    MIT

    Last publish

    Collaborators

    • avatar