Skip to content

Releases: github/catalyst

v1.7.0

23 Oct 17:26
@keithamus keithamus
v1.7.0
5d9b9cb
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
v1.7.0 Latest
Latest

What's Changed

  • Docs: surface required delimiters for Targets' and Actions' syntax patterns by @francisfuzz in #320
  • Allow for objects to be passed to lazyDefine, avoiding repeat calls by @keithamus in #321

New Contributors

Full Changelog: v1.6.1...v1.7.0

Contributors

keithamus and francisfuzz
Assets 2
Loading

v1.6.1

28 Feb 11:31
@keithamus keithamus
v1.6.1
dc284dc
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v1.6.1

What's Changed

Mostly documentation changes, but also now lazyDefine will observe @controller shadowroots. It does not patch attachShadow and so if you want it to observe non-catalyst controller shadowroots, you will need to do so manually:

import {observe} from '@github/catalyst/lib/lazy-define.js'
observe(shadowRoot)

New Contributors

Full Changelog: v1.6.0...v1.6.1

Contributors

rik, keithamus, and 3 other contributors
Assets 2
Loading

v1.6.0

04 Aug 10:26
@keithamus keithamus
v1.6.0
bb28e3d
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v1.6.0

New Features

We've added a new lazyDefine function, which allows for lazy loading of controllers. See more about lazyDefine in the guide.

What's Changed

Full Changelog: v1.5.0...v1.6.0

Contributors

keithamus and koddsson
Assets 2
Loading

v1.5.0

28 Jun 11:12
@keithamus keithamus
v1.5.0
629ab22
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v1.5.0

This change lays a bunch of groundwork for 2.0, mostly for things which are not related to production code, so very little has changed from 1.4.2 to 1.5.0.

The key new feature here is a temporary feature to help migration to 2.0: @attr by default comes with a data- prefix, this is being dropped in 2.0, and 1.5.0 now observed a classes attrPrefix static property (which defaults to data-). To enable an easier migration to 2.0, you can use this to refactor your code and drop the data- attr prefix:

class HelloWorldController extends HTMLElement {
  static attrPrefix = '' // defaults to 'data-'
}

What's Changed

New Contributors

Full Changelog: v1.4.2...v1.5.0

Contributors

steves, keithamus, and 3 other contributors
Assets 2
Loading

v2.0.0-alpha1

26 May 17:09
@keithamus keithamus
v2.0.0-alpha1
b1540e7
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v2.0.0-alpha1 Pre-release
Pre-release

This is an early pre-release of Catalyst 2.0, released in order to test for bugs. You should not consider this production ready.

2.0 is a almost-from-the-ground-up rewrite of the core behaviours to make things a bit more consistent and also to allow for more flexibility throughout 2.0. We've also improved the ergonomics and usability of some of the features.

Features

There are many changes and subtle improvements, so we'd recommend sitting down with your favourite beverage and re-reading the guide (NOTE: for pre-releases you'll need to read the v2 branch source. Sorry). Here are some of our favourite new features though:

  • @attr and @target can now be setters, meaning you can trigger behaviour when they change.
  • @attr, @target, and class names now all have consistent dasherized versions for within HTML.
  • The html literal versions of @attr drop the data- prefix for better ergonomics.
  • Actions and Targets can now listen to closed shadowroots.
  • We've added a new system for Abilities. We'll be adding two new abilities in the 2.0 release: @loadable and @providable. See the guide for more.
  • You can create your own abilities for shared functionality!

Breaking Changes

Here's a summary of breaking changes in order of "you'll definitely need to change this" down to "this probably wont effect you".

🔴 @attr is no longer prefixed with data- in HTML

The @attr decorator used to dasherize a JS property name and then prefix it with data- for use in HTML, so in other words @attr fooBar in JS would result in data-foo-bar= in HTML. This is now no longer the case, and instead @attr fooBar will result in an HTML attribute name of foo-bar=. We decided to do this as it is more ergonomic, and less surprising. @attr names now work like class names: they get dasherized, no surprising prefixes.

What's the easiest fix?

The easiest way to handle this change is to prefix your JS properties with data, so @attr fooBar becomes @attr dataFooBar. No changes will need to be made to your HTML, and if you reference the HTML value in your JS (e.g. hasAttribute('data-foo-bar')) then this will also not need to change.

What's a better fix?

Drop the data- prefix from your HTML attributes, as this will be more ergonomic. You might also need to drop the data- prefix in any JS where you reference the literal HTML value in your JS (e.g. hasAttribute('data-foo-bar') should be hasAttribute('foo-bar')).

🔴 @attrs must consist of 2 words (camelcased)

In order to drop the data- prefix, we decided a good trade-off would be to require @attrs to consist of 2 words - in other words the HTML attribute name must have a dash. Names like @attr foo will need to be refactored to include 2 words (or one uppercase character), so for example @attr fooBar is acceptable.

What's the easiest fix?

