Null Pointer Micromanagement
    Have ideas to improve npm?Join in the discussion! »

    @html-next/vertical-collection

    2.0.0 • Public • Published

    vertical-collection

    Greenkeeper badge

    Build Status

    Infinite Scroll and Occlusion at > 60FPS

    vertical-collection is an ember-addon that is part of the smoke-and-mirrors framework. It focuses on improving initial and re-render performance in high-stress situations by providing a component for performant lists and svelte renders to match a core belief: Don't render the universe, render the scene.

    TL;DR svelte render: the fewer things you need to render, the faster your renders will be.

    Your web page is a universe, your viewport is the scene. Much like you wouldn't expect a video game to render out-of-scene content, your application should smartly cull the content it doesn't need to care about. Trimming excess content lets the browser perform both initial renders and re-renders at far higher frame-rates, as the only content it needs to focus on for layout is the content the user can see.

    vertical-collection augments your existing app, it doesn't ask you to rewrite layouts or logic in order to use it. It will try its best to allow you to keep the conventions, structures, and layouts you want.

    Install

    ember install @html-next/vertical-collection

    Usage

    {{#vertical-collection
        items
        tagName='ul'
        estimateHeight=50
        staticHeight=false
        bufferSize=1
        renderAll=false
        renderFromLast=false
        idForFirstItem=idForFirstItem
        firstReached=(action firstReached)
        lastReached=(action lastReached)
        firstVisibleChanged=(action firstVisibleChanged)
        lastVisibleChanged=(action lastVisibleChanged)
         as |item i|}}
        <li>
          {{item.number}} {{i}}
        </li>
    {{/vertical-collection}}

    Actions

    firstReached - Triggered when scroll reaches the first element in the collection

    lastReached- Triggered when scroll reaches the last element in the collection

    firstVisibleChanged - Triggered when the first element in the viewport changes

    lastVisibleChanged - Triggered when the last element in the viewport changes

    Support Matrix

    vertical-collection version Supported Ember versions
    ^v1.0.0 v1.12.0 - v3.8.0
    ^v2.0.0 v2.8.0+

    Support, Questions, Collaboration

    Join the Ember community on Discord

    Features

    Infinite Scroll (bi-directional)

    Infinite scroll that remains performant even for very long lists is easily achievable with the vertical-collection. It works via a scrollable div or scrollable body.

    Svelte Everything

    If it can be trimmer, smoke-and-mirrors likes to trim it.

    Status

    Changelog

    Build Status dependencies devDependency Status Coverage Status

    Documentation

    For updated documentation and demos see http://html-next.github.io/vertical-collection/

    Contributing

    • Open an Issue for discussion first if you're unsure a feature/fix is wanted.
    • Branch off of master (default branch)
    • Use descriptive branch names (e.g. <type>/<short-description>)
    • PR against master (default branch).

    Testing

    Make sure you register the test waiter from ember-raf-scheduler. So ember-test-helpers's wait is aware of the scheduled updates.

    An example can be found here

    License

    This project is licensed under the MIT License.

    Install

    npm i @html-next/vertical-collection

    DownloadsWeekly Downloads

    27,248

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    101 kB

    Total Files

    64

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar