@operato/headroom 8.0.0-beta.0 → 8.0.0-beta.1

package/CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.0.0-beta.1](https://github.com/hatiolab/operato/compare/v8.0.0-beta.0...v8.0.0-beta.1) (2025-01-08)
+
+
+### :bug: Bug Fix
+
+* missing .npmignore ([be05985](https://github.com/hatiolab/operato/commit/be05985abfae4af53501f718dd52932099f7fbcb))
+
+
+
 ## [8.0.0-beta.0](https://github.com/hatiolab/operato/compare/v8.0.0-alpha.56...v8.0.0-beta.0) (2025-01-07)
 
 **Note:** Version bump only for package @operato/headroom

package/package.json

@@ -2,7 +2,7 @@
   "name": "@operato/headroom",
   "description": "Webcomponent headroom following open-wc recommendations",
   "author": "heartyoh",
-  "version": "8.0.0-beta.0",
+  "version": "8.0.0-beta.1",
   "main": "dist/src/index.js",
   "module": "dist/src/index.js",
   "license": "MIT",
@@ -62,5 +62,5 @@
       "prettier --write"
     ]
   },
-  "gitHead": "c4e9cc245659d050a9ffd66542083a6daad4bcb9"
+  "gitHead": "d5b28a2e9deb632c0dc80132f6a7196dd6fe4220"
 }

package/.editorconfig

@@ -1,29 +0,0 @@
-# EditorConfig helps developers define and maintain consistent
-# coding styles between different editors and IDEs
-# editorconfig.org
-
-root = true
-
-
-[*]
-
-# Change these settings to your own preference
-indent_style = space
-indent_size = 2
-
-# We recommend you to keep these unchanged
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.md]
-trim_trailing_whitespace = false
-
-[*.json]
-indent_size = 2
-
-[*.{html,js,md}]
-block_comment_start = /**
-block_comment = *
-block_comment_end = */

package/src/features.ts

@@ -1,22 +0,0 @@
-/**
- * Used to detect browser support for adding an event listener with options
- * Credit: https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener
- */
-export function passiveEventsSupported() {
-  var supported = false
-
-  try {
-    var options = {
-      get passive(): boolean {
-        supported = true
-        return true
-      }
-    }
-    window.addEventListener('test', options as any, options)
-    window.removeEventListener('test', options as any, options as any)
-  } catch (err) {
-    supported = false
-  }
-
-  return supported
-}

package/src/headroom.ts

