Skip to content

Commit 8ff8f16

Browse files
Merge branch 'main' into export-star
2 parents 8819601 + f3943cb commit 8ff8f16

4 files changed

Lines changed: 6 additions & 5 deletions

File tree

.github/workflows/lighthouse.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ jobs:
5151
JEKYLL_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5252

5353
- name: Run Lighthouse CI
54-
run: npx lhci autorun
54+
run: npx @lhci/cli@0.7.x autorun
5555
env:
5656
JEKYLL_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5757
LHCI_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

docs/_guide/actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ data-action: Fires all of these methods depending on the event
9494
data-action="
9595
click:hello-world#greetSomeone
9696
click:analytics-tracking#click
97-
hover:analytics-tracking#hover
97+
mouseover:analytics-tracking#hover
9898
"
9999
>
100100
Greet Someone

docs/_guide/introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ GitHub's first page interactions were written using jQuery, which was widely use
1111

1212
Rather than moving to entirely new paradigms, GitHub continued to use the same concepts within jQuery. Event Delegation was still heavily used, as well as querySelector. The event delegation concept was also extended to "element delegation" - discovering when Elements were added to the DOM, using the [Selector Observer](https://github.com/josh/selector-observer) library.
1313

14-
From this emerged a set of patterns which were reduced down to their first principles. _Observing_ elements on the page, _listening_ to the events these elements or their children emit, and _querying_ the children of an element to mutate or extend them.
14+
These patterns were reduced to first principles: _Observing_ elements on the page, _listening_ to the events these elements or their children emit, and _querying_ the children of an element to mutate or extend them.
1515

1616
The Web Systems team at GitHub explored other tools that adopt these set of patterns and principles. The closest match to those goals was [Stimulus](https://stimulusjs.org/) (from which Catalyst is heavily inspired), but ultimately the desire to leverage technology that engineers at GitHub were already familiar with was the motivation to create Catalyst.
1717

1818
## Three core concepts: Observe, Listen, Query
1919

2020
Catalyst takes these three core concepts and delivers them in the lightest possible way they can be delivered.
2121

22-
- **Observability** Catalyst solves observability by leveraging [Custom Elements](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements). Custom Elements are given unique names within a system, and the browser will automatically use the Custom Element registry to observe these Elements entering and leaving the DOM. Read more about this in the Guide Section entitled [Custom Elements]({{ site.baseurl }}/guide/your-first-component).
22+
- **Observability** Catalyst solves observability by leveraging [Custom Elements](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements). Custom Elements are given unique names within a system, and the browser will automatically use the Custom Element registry to observe these Elements entering and leaving the DOM. Read more about this in the Guide Section entitled [Your First Component]({{ site.baseurl }}/guide/your-first-component).
2323

2424
- **Listening** Event Delegation makes a great deal of sense when observing events "high up the tree" - registering global event listeners on the Window element - but Custom Elements sit much closer to their children within the tree, and so Direct Event binding is preferred. Catalyst solves this by binding event listeners to any descendants with `data-action` attributes. Read more about this in the Guide Section entitled [Actions]({{ site.baseurl }}/guide/actions).
2525

lighthouserc.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
"ci": {
33
"collect": {
44
"url": ["http://localhost:4000/?prefers-color-scheme=light", "http://localhost:4000/?prefers-color-scheme=dark"],
5-
"startServerCommand": "cd docs && bundle exec jekyll serve"
5+
"startServerCommand": "cd docs && bundle exec jekyll serve",
6+
"startServerReadyPattern": "Server running..."
67
},
78
"assert": {
89
"preset": "lighthouse:no-pwa",

0 commit comments

Comments
 (0)