Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added package.json for NPM #11

Merged
merged 1 commit into from
Dec 5, 2014
Merged

Added package.json for NPM #11

merged 1 commit into from
Dec 5, 2014

Conversation

sverrejoh
Copy link
Contributor

I added a package.json so the module can be installed as an NPM package with Browserify.

With this you can install the package with npm:

$ npm install git+https://github.com/sverrejoh/javascript-detect-element-resize

And then use the page with require from your Browserify project:

// Content of index.js
require("javascript-detect-element-resize");

Build into one bundle containing everything with Browserify:

browserify index.js > bundle.js

I didn't change the code at all, this is just metadata.

I think it would be nice if the package had its own namespace, which exported addResizeListener and removeResizeListener, so you could use the code like this (instead of putting it on window):

var detectResize = require("javascript-detect-element-resize");
detectResize.addResizeListener(element, func);

But this requires some change in your code, and build step, so I didn't want to start on it.

Using Browserify you could have the canonical version as a Browserify/CommonJS module, and then just from that generate a package that works standalone, or with AMD/Bower.

https://github.com/substack/browserify-handbook#standalone

As I said, a little bit of changes, but I'd love to help if you're interested :).

sdecima added a commit that referenced this pull request Dec 5, 2014
Added package.json for NPM
@sdecima sdecima merged commit 1b79a1a into sdecima:master Dec 5, 2014
@sdecima
Copy link
Owner

sdecima commented Dec 5, 2014

Thanks @sverrejoh, I just created #12 for evaluating your recommendation (so I don't forget now that I merged/closed this pull request.

@alexlawrence
Copy link

+1. Exporting a separate object would really be useful in order to not pollute the global namespace. You could use https://github.com/umdjs/umd in order to export the correct format for all environments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants