Giter Club home page Giter Club logo

fixedbar's Introduction

FixedBar.js

Basic usage

HTML

<!-- In <head> -->
<link rel="stylesheet" href="your-path/fixed-bar.css">

...

<!-- In <body> -->
<div
  id="bar"
  aria-live="polite"
  aria-atomic="true"
  hidden
>
  Content...
  <button id="bar-closer">Close</button>
</div>

...

<section data-fixed-bar-range>
  This section is a targeted range.
</section>

...

<script src="your-path/fixed-bar.min.js"></script>

JavaScript

const fixedBar = new FixedBar({
  bar: '#bar',
  range: '[data-fixed-bar-range]',
});

// Close button
const closer = document.querySelector('#bar-closer');
closer.addEventListener('click', () => {
  fixedBar.close();
})

Options

bar {string}

対象要素のセレクタ。要素が複数ある場合は、最初に見つかった要素が対象になる。

range {string}

表示させたい領域となる要素のセレクタ。

reverse {boolean}

trueを設定すると、rangeで指定した要素が出現したときは非表示に、それ以外のときは表示するように変更する。

Methods

close(time)

強制的に非表示状態にする。

time {number} default = 0

指定したミリ秒後に、スクロールに応じた表示・非表示が再びアクティブとなる。

freeze(isExpanded)

表示・非表示を指定してその状態に固定する。

isExpanded {boolean} default = true

trueなら表示、falseなら非表示となる。

restart()

freeze()で固定した状態を解除する。

fixedbar's People

Contributors

ryosugimoto avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.