Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Properly document components #348

Closed
dfreedm opened this issue Aug 6, 2019 · 5 comments
Closed

Properly document components #348

dfreedm opened this issue Aug 6, 2019 · 5 comments
Assignees
@dfreedm @e111077
Labels
Type: Feature New feature or request

Comments

@dfreedm
Copy link
Collaborator

dfreedm commented Aug 6, 2019

The stub README's are not good enough anymore 😜
@dfreedm dfreedm self-assigned this Aug 6, 2019
This was referenced Aug 9, 2019
Merged
Merged
@dfreedm dfreedm mentioned this issue Aug 14, 2019
Closed
dfreedm added a commit that referenced this issue Aug 14, 2019
@dfreedm
Better readme for button
93638d6 
Related #348
@dfreedm dfreedm mentioned this issue Aug 14, 2019
Merged
@aomarks aomarks added Area: docs Type: Feature New feature or request labels Aug 14, 2019
@aomarks aomarks mentioned this issue Aug 14, 2019
Closed
@aomarks
Copy link
Contributor

aomarks commented Aug 14, 2019

From @samuelli in #325 (I closed as dupe of this one):

Examples of incorrectness:

import {Switch} from "@material/mwc-tab-bar"
Examples of not very useful:

<mwc-tab-bar>sentiment_very_satisfied</mwc-tab-bar> should show usage with tabs
Examples of undocumented quirks:

Use of icon property does not work without importing mwc-icon separately.
Examples of missing docs:

Events - digging through typings/code is not particularly feasible. For example, even after looking at the relevant code, it's difficult to find the event name. See https://github.com/material-components/material-components-web-components/blob/master/packages/tab-bar/src/mwc-tab-bar-base.ts#L148 which is defined as a string constant

This was referenced Aug 14, 2019
Closed
Closed
@aomarks
Copy link
Contributor

aomarks commented Aug 14, 2019 •
edited by dfreedm
Loading

Checklist!

  • button
  • checkbox
  • dialog
  • drawer
  • fab
  • formfield
  • icon
  • icon-button
  • icon-button-toggle
  • linear-progress
  • radio
  • ripple
  • slider
  • snackbar
  • switch
  • tab
  • textarea
  • textfield
  • top-app-bar

dfreedm added a commit that referenced this issue Aug 15, 2019
@dfreedm
Split icon button toggling into its own component
24b165a 
- This makes the non-togging case more lightweight
- `<mwc-icon-button>` for non-toggling use cases remains the same
- For toggling, use `<mwc-icon-button-toggle>`
  - `icon` is now `onIcon`

Related to #348
@dfreedm dfreedm mentioned this issue Aug 15, 2019
Merged
dfreedm added a commit that referenced this issue Aug 15, 2019
@dfreedm
Split icon button toggling into its own component
c580ebe 
- This makes the non-togging case more lightweight
- `<mwc-icon-button>` for non-toggling use cases remains the same
- For toggling, use `<mwc-icon-button-toggle>`
  - `icon` is now `onIcon`

Related to #348
@aomarks aomarks mentioned this issue Aug 16, 2019
Merged
@orneryd
Copy link

orneryd commented Aug 22, 2019 •
edited by aomarks
Loading

Checklist!

  • button
  • checkbox
  • drawer
  • fab
  • formfield
  • icon
  • icon-button
  • icon-button-toggle
  • linear-progress
  • radio
  • ripple
  • slider
  • snackbar
  • switch
  • tab
  • top-app-bar
  • textarea
  • textfield

I'm disappointed that these are not in material web components 😜

@jsilvermist
Copy link

jsilvermist commented Aug 22, 2019 •
edited
Loading

@orneryd FTFY ;) https://mcwc-checklist.glitch.me/

MCWC-Checklist

@aomarks aomarks mentioned this issue Sep 3, 2019
Closed
@e111077 e111077 added this to the Sept 17 - Oct 1 milestone Sep 27, 2019
@jbingham jbingham removed this from the Sept 17 - Oct 1 milestone Oct 14, 2019
polymer-github-robot pushed a commit that referenced this issue Oct 20, 2019
@aomarks @copybara-github
Documentation for mwc-checkbox
86e32d3 
#348

PiperOrigin-RevId: 275670130
polymer-github-robot pushed a commit that referenced this issue Oct 20, 2019
@aomarks @copybara-github
Documentation for mwc-checkbox
6d38a8d 
#348

PiperOrigin-RevId: 275670130
polymer-github-robot pushed a commit that referenced this issue Oct 20, 2019
@aomarks @copybara-github
Documentation for mwc-checkbox
84e032f 
#348

PiperOrigin-RevId: 275670130
polymer-github-robot pushed a commit that referenced this issue Oct 20, 2019
@aomarks @copybara-github
Documentation for mwc-checkbox
993ce8c 
#348

PiperOrigin-RevId: 275676352
@dfreedm dfreedm mentioned this issue Oct 22, 2019
Merged
@e111077 e111077 mentioned this issue Oct 22, 2019
Merged
@dfreedm
Copy link
Collaborator Author

dfreedm commented Dec 9, 2019

I believe we've separated all the individual components into their own issues, so I think we can close this master issue.

@dfreedm dfreedm closed this as completed Dec 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dfreedm dfreedm

@e111077 e111077

Labels
Type: Feature New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@dfreedm @aomarks @jbingham @orneryd @e111077 @jsilvermist