The easiest way to handle this change is to prefix your JS properties with data which will also get around the dropping of the data prefix, so @attr foo becomes @attr dataFoo. No changes will need to be made to your HTML, and if you reference the HTML value in your JS (e.g. hasAttribute('data-foo-bar')) then this will also not need to change.

What's a better fix?

If you have @attr properties that are one word, you'll need to think of a name for them that consists of two words. Here are some examples to give you some inspiration:

  • @attr path -> @attr pathName
  • @attr valid -> @attr isValid
  • @attr changed -> @attr hasChanged
  • @attr error -> @attr errorMessage
  • @attr src -> @attr srcURL
  • @attr content -> @attr contentText
  • @attr json -> Literally anything else 😉.

🟡 @attr no longer sets observedAttributes, so attributeChangedCallback won't be fired.

We've changed how @attr updates its attributes, to use a mutationobserver under the hood - instead of attributeChangedCallback. There are many reasons for this change; it was surprising to users to see attributeChangedCallback being called for stuff that isn't in observedAttributes, also attributeChangedCallback didn't correctly coerce values - it's only called with string types. With Catalyst 2.0 you can instead add @attr to a setter, and have that respond to changes to the attribute.

What's the easiest fix?

If you don't have an attributeChangedCallback in your code, forget about it. If you do, then the easiest fix is to manually add observedAttributes to your class, to reflect all of the @attr decorated fields. So e.g. @attr fooBar would need static observedAttributes = ['foo-bar'].

What's a better fix?

Refactor your attributeChangedCallback to remove checks for your @attr decorated attributes, and use setters instead. For example:

🟡 @attr no longer sets the html in the connectedCallback

It was surprising to see attributes sprouting onto an element when it gets connected, and it isn't inline with how built-in elements behave. @attrs now do not set the html attribute value based on the initial value, instead the the html attribute value is used to override the default property value. This works more like built-in HTML elements:

const input = document.createElement('input')
console.assert(input.type === 'text') // default value
console.assert(input.hasAttribute('type') === false) // no attribute to override
input.setAttribute('type', 'number')
console.assert(input.type === 'number') // overrides based on attribute
input.removeAttribute('type')
console.assert(input.type === 'text') // back to default value

What's the easiest fix?

You probably won't need to do anything. If your code depends on the html attribute existing during connectedCallback, then a quick fix is to set the value to itself in your connectedCallback. e.g. if you have an @attr fooBar = 'hello' then in your connectedCallback add the line this.fooBar = this.fooBar.

What's a better fix?

If your code depends on the html attribute existing during connectedCallback, then you should refactor your code. Strategies around this vary, but generally you should refer to the property name rather than the html literal value, alternatively if you still need to access the html literal value you can use a logical OR operator with the @attr default value, for example for an @attr fooBar = 'hello' you could use this.getAttribute('foo-bar') || 'hello'.

🟡 @controllers now will drop the Controller/Element/Component suffix

We've had feedback that Element is a fine suffix to drop, but it'd be nice to have symmetry with other frameworks and drop more suffixes - so in 2.0 we're also dropping Controller and Component suffixes. This means for an element named something like FooBarController in 1.x would be <foo-bar-controller />, it'll be <foo-bar /> in 2.x. Similarly FooBarComponent will also be <foo-bar />.

What's the easiest fix?

We audited all open source Catalyst components (and the closed source ones we had access to) and couldn't find any that end in Component or Controller, so we think it's really unlikely that this will be a problem.

Nevertheless, there's only one type of fix for this - and that's to drop the suffix from your HTML.

What's Changed

Read more

Contributors

steves, keithamus, and koddsson
Assets 2
Loading
4 Join discussion

v1.4.2

01 May 07:09
@keithamus keithamus
v1.4.2
f0e9761
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v1.4.2

This release fixes a bad v1.4.0 build! Please see the release notes for v1.4.0

Assets 2
Loading

v1.4.1

01 May 07:02
@keithamus keithamus
v1.4.1
e8be4f6
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v1.4.1

This release fixes a bad v1.4.0 build! Please see the release notes for v1.4.0

Assets 2
Loading

v1.4.0

30 Apr 08:06
@keithamus keithamus
v1.4.0
0775b42
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v1.4.0

This release allows for safe custom element redefinition, which enables the use of HMR plugins with Catalyst controllers. Releases prior to this would first check if the element is already registered, and skip registration. Instead, in 1.4.0, elements will try to register and catch redefinition errors if they’re thrown - which means HMR plugins that override customElements.define will now work.

Assets 2
Loading

v1.3.2

04 Apr 08:28
@koddsson koddsson
v1.3.2
a8fb3ba
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v1.3.2

What's Changed

Full Changelog: v1.3.1...v1.3.2

Contributors

jdanyow and dependabot
Assets 2
Loading

v1.3.1

28 Mar 11:59
@koddsson koddsson
v1.3.1
d16d885
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v1.3.1

What's Changed

Full Changelog: v1.3.0...v1.3.1

Contributors

keithamus, koddsson, and dependabot
Assets 2
Loading