Skip to content

Latest commit

 

History

History
95 lines (66 loc) · 3.9 KB

README.md

File metadata and controls

95 lines (66 loc) · 3.9 KB
Raw

hide-it

hide-it is a simple, fast and pure JavaScript / CSS 3 Splashscreen for modern Webbrowsers.

Features

  • multi language support
  • ultra fast
  • no dependencies
  • adaptable
  • easy to theme

How to use it

don't link the files! include the content of the files as <script>and <style> to achieve the best user experience

  • Add the content off dist/hide-it.min.js at the end of your ìndex.html file inside a <script>-Tag.

  • call Splashscreen init under this <script>-Tag and provide splashscreen translations if needed

    hide.config.language.en = {
  'title' : 'Herzlich Willkommen!',
  'content' : 'Willkommen zur Hide-ot Testseite<br/> Bedingungen zur Nutzung',
  'accept' : 'Akzeptieren'
};

hide.init();

  • Include the following HTML-snippet somewhere in your index.html.

    <div id="hide-it">
  <a href="#" class="hide-close">&#10060;</a>

  <div class="hide-wrapper">

    <div id="hide-loading-indicator"></div>

    <h1 class="hide-title">The Title</h1>

    <div class="hide-container">
      <div class="hide-content">
        <p>Lorem ipsum dolor sit amet, consectetur adipisicing elit. Odio aut qui corporis ipsa autem soluta id quibusdam porro. Rerum quisquam dignissimos sed itaque iure molestiae illum autem reprehenderit. Nobis, natus!</p>
      </div>
      
      <button class="hide-accept">Accept</button>
    </div>
  </div>
</div>

  • If you want to use the predefinied style include the dist/css/master.css after you compiled the Sass with your colors. Include the resulting css in your index.html inside a <style>-Tag. Feel free to omit the dist/css/master.cssand write your own. Only the following css is really needed: ```css #hide-it { position: fixed; top: 0; bottom: 0; left: 0; right: 0;

     z-index: 999;

    }

  • Trigger hide.loaded()if your application finished loading.

For a working example have a look at example.html (in progress).

History

This micro framework was written during a SAP UI 5 assignment during a VPN breakdown.

Development

  • run npm install
  • run gulp server to run webserver at localhost:8080 to test cookie functionality
  • run gulp deploy to regenerate all sass und js minfied files
  • run gulp watch to automatically regenerate and lint all sources
  • open http://localhost:8080/test/index.html``` to test and preview your changes

Acknowledgment

License

The MIT License (MIT) Copyright (c) 2016 Lukas Havemann

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.