smoke-and-mirrors

Smoke-and-mirrors is an ember-addon that focuses on improving initial and re-render performance in high-stress situations by providing components and primitives 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.

Smoke-and-mirrors 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 smoke-and-mirrors

Support, Questions, Collaboration

Join the smoke-and-mirrors channel on Slack.

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.

Scroll Performance

Under the hood, smoke-and-mirrors is using a powerful scroll-tracking abstraction for each of the components above. That abstraction is made available as a service and will soon become it's own addon: ember-radar

Dependencies

smoke-and-mirrors is dependent on and installs ember-run-raf, which helps you budget and schedule the work in your app more intelligently.

This dependency will soon be deprecated in favor of igniter.

Status

Changelog

Documentation

For updated documentation and demos see http://runspired.github.io/smoke-and-mirrors/

Contributing

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

Commits

Angular Style commit messages have the full form:

<type>(<scope>): <title>

<body>

<footer>

But the abbreviated form (below) is acceptable and often preferred.

<type>(<scope>): <title>

Examples:

chore(deps): bump deps in package.json and bower.json
docs(component): document the fast-action component

Funding

OSS is often a labor of love. Smoke And Mirrors is largely built with that love.

erkarl / smoke-and-mirrors Goto Github PK