Skip to content
This repository has been archived by the owner on Aug 5, 2021. It is now read-only.

As a developer I would like documentation on how to create a Web Component #48

Open
1 of 6 tasks
thescientist13 opened this issue Aug 16, 2018 · 4 comments
Open
1 of 6 tasks
Labels
documentation Documentation for the wiki help wanted Extra attention is needed
Milestone

Comments

@thescientist13
Copy link
Member

Type of Change

  • New Feature Request
  • Documentation
  • Future Spec
  • Improvement / Suggestion
  • Bug
  • Other (please clarify below)

Summary

Some documentation on how to create a component. Topics to cover (link out where appropriate to keep it DRY):

  • event handling (Custom Events)
  • data binding
  • props / state
  • attributes / properties
  • Shadow DOM
  • custom elements
  • sub classing (LitElement, HTMLElement)
  • how to design a good component API

Use Case

Developers looking to create their first web component.

Code Sample

N / A

Pros / Cons

No cons, other than the usual risk with documentation that it can get out dated easily.

@thescientist13 thescientist13 added help wanted Extra attention is needed documentation Documentation for the wiki labels Aug 16, 2018
@thescientist13 thescientist13 added this to the Beta milestone Aug 16, 2018
@thescientist13 thescientist13 changed the title As a developer I would like documentation on how to create a web component As a developer I would like documentation on how to create a Web Component Aug 16, 2018
@thescientist13
Copy link
Member Author

thescientist13 commented Sep 1, 2018

@thescientist13
Copy link
Member Author

Provide documentation here?
lit/lit-element#37

@thescientist13
Copy link
Member Author

@hutchgrant
You may be interested in this issue.

@hutchgrant
Copy link
Member

Added a basic hello world style guide. The topics you want covered should perhaps be on separate pages with separate examples.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Documentation for the wiki help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants