Catalyst

Lifecycle Hooks

Catalyst Controllers - like many other frameworks - have several "well known" method names which are called periodically through the life cycle of the element, and let you observe when an element changes in various ways. Here is a comprehensive list of all life-cycle callbacks. Each one is suffixed Callback, to denote that it will be called by the framework.

connectedCallback()

The connectedCallback() is part of Custom Elements, and gets fired as soon as your element is appended to the DOM. This callback is a good time to initialize any variables, perhaps add some global event listeners, or start making any early network requests.

JavaScript traditionally uses the constructor() callback to listen for class creation. While this still works for Custom Elements, it is best avoided as the element won't be in the DOM when constructor() is fired, limiting its utility.

Things to remember

The connectedCallback is called as soon as the element is attached to a document. This may occur before an element has any children appended to it, so you should be careful not expect an element to have children during a connectedCallback call. This means avoiding checking any targets or using other methods like querySelector. Instead use this function to initialize itself and avoid doing initialization work which depend on children existing.

If your element depends heavily on its children existing, consider adding a MutationObserver in the connectedCallback to track when your elements children change.

attributeChangedCallback()

The attributeChangedCallback() is part of Custom Elements, and gets fired when observed attributes are added, changed, or removed from your element. It required you set a static observedAttributes array on your class, the values of which will be any attributes that will be observed for mutations. This is given a set of arguments, the signature of your function should be:

attributeChangedCallback(name: string, oldValue: string|null, newValue: string|null): void {}

Things to remember

The attributeChangedCallback will fire whenever setAttribute is called with an observed attribute, even if the new value is the same as the old value. In other words, it is possible for attributeChangedCallback to be called when oldValue === newValue. In most cases this really won't matter much, and in some cases this is very helpful; but sometimes this can bite, especially if you have non-idempotent code inside your attributeChangedCallback. Try to make sure operations inside attributeChangedCallback are idempotent, or perhaps consider adding a check to ensure oldValue !== newValue before performing operations which may be sensitive to this.

disconnectedCallback()

The disconnectedCallback() is part of Custom Elements, and gets fired as soon as your element is removed from the DOM. Event listeners will automatically be cleaned up, and memory will be freed automatically from JavaScript, so you're unlikely to need this callback for much.

adoptedCallback()

The adoptedCallback() is part of Custom Elements, and gets called when your element moves from one document to another (such as an iframe). It's very unlikely to occur, you'll almost never need this.