Skip to content

Commit e8746dd

Browse files
committed
chore: update README.md
1 parent e16973e commit e8746dd

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,15 @@
22

33
[![NPM version](https://img.shields.io/npm/v/float-sidebar.svg?style=flat)](https://www.npmjs.org/package/float-sidebar)
44

5-
> A lightweight (2kb gzipped), zero-dependency JavaScript library that makes sidebars float.
6-
7-
[Demo](https://js-2sy9en.stackblitz.io)
8-
9-
FloatSidebar.js is a lightweight JavaScript library that creates sticky, floating sidebars. It keeps the sidebar visible in the viewport by dynamically sticking it to the top or bottom based on scroll direction and sidebar height.
5+
FloatSidebar.js is a lightweight (2kb gzipped), zero-dependency JavaScript library that creates sticky, floating sidebars. It keeps the sidebar visible in the viewport by dynamically sticking it to the top or bottom based on scroll direction and sidebar height.
106

117
1. Tall Sidebars (taller than the viewport), scrolls with the content, sticking to the bottom when scrolling down and to the top when scrolling up. _(see the left sidebar in the video)_.
128
2. Short Sidebars (shorter than the viewport): Stays fixed at the top during scrolling. _(see the right sidebar in the video)_.
139

1410
https://user-images.githubusercontent.com/5039436/164990489-0424b5ab-c231-4f5c-bc1b-fc3f9594e347.mov
1511

12+
[Demo](https://js-2sy9en.stackblitz.io)
13+
1614
## Install
1715

1816
```bash

0 commit comments

Comments
 (0)