-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7a5d549
commit 07dfff8
Showing
2 changed files
with
85 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Docs and Guide Plan | ||
|
||
This folder exists to capture the current docs plans in a central place where changes to the plans can be reviewed in PRs. | ||
|
||
[Outline](./outline.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
# Docs Outline | ||
|
||
* What are web components | ||
* Custom Elements | ||
* Shadow DOM | ||
* Standard JS Modules | ||
* Why web components | ||
* What do we mean by interop? | ||
* Interop with HTML, frameworks, the browser | ||
* Interop with file formats: Markdown vs MDX, etc. | ||
* Interoperable composition with slots | ||
* Interop with the future | ||
* Use cases | ||
* Standalone components | ||
* Component sets and design systems | ||
* Applications | ||
* Related specs | ||
* MDN links | ||
* GitHub repos with proposals | ||
* What's left, ie. WCCG reports | ||
* Using web components | ||
* Basics | ||
* Definining, the custom element registry, and the single tag name scope | ||
* Upgrading, and `:defined` | ||
* Children and slots | ||
* Events | ||
* Using web components in HTML and vanilla JS | ||
* Styling | ||
* CSS Custom Properties | ||
* ::part()s | ||
* Using web components with frameworks | ||
* Using web components in... | ||
* Markdown (how to import in various systems) | ||
* WordPress | ||
* Writing web components | ||
* Defining | ||
* Custom element registries | ||
* Self-registering vs not | ||
* Defensive registration for special cases (CDN distribution) | ||
* Lifecycle | ||
* Basics: `observedAttributes`, `constructor`, `attributeChangedCallback`... | ||
* Cleaning up resources in `disconnectedCallback` | ||
* Shadow DOM | ||
* attachShadow() | ||
* open vs closed | ||
* Encapsulation: DOM, events, CSS | ||
* Just overview: more detail in Styling and Composition sections | ||
* Slots | ||
* Styling | ||
* Encapsulation (more detail than) | ||
* Shadow selectors: `:host`, `:host()`, and `::slotted()` | ||
* CSS Custom Properties | ||
* CSS Shadow Parts: `part` and `::part()` | ||
* Constructible style sheets | ||
* Theming | ||
* Strategies for deep styling | ||
* Dealing with data | ||
* Designing both a property & attribute API | ||
* Responding to attribute changes (`attributeChangedCallback`) | ||
* Responding to property changes (accessors) | ||
* Considerations about when to use methods | ||
* Reflecting between properties and attributes | ||
* Using events for data | ||
* Publishing to npm | ||
* Composition | ||
* Slots | ||
* Communicating with events | ||
* Using children | ||
* Accessibility | ||
* Forms | ||
* Web component libraries | ||
* Community Protocols | ||
* Community and Resources | ||
* FAQ | ||
* Myth-busting answers can go here | ||
* Can custom elements really only take strings? | ||
* Is it impossible to SSR web components? | ||
* Why don't web components solve ___ that other frameworks do? | ||
* ... | ||
* Demos and Playgrounds (standalone or to accompany each piece of content?) |