Skip to content

Commit 6d91f7d

Browse files
committed
README md small fixes
1 parent af65a50 commit 6d91f7d

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ A small "CSS helper" script (~4K gzipped) which relies on **CSS variables** in o
66

77
🙅 Without this library:
88

9-
![without scrollbar gap compensation](https://github.com/[username]/[reponame]/blob/[branch]/docs/without-gap-compensation.gif?raw=true)
9+
![without scrollbar gap compensation](https://github.com/memob0x/scroll-padlock/blob/master/docs/without-gap-compensation.gif?raw=true)
1010

1111
💁 With this library:
1212

13-
![with scrollbar gap compensation](https://github.com/[username]/[reponame]/blob/[branch]/docs/with-gap-compensation.gif?raw=true)
13+
![with scrollbar gap compensation](https://github.com/memob0x/scroll-padlock/blob/master/docs/with-gap-compensation.gif?raw=true)
1414

1515
## TL;TR: a body scroll overview
1616

@@ -181,7 +181,7 @@ html.scroll-padlock--locked aside {
181181

182182
There are some edge cases in which iOS doesn't play nice: when the page is scrolled the **system bars** become smaller, at that point when the keyboard tray is triggered they become larger again; that can cause visual artifacts as you can see the following gif.
183183

184-
![ios bug](https://github.com/[username]/[reponame]/blob/[branch]/docs/ios-bug.gif?raw=true)
184+
![ios bug](https://github.com/memob0x/scroll-padlock/blob/master/docs/ios-bug.gif?raw=true)
185185

186186
That's because the element on focus is an input element and iOS forces a scroll to that element (to enhance the accessibility) on an area which would be shortly resized because of the system bars getting bigger. Pretty weird, huh?
187187

@@ -197,15 +197,15 @@ document.documentElement.addEventListener("scrollpadlockresize", () => {
197197

198198
As you can see in the following gif, things are finally back in place.
199199

200-
![ios bug](https://github.com/[username]/[reponame]/blob/[branch]/docs/ios-fix.gif?raw=true)
200+
![ios bug](https://github.com/memob0x/scroll-padlock/blob/master/docs/ios-fix.gif?raw=true)
201201

202202
## Support
203203

204204
All [modern browsers](https://teamtreehouse.com/community/what-is-a-modern-browser) have been tested, but here's a list of dependencies that might be needed in order to support older ones:
205205
* 💥 DOM API "[matches](https://developer.mozilla.org/en-US/docs/Web/API/Element/matches#Polyfill)" method ([polyfill](https://developer.mozilla.org/en-US/docs/Web/API/Element/matches#Polyfill))
206206
* 💥 [WeakMap](https://caniuse.com/mdn-javascript_builtins_weakmap)
207207
* [CustomEvent](https://caniuse.com/customevent) ([polyfill](https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent/CustomEvent#Polyfill)), only if library [events](#events) are being used
208-
* [CSS variables](https://caniuse.com/css-variables), only for scrollbar gaps compensation (since old browsers support _overflow: hidden;_), still the JS API and events can be used to reach a workaround
208+
* [CSS variables](https://caniuse.com/css-variables), only for scrollbar gaps compensation (since old browsers support _overflow: hidden_), still the JS API and events can be used to reach a workaround
209209

210210
## Demo
211211

package-lock.json

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"description": "Locks elements scroll handling scrollbar gaps and iOS Safari with CSS variables",
55
"main": "dist/umd/scroll-padlock.min.js",
66
"module": "dist/es/scroll-padlock.js",
7-
"version": "1.1.1",
7+
"version": "1.1.2",
88
"license": "MIT",
99
"repository": "https://github.com/memob0x/scroll-padlock.git",
1010
"scripts": {

0 commit comments

Comments
 (0)