Meta tags:
description=A promise-based JavaScript library for building single-page web applications from reusable components, called gadgets.;
keywords=javascript, asynchronous;

Headings (most frequently used words):

api, gadget, renderjs, quickguide, definition,

Text of the page (most frequently used words):
the (63), #gadget (53), callback (33), state (11), this (11), rjs (10), window (10), with (9), context (9), return (8), method (8), when (8), scope (8), instance (8), all (7), resolved (7), rsvp (6), queue (6), call (6), which (6), declare (6), dom (6), data (6), renderjs (6), changestate (5), child (5), options (5), api (5), methods (5), job (4), only (4), div (4), set (4), methodname (4), take (4), argument (4), event (4), service (4), ancestor (3), throw (3), parent (3), allowpublicacquisition (3), arguments (3), acquired (3), undefined (3), declared (3), change (3), and (3), are (3), html (3), element (3), wrap (3), javascript (3), explanation (3), used (3), can (3), automatically (3), acquire (3), first (3), mutex (3), should (3), trigger (3), ready (3), quickguide (3), result (2), declaremethod (2), new (2), key (2), value (2), keys (2), provided (2), other (2), onstatechange (2), scopeerror (2), unknown (2), existing (2), reference (2), declaring (2), than (2), default (2), iframe (2), public (2), sandbox (2), url (2), what (2), catch (2), error (2), there (2), called (2), from (2), acquisition_name (2), publish (2), executed (2), after (2), but (2), for (2), execution (2), over (2), delay (2), onloop (2), declareservice (2), soon (2), loaded (2), definition (2), legal, mention, 沪icp备14008524号, copyright, 2001, 2026, rights, reserved, nexedi, handle, acquisitionerror, recursively, tree, until, one, parentpublicacquisition, acquiredmethodname, declaredjobname, declaredmethodname, passing, pair, overwrites, current, values, different, remain, unchanged, dropgadget, drop, getdeclaredgadget, get, exactly, correspond, those, addition, specify, rather, auto, generated, declaregadget, gadget_url, directly, required, access, that, name, gadget_example, example, reportgadgetdeclarationerror, loading, reportserviceerror, their, services, internally, declareacquiredmethod, second, argument_list, allow, children, form, protected, contains, modified, parameters, modification_dict, comparison, done, json, stringify, whenever, changes, contain, pairs, just, ordinary, object, hard, restrictions, once, initialising, setstate, initial, create, listener, given, onevent, type, use_capture, prevent_default, bind, however, calling, cancels, previous, hasn, finished, like, its, starts, spawns, executing, declarejob, again, has, same, behaviour, browser, tab, must, also, visible, loop, multiple, handlers, concurrently, cancelled, removed, into, setup, prevent, concurrent, bar, require, accessible, gadgets, most, common, way, adding, functionality, triggered, dependencies, have, handler, they, chainable, below, list, followed, more, detailed, later, sections, language, 001, version, 2020, last, update, home, apps, chain,

Text of the page (random words):
renderjs api quickguide renderjs javascript apps on a chain renderjs api quickguide home renderjs api quickguide last update 2020 06 05 version 001 language en below is a list of all methods provided by renderjs followed by a more detailed explanation in later sections gadget s definition api all methods return the gadget definition and so they are chainable callback this context is the gadget instance do what do this explanation ready handler rjs window ready callback the ready callback is triggered automatically when all gadget dependencies have loaded callback this context is the gadget instance declare method for parent gadget rjs window declaremethod methodname callback options declaring methods is the most common way of adding functionality to a gadget only declare methods which require the this context or which should be accessible by other gadgets callback this context is the gadget instance options can be used to setup a mutex on the callback to prevent concurrent execution mutex bar changestate declare service rjs window declareservice callback callback automatically trigger as soon as the gadget is loaded into the dom callback is cancelled as soon as the gadget is removed from the dom callback this context is the gadget instance there can be multiple declareservice handlers which all trigger concurrently loop rjs window onloop callback delay onloop callback has the same behaviour than a service but browser tab must also be visible to trigger it when the callback is over it is executed again after the delay is over declare job rjs window declarejob methodname callback when the methodname is called on a gadget it spawns a service executing the callback like a service its execution starts when the gadget is in the dom callback this context is the gadget instance however calling a job cancels the previous call of the job if it hasn t finished bind event rjs window onevent type callback use_capture prevent_default create an event listener for the given event on the gadget element callback this context is the gadget instance callback take the dom event as first argument set initial state rjs window setstate options the gadget s state should be set once when initialising the gadget the state should contain key value pairs but the state is just an ordinary javascript object with no hard restrictions change state callback rjs window onstatechange callback callback is executed after changestate call on a gadget whenever the gadget state changes comparison of gadget state is done with json stringify callback this context is the gadget instance callback take a modification_dict as first argument which contains all the modified state parameters callback is protected by the changestate mutex publish method form child gadget rjs window allowpublicacquisition acquisition_name callback publish a method to allow children to acquire it callback this context is the gadget instance callback take the acquired method argument_list as first argument callback take the child gadget scope as second argument acquire method rjs window declareacquiredmethod methodname acquisition_name acquire a method from a parent gadget by default there are 2 acquired methods which can be automatically called by renderjs internally reportserviceerror used to catch child gadget error in their services reportgadgetdeclarationerror used to catch gadget loading error when declared in the dom gadget api do what do this explanation declare gadget html div data gadget url gadget_example html data gadget scope example data gadget sandbox public div only data gadget url is required set data gadget scope to access the gadget by that scope name in javascript set data gadget sandbox to be public to wrap the gadget in a div directly in the dom or iframe to wrap the gadget in an iframe declare gadget js gadget declaregadget gadget_url options return an rsvp queue resolved with the child gadget reference the options exactly correspond to those when declaring the gadget in html with the addition of element to specify an element to wrap the gadget in rather than the default auto generated div get an existing gadget gadget getdeclaredgadget scope return an rsvp queue resolved with the child gadget reference throw a scopeerror if the scope is unknown drop an existing gadget gadget dropgadget scope return an rsvp queue resolved with undefined throw a scopeerror if the scope is unknown change state gadget changestate state return an rsvp queue resolved with undefined when the onstatechange callback is resolved change the state by passing in a new key value pair which only overwrites the keys provided in the changestate call and only if the current and new values are different all other keys remain unchanged declared method call gadget declaredmethodname arguments return an rsvp queue resolved with the result of the declaremethod callback declared job call gadget declaredjobname arguments return undefined acquired method call gadget acquiredmethodname arguments return an rsvp queue resolved with the result of the ancestor allowpublicacquisition callback recursively go up in the parent tree until one ancestor allowpublicacquisition the parentpublicacquisition if no ancestor handle it throw acquisitionerror nexedi sa copyright c 2001 2026 all rights reserved 沪icp备14008524号 legal mention