[IPython-dev] How to hook js plugins into IPython Notebook

[Brian Granger]

Jeff,

The short answer is that we are not quite there yet.  The code in the
jsplugins repo is only experimental and the final API will probably
look different from that.  We have plens to start work on this part of
IPython in July, but it is going to be probably into the Fall before
we have something tnat is ready to play with.  In the meantime, the
way we are encouraging users to add additional JS to the notebook is
by creating a custom.js file in your profile_dir/js/static.  It will
be loaded onto the page and you can access all of our JS objects.
Yes, you can count on jQuery/$ being available.

Cheers,

Brian

On Wed, May 1, 2013 at 12:49 PM, Jeffrey Tratner <jtratner at gmail.com> wrote:
> Hi all,
>
> I'd like to write a js plugin for IPython Notebook, but I'm not clear on
> what can be hooked into the interface.  Specifically, I'd like to do the
> following:
>
>
> 1. Add an item to the menu.
> 2. Add another keyboard shortcut. [and also if there already exist hooks to
> register event listeners, etc. -- clearly it's not difficult to add another
> event listener for keyboard shortcuts, but I'd like the plugin to be well
> behaved].
> 3. Persist classes, IDs or data attributes into the notebook format between
> sessions.
>
> Also, can I count on `$` / `jQuery` being available going forward?
>
> I'm happy to read docs on this and experiment myself, but I haven't found
> anything that answers the above so far. I'm currently reading through the
> ipython/jsplugins repo, but any tips on where to look or what to hook into
> would be very appreciated.
>
> I really love the notebook format - thank you all for making that happen!
>
> Best,
>
> Jeff
>
> _______________________________________________
> IPython-dev mailing list
> IPython-dev at scipy.org
> http://mail.scipy.org/mailman/listinfo/ipython-dev
>



-- 
Brian E. Granger
Cal Poly State University, San Luis Obispo
bgranger at calpoly.edu and ellisonbg at gmail.com