styleguidist/react-styleguidist

Custom CSS can break Styleguidist's styles

Open

#1,356 opened on May 7, 2019

View on GitHub
 (2 comments) (2 reactions) (0 assignees)TypeScript (1,416 forks)github user discovery
help wanted

Repository metrics

Stars
 (11,091 stars)
PR merge metrics
 (PR metrics pending)

Description

Current behavior

requiring a custom CSS in the config can break Styleguidist's styles. In my case the CSS is semantic-ui and the Styleguidist styles are section headers and bodies. Would there be a way to fix this? I imagine quite some scenarios require using a custom CSS.

This is getting into feature request territory and I'm really just guessing about stuff I know very little about, but since Styleguidist is already using JSS, maybe applying a CSS reset specifically to Styleguidist components would work? Or putting examples in iframes?

To reproduce

https://github.com/andrewpeterprifer/example

Expected behavior

Styleguidist styles should be preserved.

Contributor guide

Research direction
Investigate how custom CSS is loaded and how it overrides Styleguidist's JSS styles. Consider scoping Styleguidist components or using CSS modules/iframes to prevent conflicts.
Tech stack
typescriptreact
Domain
frontend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
CSSReact
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40