@@ -1,251 +0,0 @@
-import trackScroll from './trackScroll'
-
-function normalizeUpDown(t: any) {
-  return t === Object(t) ? t : { down: t, up: t }
-}
-
-/**
- * UI enhancement for fixed headers.
- * Hides header when scrolling down
- * Shows header when scrolling up
- * @constructor
- * @param {DOMElement} elem the header element
- * @param {Object} options options for the widget
- */
-export default class Headroom {
-  /**
-   * Default options
-   * @type {Object}
-   */
-  static options = {
-    tolerance: {
-      up: 0,
-      down: 0
-    },
-    offset: 0,
-    scroller: window,
-    classes: {
-      frozen: 'headroom--frozen',
-      pinned: 'headroom--pinned',
-      unpinned: 'headroom--unpinned',
-      top: 'headroom--top',
-      notTop: 'headroom--not-top',
-      bottom: 'headroom--bottom',
-      notBottom: 'headroom--not-bottom',
-      initial: 'headroom'
-    }
-  }
-
-  private classes: { [key: string]: any }
-  private elem: HTMLElement
-  private tolerance: any
-  private offset: any
-  private initialised: boolean
-  private frozen: boolean
-  private scrollTracker: any
-  private scroller: any
-
-  private onPin?: Function
-  private onUnpin?: Function
-  private onTop?: Function
-  private onNotTop?: Function
-  private onBottom?: Function
-  private onNotBottom?: Function
-
-  constructor(elem: HTMLElement, options: any) {
-    options = options || {}
-    Object.assign(this, Headroom.options, options)
-    this.classes = Object.assign({}, Headroom.options.classes, options.classes)
-
-    this.elem = elem
-    this.tolerance = normalizeUpDown(this.tolerance)
-    this.offset = normalizeUpDown(this.offset)
-    this.initialised = false
-    this.frozen = false
-  }
-
-  /**
-   * Start listening to scrolling
-   * @public
-   */
-  init() {
-    if (!this.initialised) {
-      this.addClass('initial')
-      this.initialised = true
-
-      // defer event registration to handle browser
-      // potentially restoring previous scroll position
-      setTimeout(
-        function (self) {
-          self.scrollTracker = trackScroll(
-            self.scroller,
-            { offset: self.offset, tolerance: self.tolerance },
-            self.update.bind(self)
-          )
-        },
-        100,
-        this
-      )
-    }
-
-    return this
-  }
-
-  /**
-   * Destroy the widget, clearing up after itself
-   * @public
-   */
-  destroy() {
-    this.initialised = false
-    Object.keys(this.classes).forEach(this.removeClass, this)
-    this.scrollTracker?.destroy()
-  }
-
-  /**
-   * Unpin the element
-   * @public
-   */
-  unpin() {
-    if (this.hasClass('pinned') || !this.hasClass('unpinned')) {
-      this.addClass('unpinned')
-      this.removeClass('pinned')
-
-      if (this.onUnpin) {
-        this.onUnpin.call(this)
-      }
-    }
-  }
-
-  /**
-   * Pin the element
-   * @public
-   */
-  pin() {
-    if (this.hasClass('unpinned')) {
-      this.addClass('pinned')
-      this.removeClass('unpinned')
-
-      if (this.onPin) {
-        this.onPin.call(this)
-      }
-    }
-  }
-
-  /**
-   * Freezes the current state of the widget
-   * @public
-   */
-  freeze() {
-    this.frozen = true
-    this.addClass('frozen')
-  }
-
-  /**
-   * Re-enables the default behaviour of the widget
-   * @public
-   */
-  unfreeze() {
-    this.frozen = false
-    this.removeClass('frozen')
-  }
-
-  top() {
-    if (!this.hasClass('top')) {
-      this.addClass('top')
-      this.removeClass('notTop')
-
-      if (this.onTop) {
-        this.onTop.call(this)
-      }
-    }
-  }
-
-  notTop() {
-    if (!this.hasClass('notTop')) {
-      this.addClass('notTop')
-      this.removeClass('top')
-
-      if (this.onNotTop) {
-        this.onNotTop.call(this)
-      }
-    }
-  }
-
-  bottom() {
-    if (!this.hasClass('bottom')) {
-      this.addClass('bottom')
-      this.removeClass('notBottom')
-
-      if (this.onBottom) {
-        this.onBottom.call(this)
-      }
-    }
-  }
-
-  notBottom() {
-    if (!this.hasClass('notBottom')) {
-      this.addClass('notBottom')
-      this.removeClass('bottom')
-
-      if (this.onNotBottom) {
-        this.onNotBottom.call(this)
-      }
-    }
-  }
-
-  shouldUnpin(details: any) {
-    var scrollingDown = details.direction === 'down'
-
-    return scrollingDown && !details.top && details.toleranceExceeded
-  }
-
-  shouldPin(details: any) {
-    var scrollingUp = details.direction === 'up'
-
-    return (scrollingUp && details.toleranceExceeded) || details.top
-  }
-
-  addClass(className: string) {
-    this.elem.classList.add.apply(this.elem.classList, this.classes[className].split(' '))
-  }
-
-  removeClass(className: string) {
-    this.elem.classList.remove.apply(this.elem.classList, this.classes[className].split(' '))
-  }
-
-  hasClass(className: string) {
-    return this.classes[className].split(' ').every(function (cls: string) {
-      //@ts-ignore
-      return this.classList.contains(cls)
-    }, this.elem)
-  }
-
-  update(details: any) {
-    if (details.isOutOfBounds) {
-      // Ignore bouncy scrolling in OSX
-      return
-    }
-
-    if (this.frozen === true) {
-      return
-    }
-
-    if (details.top) {
-      this.top()
-    } else {
-      this.notTop()
-    }
-
-    if (details.bottom) {
-      this.bottom()
-    } else {
-      this.notBottom()
-    }
-
-    if (this.shouldUnpin(details)) {
-      this.unpin()
-    } else if (this.shouldPin(details)) {
-      this.pin()
-    }
-  }
-}

