Skip to content

Attrs are never observed unless added with @attr decorator #208

Open
Open
Attrs are never observed unless added with @attr decorator#208
Labels
@attr
Milestone
v2

Description

@kristoforsalmin
kristoforsalmin
opened on Apr 29, 2022

Hi folks,

While I was testing the attributes — trying to work my way around #207 — I found another subtle detail. Manually initialized attributes are never observed.

Catalyst's guide provides the following example for vanilla users: https://github.com/github/catalyst/blob/main/docs/_guide/attrs.md#what-about-without-decorators.

Please notice the second argument there defineObservedAttributes(HelloWorldElement, ['foo']) and compare it with the actual function declaration:

catalyst/src/attr.ts

Line 99 in a8fb3ba

export function defineObservedAttributes(classObject: CustomElement): void {

It doesn't expect the second argument (arguments aren't used either).

Now, internally defineObservedAttributes() pulls attribute names from getAttrNames(), which, in turn, pulls them from attrs (WeakMap). The only way to populate attrs is to use @attr decorator:

catalyst/src/attr.ts

Line 15 in a8fb3ba

attrs.get(proto)!.push(key)

Maybe I'm missing something, but it seems like there's no way to specify observed attributes without decorators. In any case, it'd be very nice to clarify that 🙂

Thank you!

Activity

  1. kristoforsalmin commented on Apr 29, 2022

    @kristoforsalmin
    kristoforsalmin
    on Apr 29, 2022
    Author

    Using @attr as a function (like in tests) is the best workaround I found so far:

    import {attr, controller} from '@github/catalyst'

class HelloWorldElement extends HTMLElement {
  foo = 1
}

attr(HelloWorldElement.prototype, 'foo');

controller(HelloWorldElement);

    Attributes are correctly initialized (solving #207) and being observed... This can actually be a recommended way to add attributes without decorators?.. A bit verbose, but no more than calling initializeAttrs() and defineObservedAttributes() manually. With a tiny wrapper on user's end it could look like defineAttrs(HelloWorldElement, ['foo']).

    Thoughts?

  2. keithamus
    added this to the v2 milestone on May 3, 2022
  3. keithamus
    added
    @attr
    on May 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    @attr

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions