morbidick / bootstrap-webcomponents Goto Github PK

let's create one of those fancy standalone doc pages

Requirements (similar to what webcomponents.org provides)

• jsdoc (with inline markdown)
• separate markdown pages
• inline demos
• static page (no hard requirement but would be nice for hosting reasons)

Options

• docz - looks really nice, but so far only react support
• docma - looks nice but seems to be focused on api docs, no inline demos
• vuepress - not that static, no inline demos
• jsdoc3 - maybe with the tui theme, no inline demo

the inline demos could be done with the iron-demo-helpers or code-demo similar to the current demo

currently all elements are prefixed with bs, after getting some feedback on slack there might be better alternatives. Maybe bwc analog to the mwc elements? Looking for more ideas :)

we should find a way to stop repeating code for attribute reflection and change notifications, possible solutions so far:

• use an alternative base class (moleculeJS, kenchris)
• stay with LitElement but include the necessary mixins from polymer3
• write and maintain our own lit-html based base class

i'ld prefer the first solution with a community supported base, any opinions?

Add (or link to) more complex elements an app could need in bootstrap design

• date-picker
• data-table
• input field with autocomplete

A list of all Elements that should be available:

• Alerts
• Badge
• Breadcrumb
• Buttons
• Button group
• Card
• Carousel
• Collapse
• Dropdowns
• Forms
• Input group
• Jumbotron
• List group
• Modal
• Navs
• Navbar
• Pagination
• Popovers
• Progress
• Tooltips