ui/id

Add-ons using the techniques described in this document are considered a legacy technology in Firefox. Don't use these techniques to develop new add-ons. Use WebExtensions instead. If you maintain an add-on which uses the techniques described here, consider migrating it to use WebExtensions.

From Firefox 53 onwards, no new legacy add-ons will be accepted on addons.mozilla.org (AMO).

From Firefox 57 onwards, WebExtensions will be the only supported extension type, and Firefox will not load other types.

Even before Firefox 57, changes coming up in the Firefox platform will break many legacy extensions. These changes include multiprocess Firefox (e10s), sandboxing, and multiple content processes. Legacy extensions that are affected by these changes should migrate to WebExtensions if they can. See the "Compatibility Milestones" document for more.

A wiki page containing resources, migration paths, office hours, and more, is available to help developers transition to the new technologies.

Experimental

Create UI component IDs.

Globals

Functions

identify(object)

Makes and/or gets a unique ID for the input.

Making an ID

const { identify } = require('sdk/ui/id');
const Thingy = Class({
  initialize: function(details) {
    let id = identify(this);
  }
});

Getting an ID

const { identify } = require('sdk/ui/id');
const { Thingy } = require('./thingy');
let thing = Thingy(/* ... */);
let thingID = identify(thing);

Defining ID generator

const { identify } = require('sdk/ui/id');
const Thingy = Class(/* ... */);
identify.define(Thingy, thing => thing.guid);
Parameters

object : Object
Object to create an ID for.

Returns

String : Returns a UUID by default (or domain specific ID based on a provided definition).

Document Tags and Contributors

 Contributors to this page: wbamberg
 Last updated by: wbamberg,