Skip to content

Commit b61a1b8

Browse files
authored
Merge branch 'master' into docs-prefix-all-links-with-the-baseurl
2 parents 323db69 + 3caf876 commit b61a1b8

3 files changed

Lines changed: 22 additions & 2 deletions

File tree

docs/_guide/decorators.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
chapter: 3
2+
chapter: 4
33
subtitle: Using TypeScript for ergonomics
44
---
55

docs/_guide/you-will-need.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
chapter: 2
3+
subtitle: How to install and set up Catalyst
4+
---
5+
6+
Catalyst is available as an npm module `@github/catalyst`. To install into your project, use the command `npm install @github/catalyst`.
7+
8+
### TypeScript
9+
10+
Catalyst has no strict dependencies, but it relies on TypeScript for decorator support, so you should also configure your project to use TypeScript. [Read the TypeScript docs on how to set up TypeScript on a new project](https://www.typescriptlang.org/docs/home.html).
11+
12+
### Polyfills
13+
14+
Catalyst uses modern browser standards, and so requires evergreen browsers or may require polyfilling native functionality in older browsers. You'll need to ensure the following features are available:
15+
16+
- [`toggleAttribute`](https://caniuse.com/#search=toggleAttribute). [`mdn-polyfills`](https://github.com/msn0/mdn-polyfills) or [`dom4`](https://github.com/WebReflection/dom4) libraries can polyfill this.
17+
- [`window.customElements`](https://caniuse.com/#search=customElements). [`@webcomponents/custom-elements`](https://github.com/webcomponents/polyfills/tree/master/packages/custom-elements) can polyfill this.
18+
- [`MutationObserver`](https://caniuse.com/#search=MutationObserver). [`mutation-observer`](https://github.com/webmodules/mutation-observer) can polyfill this.
19+
20+
Please note this list may increase over time. Catalyst will never ship with polyfills that add missing browser functionality, but will continue to use the latest Web Standards, and so may require more polyfills as new releases come out.

docs/_guide/your-first-component.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
subtitle: Building an HTMLElement
3-
chapter: 2
3+
chapter: 3
44
---
55

66
### Catalyst's `@controller` decorator

0 commit comments

Comments
 (0)