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

Addon-docs: Props / Description for web-components #8585

Merged
merged 11 commits into from
Oct 27, 2019
Merged

Addon-docs: Props / Description for web-components #8585

merged 11 commits into from
Oct 27, 2019

Conversation

daKmoR
Copy link
Contributor

@daKmoR daKmoR commented Oct 27, 2019 •
edited
Loading

Issue:

What I did

  • Use MetaData from custom-elements.json
  • Show props table in docs mode for web-components
  • Show description
  • Added to example

How to test

open kitchen sink docs mode

Still open

  • Document how to setup/use
  • Types are not shown?

=> if approach looks good I will add documentation for it 👍

as now.sh is currently having some trouble here is a screenshot how it will look like
Screenshot 2019-10-27 at 14 43 03

@vercel
Copy link

vercel bot commented Oct 27, 2019 •
edited
Loading

This pull request is being automatically deployed with ZEIT Now (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://zeit.co/storybook/monorepo/hk204nohr
🌍 Preview: https://monorepo-git-feat-docswebcomponentsprops.storybook.now.sh

@github-actions
Copy link
Contributor

Fails
🚫

PR is not labeled with one of: ["cleanup","doc-dependencies:update","BREAKING CHANGE","feature request","bug","documentation","maintenance","dependencies:update","dependencies","other"]

Generated by 🚫 dangerJS against 4a2ec47

@daKmoR daKmoR force-pushed the feat/docsWebComponentsProps branch from 4a2ec47 to f32d7c3 Compare October 27, 2019 12:32
@daKmoR daKmoR changed the title feat: props table for web-components WIP: feat: props table for web-components Oct 27, 2019
@daKmoR daKmoR force-pushed the feat/docsWebComponentsProps branch from f32d7c3 to 97a19ab Compare October 27, 2019 13:36
@daKmoR daKmoR force-pushed the feat/docsWebComponentsProps branch from 97a19ab to 7e3fce6 Compare October 27, 2019 13:58
@vercel vercel bot temporarily deployed to staging October 27, 2019 16:03 Inactive
@daKmoR daKmoR changed the title WIP: feat: props table for web-components feat: props table for web-components Oct 27, 2019
@daKmoR daKmoR force-pushed the feat/docsWebComponentsProps branch from 75c4316 to c6349f2 Compare October 27, 2019 16:06
@vercel vercel bot temporarily deployed to staging October 27, 2019 16:07 Inactive
@daKmoR daKmoR force-pushed the feat/docsWebComponentsProps branch from c6349f2 to 05bf22e Compare October 27, 2019 16:12
@daKmoR daKmoR force-pushed the feat/docsWebComponentsProps branch from 05bf22e to 6bfd548 Compare October 27, 2019 17:31
@vercel vercel bot temporarily deployed to staging October 27, 2019 17:31 Inactive
@vercel vercel bot temporarily deployed to staging October 27, 2019 18:11 Inactive
shilman
shilman approved these changes Oct 27, 2019
View reviewed changes
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SUPERB!!! 🏆

@vercel vercel bot temporarily deployed to staging October 27, 2019 18:37 Inactive
@shilman shilman changed the title feat: props table for web-components Addon-docs: Props table / Description for web-components Oct 27, 2019
@shilman shilman changed the title Addon-docs: Props table / Description for web-components Addon-docs: Props / Description for web-components Oct 27, 2019
@shilman shilman merged commit 1a9c92e into next Oct 27, 2019
@shilman shilman deleted the feat/docsWebComponentsProps branch October 27, 2019 19:04
@shilman shilman added this to the 5.3.0 milestone Oct 27, 2019
@shilman shilman mentioned this pull request Oct 28, 2019
Open
@alazurenko
Copy link
Contributor

@daKmoR Thank you for this contribution!
I was looking for solution to documentation props of web-components in storybook/docs!

I have a question regarding the way how this json is generated. Is it possible to automate this process of generation of properties?

@daKmoR
Copy link
Contributor Author

daKmoR commented Oct 29, 2019

@alazurenko it's documented in the addon-docs... maybe we should move that info to @storybook/web-components 🤔 and link it in addon-docs?

@alazurenko
Copy link
Contributor

alazurenko commented Oct 30, 2019 •
edited
Loading

@daKmoR
Maybe it was just me not paying much attention 🙂 Now it is way more clearer.

Thank you for help!

@beth-panx
Copy link
Contributor

Hello @daKmoR quick question for you - should properties be called 'props' for web components? 🤓

@daKmoR
Copy link
Contributor Author

daKmoR commented Jan 8, 2020

hmm properties would probably be better 🤔

care to create a PR and update it? 🤗

@beth-panx
Copy link
Contributor

beth-panx commented Jan 9, 2020 •
edited
Loading

Sure thing. PR is created here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shilman shilman shilman approved these changes

@alexandrebodin alexandrebodin Awaiting requested review from alexandrebodin

@alterx alterx Awaiting requested review from alterx

@igor-dv igor-dv Awaiting requested review from igor-dv

@leonrodenburg leonrodenburg Awaiting requested review from leonrodenburg

@ndelangen ndelangen Awaiting requested review from ndelangen

@theinterned theinterned Awaiting requested review from theinterned

@tmeasday tmeasday Awaiting requested review from tmeasday

Assignees
No one assigned
Labels
addon: docs feature request web-components
Projects
None yet
Milestone
5.3.0
Development

Successfully merging this pull request may close these issues.
4 participants
@daKmoR @alazurenko @beth-panx @shilman