package/src/index.ts

@@ -1,3 +0,0 @@
-import Headroom from './headroom'
-
-export default Headroom

package/src/scroller.ts

@@ -1,82 +0,0 @@
-function isDocument(obj: any) {
-  return obj.nodeType === 9 // Node.DOCUMENT_NODE === 9
-}
-
-function isWindow(obj: any) {
-  // `obj === window` or `obj instanceof Window` is not sufficient,
-  // as the obj may be the window of an iframe.
-  return obj && obj.document && isDocument(obj.document)
-}
-
-function windowScroller(win: any) {
-  var doc = win.document
-  var body = doc.body
-  var html = doc.documentElement
-
-  return {
-    /**
-     * @see http://james.padolsey.com/javascript/get-document-height-cross-browser/
-     * @return {Number} the scroll height of the document in pixels
-     */
-    scrollHeight: function () {
-      return Math.max(
-        body.scrollHeight,
-        html.scrollHeight,
-        body.offsetHeight,
-        html.offsetHeight,
-        body.clientHeight,
-        html.clientHeight
-      )
-    },
-
-    /**
-     * @see http://andylangton.co.uk/blog/development/get-viewport-size-width-and-height-javascript
-     * @return {Number} the height of the viewport in pixels
-     */
-    height: function () {
-      return win.innerHeight || html.clientHeight || body.clientHeight
-    },
-
-    /**
-     * Gets the Y scroll position
-     * @return {Number} pixels the page has scrolled along the Y-axis
-     */
-    scrollY: function () {
-      if (win.pageYOffset !== undefined) {
-        return win.pageYOffset
-      }
-
-      return (html || body.parentNode || body).scrollTop
-    }
-  }
-}
-
-function elementScroller(element: HTMLElement) {
-  return {
-    /**
-     * @return {Number} the scroll height of the element in pixels
-     */
-    scrollHeight: function () {
-      return Math.max(element.scrollHeight, element.offsetHeight, element.clientHeight)
-    },
-
-    /**
-     * @return {Number} the height of the element in pixels
-     */
-    height: function () {
-      return Math.max(element.offsetHeight, element.clientHeight)
-    },
-
-    /**
-     * Gets the Y scroll position
-     * @return {Number} pixels the element has scrolled along the Y-axis
-     */
-    scrollY: function () {
-      return element.scrollTop
-    }
-  }
-}
-
-export default function createScroller(element: HTMLElement) {
-  return isWindow(element) ? windowScroller(element) : elementScroller(element)
-}

package/src/trackScroll.ts

@@ -1,54 +0,0 @@
-import createScroller from './scroller'
-import { passiveEventsSupported } from './features'
-
-/**
- * @param element EventTarget
- */
-export default function trackScroll(element: EventTarget, options: any, callback: Function) {
-  var isPassiveSupported = passiveEventsSupported()
-  var rafId: number
-  var scrolled = false
-  var scroller = createScroller(element as HTMLElement)
-  var lastScrollY = scroller.scrollY()
-  var details = {} as any
-
-  function update() {
-    var scrollY = Math.round(scroller.scrollY())
-    var height = scroller.height()
-    var scrollHeight = scroller.scrollHeight()
-
-    // reuse object for less memory churn
-    details.scrollY = scrollY
-    details.lastScrollY = lastScrollY
-    details.direction = scrollY > lastScrollY ? 'down' : 'up'
-    details.distance = Math.abs(scrollY - lastScrollY)
-    details.isOutOfBounds = scrollY < 0 || scrollY + height > scrollHeight
-    details.top = scrollY <= options.offset[details.direction]
-    details.bottom = scrollY + height >= scrollHeight
-    details.toleranceExceeded = details.distance > options.tolerance[details.direction]
-
-    callback(details)
-
-    lastScrollY = scrollY
-    scrolled = false
-  }
-
-  function handleScroll() {
-    if (!scrolled) {
-      scrolled = true
-      rafId = requestAnimationFrame(update)
-    }
-  }
-
-  var eventOptions = isPassiveSupported ? { passive: true, capture: false } : false
-
-  element.addEventListener('scroll', handleScroll, eventOptions)
-  update()
-
-  return {
-    destroy: function () {
-      cancelAnimationFrame(rafId)
-      element.removeEventListener('scroll', handleScroll, eventOptions)
-    }
-  }
-}

