Questions tagged [react-styleguidist]

React Styleguidist is a component development environment with hot reloaded dev server and a living style guide that you can share with your team. It lists component `propTypes` and shows live, editable usage examples based on Markdown files.

React Styleguidist is a component development environment with hot reloaded dev server and a living style guide that you can share with your team. It lists component propTypes and shows live, editable usage examples based on Markdown files.

85 questions
0
votes
1 answer

How to format my code example with vue-styleguidist?

I want to use vue-styleguidist to document my components. Decided to start with a spinner. A preview of the component is displayed properly but the code example is not formatted as I expected (check https://vue-styleguidist.github.io/basic/#button…
Anastasiia
  • 21
  • 4
0
votes
1 answer

Styleguidist not working correctly with ReactDOM.render()

I am working on a website and I am considering using styleguidist as the solution for our documentation. However, if I try to make documentation for components rendered with ReactDOM.render(), styleguidist ends up with "Compiled successfully!" but…
0
votes
0 answers

React Styleguide with React Router

I am extending a react library that uses react-styleguidist as web-documentation (see https://react-ui.geops.de/). The base URL renders the component guide. I would like to add a path /theme that renders a completely different component (a demo…
danji_ma90
  • 89
  • 8
0
votes
1 answer

On starting Styleguidedist server it fails with Module parse failed: Unexpected token

Im trying to start my style guide server but it keeps throwing following error: I believe this occurs when the babel loaders are not configured for jsx files. But this isnt true as I am able to start my project without errors. But when I try to…
Vinayak humberi
  • 191
  • 3
  • 8
0
votes
0 answers

vue-styleguidist can not build documentation since V4.0.3

I'm trying to migrate to the last vue-styleguidist but since v4.0.0 i can't. With the 3.26.2 it's working fine. I have this error : (node:11764) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing…
0
votes
1 answer

react-styleguidist - example with Component as a prop - SyntaxError: Cannot use import statement outside a module

I have a component that has props that are components. Component example: ```jsx import FavoriteBorder from '@material-ui/icons/FavoriteBorder' import Favorite from '@material-ui/icons/Favorite' return (
Jamie Hutber
  • 26,790
  • 46
  • 179
  • 291
0
votes
2 answers

how to pass props into a component in Readme.md file in react styleguidist?

I need to display the react component in the readme.md file but it requires props which has array of strings. What is the correct way of passing props for components defined in the .md file? I have tried to refer to the example which is in the…
Sumudu P
  • 3
  • 3
0
votes
1 answer

React: make boxes same size even with different content

I have written a website which you can see here: https://konekto.world/ After the onboarding you will notice that the size of the nearly white outer box is different on every screen (especially at https://konekto.world/emergency_details). I want to…
pythonlearner
  • 57
  • 2
  • 11
0
votes
2 answers

Styleguidist with Ant Design: components do not look like supposed

I´m using a regular react styleguidist and tried to use it with ant design. But the components are not looking like they are supposed to. I installed antd in the project also. Project Screenshot I have not really a clue what could be the mistake?
wellos2
  • 23
  • 4
0
votes
1 answer

How to correctly build a package so that suggestions/autocomplete work in intellij when this private styleguidist packages is used in another project

I made my own style guide using react-styleguidist and typescript. Now after building the node package (private) and importing (npm install) it into my other project (where I want to use my style guide components) I am not able to get intellij…
0
votes
0 answers

How to forbid react-styleguidist to run the code block in the md file?

In the md file, I don't want react-styleguidist to run a code block. I just want to show this code source. But now it occurs an error. I don't want the code block(const dialog = Modal.show(config);...) to run with react-styleguidist. I just want it…
Pei Li
  • 33
  • 1
  • 1
  • 6
0
votes
1 answer

React styleguidist error with create react app

I am trying to add React Styleguidist to my project and am getting an "Unexpected token" compiler error. I am using the Create react app to create the project. After it didn't work I created a new project and continue to get the same error when…
Sean Lynch
  • 1,604
  • 19
  • 29
0
votes
1 answer

Next.js with Styleguidist and Fela (React)

Have anybody managed to setup next.js with Fela and Styleguidist? Styleguidist needs Next.js webpack configuration, however I cant just link it as mentioned here: https://react-styleguidist.js.org/docs/webpack.html I am using this example app:…
kube23
  • 11
  • 4
0
votes
2 answers

Dynamic examples in react-styleguidist

all. I just started using react-styleguidist and am loving the ease of use. However, I would like to add dynamic examples to the documentation. i.e. examples that a viewer of the docs can interact with by changing the props via buttons, events, and…
user3828000
  • 101
  • 1
  • 10
0
votes
1 answer

Adding custom styles to the react-styleguidist library

I'm trying to create project documentation using the react-styleguidist library. However, I have a problem. Well, in the project I did reset the unit rem to use multiples of 10px, not 16px. Everything works great, but I did it at the root of the…
Dan Zawadzki
  • 682
  • 2
  • 8
  • 28