848483 - Mention NativeWindow in the mobile dev docs

Status: RESOLVED WONTFIX

(Add-on SDK Graveyard :: Documentation, defect)

Description

[Jeff Griffiths (:canuckistani) (:⚡︎)]

NativeWindow is a useful complementary set of apis available on Fennec that we should point towards from here:

https://addons.mozilla.org/en-US/developers/docs/sdk/latest/dev-guide/tutorials/mobile.html

It is also very easy to wrap NativeWindow functionality in a CommonJS shim:

https://github.com/canuckistani/fennec-plus/blob/master/lib/nativewindow.js

Comment 1

[Matteo Ferretti [:zer0] [:matteo]]

I think we should avoid to expose directly this kind of stuff in SDK; instead we should build our APIs in a way that works both for Fennec and Firefox (see tabs, windows, or even my doorhanger lib: https://github.com/ZER0/doorhanger), and guide the devs to do the same.

All of the thing that `NativeWindow` is capable of doing, should be mostly implemented by High Level SDK APIs, without the needs of get access to `NativeWindow`.

However, I agree that until we reach this point, it's definitely worth to be mention how to get a reference to `NativeWindow` in Add-on SDK, and maybe on `BrowserApp` too, pointing to the MDN references (https://developer.mozilla.org/en-US/docs/Extensions/Mobile/API/NativeWindow).

Comment 2

[Erik Vold [:erikvold] (please needinfo? me)]

I agree with Matteo.

I don't think that the SDK docs should be talking about platform specific stuff, that is what MDN is for.  If we talk about `NativeWindow` then we might as well talk about `gBrowser`, and the list will go on and on.

This is good material for blog posts tho!

Comment 3

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

Lets talk about this at the work week.