Replies: 3 comments 11 replies
-
|
Thanks for your documentation feedback. cc @jonniebigodes @ThibaudAV @kroeder I don't know the history behind calling the inputs It's not enough, but there are some basic Angular MDX examples here:
As for the documentation, Storybook is a large project and we're still filling in snippets for different frameworks/scenarios. If you can help improve the documentation via PRs, this would help future users avoid the frustrations you just faced. Storybook is a community-driven project and we rely on our users to help us get good coverage over the various frameworks and scenarios it supports. |
Beta Was this translation helpful? Give feedback.
-
I am also wondering about this. I find that it is not clear 'props' from an angular point of view. The default of |
Beta Was this translation helpful? Give feedback.
-
|
Anyone find a way to display an angular component in mdx file without creating a story ? |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Is your feature request related to a problem? Please describe
The docs are not very clear on how to use/place Angular components inside of a mdx file. IMO the docs are the biggest flaw of Storybook at the moment and took me hours and hours and a lot of frustration already. I often end up figuring things out by accident.
The mdx documentation is even for React, not Angular? https://storybook.js.org/docs/angular/writing-docs/mdx
On the other hand (randomly again!) I found that here is a Angular documentation: https://github.com/storybookjs/storybook/tree/master/addons/docs/angular But why is that not part of the actual Angular docs?
I would like to have a Story that is generated by a mdx file that contains multiple components, e.g. here I have 3 components:
That is not really documented. First I tried to put in just one component:
or is it?
If I guess the documentation right it is the second approach but my component also depends on other services / a shared module. If I read the docs right importing it can be done like in ts files:
But then I get:
Found randomly this documentation that shows something like this for Angular:
But I dont want a story I just want to place components inside a mdx file. Btw I wonder why the inputs are called
props. If I would have never worked with React I would never know that this are the inputs.If I could get past placing a component in a mdx file my next question would be how to add multiple components as this seems to be no array:
Additional context
Other things I struggled with with the documentation:
<Canvas>is not documented but I was looking exactly for that: Story without a component / just html #13783isColumn,columnsare not documented but I was looking exactly for that<img src="">or you cant use some attributes<div class="">. This things should be pointed out when speaking about MDX files, just a sentence like "Watch out: JSX files have some characteristics, find out more about JSX -here-"Beta Was this translation helpful? Give feedback.
All reactions