You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -9,86 +9,139 @@ Components may sometimes manage state, or configuration. We encourage the use of
9
9
10
10
As Catalyst elements are really just Web Components, they have the `hasAttribute`, `getAttribute`, `setAttribute`, `toggleAttribute`, and `removeAttribute` set of methods available, as well as [`dataset`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLOrForeignElement/dataset), but these can be a little tedious to use; requiring null checking code with each call.
11
11
12
-
Catalyst includes the `@attr` decorator, which provides nice syntax sugar to simplify, standardise, and encourage use of attributes. `@attr` has the following benefits over the basic `*Attribute` methods:
12
+
Catalyst includes the `@attr` decorator which provides nice syntax sugar to simplify, standardise, and encourage use of attributes. `@attr` has the following benefits over the basic `*Attribute` methods:
13
+
14
+
- It dasherizes a property name, making it safe for HTML serialization without conflicting with [built-in global attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes). This works the same as the class name, so for example `@attr pathName` will be `path-name` in HTML, `@attr srcURL` will be `src-url` in HTML.
15
+
- An `@attr` property automatically casts based on the initial value - if the initial value is a `string`, `boolean`, or `number` - it will never be `null` or `undefined`. No more null checking!
16
+
- It is automatically synced with the HTML attribute. This means setting the class property will update the HTML attribute, and setting the HTML attribute will update the class property!
17
+
- Assigning a value in the class description will make that value the _default_ value so if the HTML attribute isn't set, or is set but later removed the _default_ value will apply.
18
+
19
+
This behaves similarly to existing HTML elements where the class field is synced with the html attribute, for example the `<input>` element's `type` field:
20
+
21
+
```ts
22
+
const input =document.createElement('input')
23
+
console.assert(input.type==='text') // default value
24
+
console.assert(input.hasAttribute('type') ===false) // no attribute to override
25
+
input.setAttribute('type', 'number')
26
+
console.assert(input.type==='number') // overrides based on attribute
27
+
input.removeAttribute('type')
28
+
console.assert(input.type==='text') // back to default value
29
+
```
13
30
14
-
- It maps whatever the property name is to `data-*`, [similar to how `dataset` does](https://developer.mozilla.org/en-US/docs/Web/API/HTMLOrForeignElement/dataset#name_conversion), but with more intuitive naming (e.g. `URL` maps to `data-url` not `data--u-r-l`).
15
-
- An `@attr` property is limited to `string`, `boolean`, or `number`, it will never be `null` or `undefined` - instead it has an "empty" value. No more null checking!
16
-
- The attribute name is automatically [observed, meaning `attributeChangedCallback` will fire when it changes](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements#using_the_lifecycle_callbacks).
17
-
- Assigning a value in the class description will make that value the _default_ value, so when the element is connected that value is set (unless the element has the attribute defined already).
31
+
{% capture callout %}
32
+
An important part of `@attr`s is that they _must_ comprise of two words, so that they get a dash when serialised to HTML. This is intentional, to avoid conflicting with [built-in global attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes). To see how JavaScript property names convert to HTML dasherized names, try typing the name of an `@attr` below:
33
+
{% endcapture %}{% include callout.md %}
18
34
19
-
To use the `@attr` decorator, attach it to a class field, and it will get/set the value of the matching `data-*` attribute.
35
+
<form>
36
+
<label>
37
+
<h4>I want my `@attr` to be named...</h4>
38
+
<input class="js-attr-dasherize-test mb-4">
39
+
</label>
40
+
<divhiddenclass="js-attr-dasherize-bad text-red">
41
+
{{ octx }} An attr name must be two words, so that the HTML version includes a dash!
if (!this.hasAttribute('data-foo')) this.foo='Hello'
103
+
if (!this.hasAttribute('foo-bar')) this.fooBar='Hello'
53
104
}
54
105
55
-
static observedAttributes = ['data-foo']
56
106
}
57
107
```
58
108
59
109
### Attribute Types
60
110
61
-
The _type_ of an attribute is automatically inferred based on the type it is first set to. This means once a value is set it cannot change type; if it is set a `string` it will never be anything but a `string`. An attribute can only be one of either a `string`, `number`, or `boolean`. The types have small differences in how they behave in the DOM.
111
+
The _type_ of an attribute is automatically inferred based on the type it is first set to. This means once a value is initially set it cannot change type; if it is set a `string` it will never be anything but a `string`. An attribute can only be one of either a `string`, `number`, or `boolean`. The types have small differences in how they behave in the DOM.
62
112
63
113
Below is a handy reference for the small differences, this is all explained in more detail below that.
64
114
65
-
| Type |"Empty" value |When `get` is called | When `set` is called |
If an attribute is first set to a `string`, then it can only ever be a `string` during the lifetime of an element. The property will return an empty string (`''`) if the attribute doesn't exist, and trying to set it to something that isn't a string will turn it into one before assignment.
123
+
If an attribute is first set to a `string`, then it can only ever be a `string` during the lifetime of an element. The property will revert to the initial value if the attribute doesn't exist, and trying to set it to something that isn't a string will turn it into one before assignment.
this.setAttribute('foo-bar', 'this value doesnt matter!')
169
+
console.assert(this.fooBar === true)
117
170
}
118
171
}
119
172
```
120
173
121
174
#### Number Attributes
122
175
123
-
If an attribute is first set to a number, then it can only ever be a number during the lifetime of an element. This is sort of like the [`maxlength` attribute on inputs](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/maxlength). The property will return `0` if the attribute doesn't exist, and will be coerced to `Number` if it does - this means it is _possible_ to get back `NaN`. Negative numbers and floats are also valid.
176
+
If an attribute is first set to a number, then it can only ever be a number during the lifetime of an element. This is sort of like the [`maxlength` attribute on inputs](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/maxlength). The property will return the initial value if the attribute doesn't exist, and will be coerced to `Number` if it does - this means it is _possible_ to get back `NaN`. Negative numbers and floats are also valid.
124
177
125
178
<!-- annotations
126
-
attr foo: Maps to get/setAttribute('data-foo')
179
+
attr foo: Maps to get/setAttribute('foo-bar')
127
180
-->
128
181
129
182
```js
130
183
import { controller, attr } from "@github/catalyst"
@@ -148,7 +202,7 @@ class HelloWorldElement extends HTMLElement {
148
202
When an element gets connected to the DOM, the attr is initialized. Duringthis phase Catalyst will determine if the default value should be applied. The default value is defined in the classproperty. The basic rules are as such:
149
203
150
204
- If the classproperty has a value, that is the _default_
151
-
- When connected, if the element _does not_ have a matching attribute, the default _is_ applied.
205
+
- When connected, if the element _does not_ have a matching attribute, the _default is_ applied.
152
206
- When connected, if the element _does_ have a matching attribute, the default _is not_ applied, the property will be assigned to the value of the attribute instead.
153
207
154
208
{% capture callout %}
@@ -165,9 +219,9 @@ attr name: Maps to get/setAttribute('data-name')
165
219
import { controller, attr } from "@github/catalyst"
166
220
@controller
167
221
class HelloWorldElement extends HTMLElement {
168
-
@attr name='World'
222
+
@attr dataName = 'World'
169
223
connectedCallback() {
170
-
this.textContent=`Hello ${this.name}`
224
+
this.textContent = `Hello ${this.dataName}`
171
225
}
172
226
}
173
227
```
@@ -187,24 +241,45 @@ data-name ".*": Will set the value of `name`
187
241
// This will render `Hello `
188
242
```
189
243
190
-
### What about without Decorators?
244
+
### Advanced usage
191
245
192
-
If you're not using decorators, then you won't be able to use the `@attr` decorator, but there is still a way to achieve the same result. Under the hood `@attr` simply tags a field, but `initializeAttrs` and `defineObservedAttributes` do all of the logic.
246
+
#### Determining when an @attr changes value
193
247
194
-
Calling `initializeAttrs` in your connected callback, with the list of properties you'd like to initialize, and calling `defineObservedAttributes` with the class, can achieve the same result as `@attr`. The class fields can still be defined in your class, and they'll be overridden as described above. For example:
To be notified when an `@attr` changes value, you can use the decorator over
249
+
"setter" method instead, and the method will be called with the new value
250
+
whenever it is re-assigned, either through HTML or JavaScript:
198
251
252
+
```typescript
253
+
import { controller, attr } from "@github/catalyst"
254
+
@controller
199
255
class HelloWorldElement extends HTMLElement {
200
-
foo =1
201
256
202
-
connectedCallback() {
203
-
initializeAttrs(this, ['foo'])
257
+
@attr get dataName() {
258
+
return 'World' // Used to get the intial value
204
259
}
260
+
// Called whenever `name` changes
261
+
@attr set dataName(newValue: string) {
262
+
this.textContent = `Hello ${newValue}`
263
+
}
264
+
}
265
+
```
266
+
267
+
### What about without Decorators?
268
+
269
+
If you're not using decorators, then the `@attr` decorator has an escape hatch: You can define a staticclassfield using the `[attr.static]` computed property, as an array of key names. Like so:
0 commit comments