Skip to content
🌲 Get back to HTML.
JavaScript HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs typo Aug 29, 2019
src Change Inline feature to only use keyword args May 30, 2019
tests Change Inline feature to only use keyword args May 30, 2019
.gitignore Change name again May 30, 2019
CODE_OF_CONDUCT.md Add Code of Conduct May 23, 2019
LICENSE-APACHE Introduce Apache license Aug 27, 2019
LICENSE-MIT
index.js Fix bug when re-rendering with turbolinks May 6, 2019
jest-puppeteer.config.js Support toggle on inputs May 8, 2019
package.json
readme.md docs: added links to README, CamelCased JS Aug 28, 2019
rollup.config.js Change name again May 30, 2019
trimmings.svg Update logo Aug 27, 2019
yarn.lock Begin writing scripts for generating documentation May 13, 2019

readme.md

Trimmings logo

Trimmings

What happens to your web development process when you can focus on designing views and stop thinking about how to stitch them together? Trimmings by Postlight is a zero-configuration JavaScript library that adds a layer of smooth and fast in-page interaction to your web pages. All you have to do is add some hints to the HTML you already have.

Read more about it in our introduction to Trimmings.

This project follows in the footsteps of libraries like Turbolinks and Stimulus. It believes that the best place for your business and rendering logic is on the server, that you should send your users HTML, and that JavaScript is best suited for progressively-enhanced DOM manipulation. Trimmings is a set of patterns that allow you to add DOM manipulation to your app by adding data-trimmings-* attributes to your interactive elements. Less JavaScript in your project means less risk.

Once you've built your website and it's serving HTML that's presented the way you like it, you can start adding Trimmings hints that will enhance the way your interactions behave.

Perhaps you have a link to a detail page that you'd like to open in a modal. The standalone page probably has a header and footer that you wouldn't want to render in your modal. That's no problem. Just add an inline hint to your link:

<a data-trimmings-inline="from: .detail-container, to: .modal-container" href="/photos/2">
  View as a modal
</a>

If your visitor clicks that link, the page will be fetched in the background, the element with the detail-container class will be extracted from the result, and it will be inserted in an element with the modal-container class that's already on the page. You can write CSS that will make this show up however you like. Now you have a modal! That's all there is to it!

Installation

Just include trimmings.js in your <head>. That's it. Trimmings will automatically activate when your page loads—no need to think about lifecycles.

<script src="/trimmings.js"></script>

Usage

Trimmings features are enabled on specific elements by adding data-trimmings-* attributes. For more details on usage of each Trimmings feature, please consult the Trimmings handbook.

License

Licensed under either of

at your option.

Contributing

If you've found a bug or you'd like to propose a new feature, submit an issue and let's talk about it!

We expect that all contributors to Trimmings will abide by our Code of Conduct.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.


🔬 A Labs project from your friends at Postlight. Happy coding!

You can’t perform that action at this time.