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

No docs #82

Open
aaronhill6 opened this issue Jan 28, 2016 · 10 comments
Open

No docs #82

aaronhill6 opened this issue Jan 28, 2016 · 10 comments

Comments

@aaronhill6
Copy link

This plugin looks like it would be pretty cool, but without any documentation, it's basically worthless. I used bower to install it in my project, initialized Darkroom.js on an image and got a "Cannot read property 'extend' of undefined" error on this line in the constructor:

this.options = Darkroom.Utils.extend(options, this.defaults);

Since there is not even any documentation about how Darkroom expects to be installed in a project (e.g. what file(s) to include), I have no way of even telling if I did it correctly. So I uninstalled the plugin and used another one. I look forward to trying this plugin out once there is some documentation.

@MattKetmo
Copy link
Owner

Hello.
What kind of documentation would you like to have?
For "installation" the files to include is the ones in the build directory.

@rashkov
Copy link

rashkov commented Feb 29, 2016

Is fabric.js a depdendency? I resolved the error @aaronhill6 was having by including the file on $(document).ready, but then it complains about fabric.js. I include fabric.js, but then it complains about canvas. It is not clear how to include darkroom into an all-javascript application.

@rashkov
Copy link

rashkov commented Feb 29, 2016

Never mind. I was trying to include canvas.js via require(). Once I included it using a script tag it began to work. Thanks for your work on this. I do think that pointing out that fabric.js is a dependency would be helpful in the documents

@Psychokrameur
Copy link

Hello,

I agree with @rashkov, this is one point which make me hesitate to choose your crop utility copare to other which seems... not as good. But they are well documented.

Can you write a bit of documentation? Especially on the plugins.
For example, how does we use the crop.ratio option? What are the possible values?
How to do 16/9 ? 4/3 ? Square?
Is it possible to constrain or free the ratio dynamically?

Thanks in advance!

@tejaswigowda
Copy link

Has anyone successfully written extensions for this? If so could you share?

@travhoog
Copy link

I would like to know how (or if it's possible) to output a jpg instead of a png when hitting Save.

@travhoog
Copy link

Nevermind. I figued out how. It looks like its found in the .toDataURL() call, which takes options. It would be nice if that could be specified in the configuration of the instance though. Maybe I'll look into adding that.

@Asuza
Copy link

Asuza commented Dec 5, 2016

@tejaswigowda, if you are still trying to use this utility, I'd recommending looking at PR #105 for help. Looking at the differences really helped me.

@Manoj9455
Copy link

can we use Darkroom with fabric v2.3.4??

@RajanXVII
Copy link

Is fabric.js a depdendency? I resolved the error @aaronhill6 was having by including the file on $(document).ready, but then it complains about fabric.js. I include fabric.js, but then it complains about canvas. It is not clear how to include darkroom into an all-javascript application.

use cdn for fabric.js

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

No branches or pull requests

9 participants