Code Monkey home page Code Monkey logo

sticky's Introduction

sticky

a sticky lib to simulate stickily positioned element.

Features

  • typescript features & vanilla js
  • use CSS sticky firstly
  • support ie9+
  • only support sticky top

Installing

Using npm:

$ npm install @autots/sticky -S

Using yarn:

$ yarn add @autots/sticky

Example

layouts

<section id="demo">
  <div class="child"></div>
</section>

Note: When the host browser doesn't support css position: sticky, the lib will fall back to use scroll event on window object, and set some css properties to his fisrtElementChild.

import as a module

import Sticky from '@autots/sticky';

// 1. The simplest way
new Sticky('#demo');

// 2. use config
new Sticky('#demo', {
  top: 10,
  zIndex: 100
})

import as a lib

<script src="dist/sticky.min.js"></script>

<script>
  var stickyDemo = new AutoTs.Sticky(el, config);
</script>

Config

Name Type Default Optional Description
mode 'sticky' or 'affix' 'sticky' true normal affix(fixed) mode or new sticky feature |
scrollRefer string | HTMLElement | Document | Window window true scroll container
offsetParent string null true offset parent el |
top number 0 true CSS top (px) property
style object {} true CSS property
holderStyle object {} true CSS property for the Target Placeholder Element
throttle boolean false true throttle feature when use scroll event(assigned when encounter special cases)

scrollRefer & offsetParent must have a non-static position.

Todo

  • support config direction

sticky's People

Contributors

magnnus 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.