package/tsconfig.json

@@ -1,24 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es2018",
-    "module": "esnext",
-    "moduleResolution": "node",
-    "noEmitOnError": true,
-    "lib": ["es2017", "dom"],
-    "strict": true,
-    "esModuleInterop": false,
-    "allowSyntheticDefaultImports": true,
-    "experimentalDecorators": true,
-    "useDefineForClassFields": false,
-    "importHelpers": true,
-    "outDir": "dist",
-    "sourceMap": true,
-    "inlineSources": true,
-    "rootDir": "./",
-    "declaration": true,
-    "incremental": true,
-    "skipLibCheck": true,
-    "types": ["node", "mocha"]
-  },
-  "include": ["**/*.ts", "*.d.ts"]
-}

package/web-dev-server.config.mjs

@@ -1,27 +0,0 @@
-// import { hmrPlugin, presets } from '@open-wc/dev-server-hmr';
-
-/** Use Hot Module replacement by adding --hmr to the start command */
-const hmr = process.argv.includes('--hmr');
-
-export default /** @type {import('@web/dev-server').DevServerConfig} */ ({
-  open: '/demo/',
-  /** Use regular watch mode if HMR is not enabled. */
-  watch: !hmr,
-  /** Resolve bare module imports */
-  nodeResolve: {
-    exportConditions: ['browser', 'development'],
-  },
-
-  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
-  // esbuildTarget: 'auto'
-
-  /** Set appIndex to enable SPA routing */
-  // appIndex: 'demo/index.html',
-
-  plugins: [
-    /** Use Hot Module Replacement by uncommenting. Requires @open-wc/dev-server-hmr plugin */
-    // hmr && hmrPlugin({ exclude: ['**/*/node_modules/**/*'], presets: [presets.litElement] }),
-  ],
-
-  // See documentation for all available options
-});

package/web-test-runner.config.mjs

@@ -1,41 +0,0 @@
-// import { playwrightLauncher } from '@web/test-runner-playwright';
-
-const filteredLogs = ['Running in dev mode', 'lit-html is in dev mode'];
-
-export default /** @type {import("@web/test-runner").TestRunnerConfig} */ ({
-  /** Test files to run */
-  files: 'dist/test/**/*.test.js',
-
-  /** Resolve bare module imports */
-  nodeResolve: {
-    exportConditions: ['browser', 'development'],
-  },
-
-  /** Filter out lit dev mode logs */
-  filterBrowserLogs(log) {
-    for (const arg of log.args) {
-      if (typeof arg === 'string' && filteredLogs.some(l => arg.includes(l))) {
-        return false;
-      }
-    }
-    return true;
-  },
-
-  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
-  // esbuildTarget: 'auto',
-
-  /** Amount of browsers to run concurrently */
-  // concurrentBrowsers: 2,
-
-  /** Amount of test files per browser to test concurrently */
-  // concurrency: 1,
-
-  /** Browsers to run tests on */
-  // browsers: [
-  //   playwrightLauncher({ product: 'chromium' }),
-  //   playwrightLauncher({ product: 'firefox' }),
-  //   playwrightLauncher({ product: 'webkit' }),
-  // ],
-
-  // See documentation for all available options
-});