react-styleguidist VS styled-jsx

As a development server, we can use an actual development server of our app, like Create React App (that we use for the examples) or Vite, or another tool like React Styleguidist or Storybook, to test isolated components.

react-styleguidist

My most popular open source project, React Styleguidist, has over 10K stars on GitHub, and yet, I couldn’t manage to build a community around it, and to make it self-sufficient. The project is too big for one person to build it, and to manage issues and pull requests.

React Styleguidist is a tool that generates a living style guide for React components. This tool helps developers to document and showcase their components, making it easier for other developers to understand and use them. You can visit its official website to learn more: https://react-styleguidist.js.org/.

Because documentation is so important, our sample project has been preconfigured with React Styleguidist, a development environment for building React components. We’ll use this tool to document the components as we build them out.

Today I had to present my work on a React Native app for the last 2 months in a meeting in front of the CEO. He was pleased with my work the only critique was more comments and documentation. Afterward my immediate supervisor told me to look up "Documentation Style Guides". He said he's not concerned which pattern I chose just learn one and stick with it. After searching I found this https://react-styleguidist.js.org/documenting which seems to address what I'm looking for. I just figured I would ask if anyone else out there has experience with a certain approach and has good documentation/tutorials to learn such an approach. Thanks in advance!

Checkout React Styleguidist by Clicking here

For many years I was enjoying working on my open source projects of all sizes: large like React Styleguidist or a tiny library that nobody else is using. However, the expectation that you owe someone free work to fix bugs in their projects and add features they need to do their job, the rude comments on the issues, the hit and run pull requests where you spend an hour reviewing the code and the author never comes back to answer your comments, made it less and less enjoyable, and my attempts to pretend that it doesn’t hurt my mental health became less and less successful.

This is yet another tool that offers an interactive way of creating and sharing UI components. And there’s no better representation of how React Styleguidist works than this GIF. On the right window, you have the code. The left window is where that code is concurrently rendered into a UI. And if required, you can also test and directly edit the code on the rendered side.

You can play with these examples along with my other components in this library directly within the documentation, which was generated using React Styleguidist.

You'd rather use this over tailwind? Na...

styled-jsx -> A library with a lot of similar features like styled-components. Has some extra features here and there.

This isn't a new idea. CSS in JS is obviously a thing, but that usually implies having component code with CSS right alongside it in some sort of JS based syntax. There's also JSS which is a library for writing CSS with JS.

The CSS we'll use for the Gantt chart is included in the starter code. We've used Styled JSX, which comes with Next.js, to write scoped-styled components. There are some global styles in styles/globals.js. These global styles are added to our app in the Layout component in the components folder. The entire app is wrapped in this Layout component in the _app.js file, which is in the pages folder.

Styled JSX is what we're using at work right now, since we're using Next.js and it comes with this out of the box. We're actually using both SCSS modules for static styles and Styled JSX for dynamic styles. It's been great so far.

// schema.json { "$schema": "http://json-schema.org/schema", "cli": "nx", "$id": "ReactLibrary", "title": "", "type": "object", "properties": { "name": { "type": "string", "description": "Library name", "$default": { "$source": "argv", "index": 0 }, "x-prompt": "What name would you like to use for the library?", "pattern": "^[a-zA-Z].*$" }, "directory": { "type": "string", "description": "A directory where the lib is placed.", "alias": "dir" }, "domain": { "description": "Domain where this library belongs.", "type": "string", "default": "none", "alias": "dom", "x-prompt": { "message": "Which domain this library belongs?", "type": "list", "items": [ { "value": "web", "label": "Web" }, { "value": "common", "label": "Common" } ] } }, "scope": { "type": "string", "description": "A scope for the lib.", "alias": "sc" }, "type": { "description": "Library type", "type": "string", "alias": "t", "x-prompt": { "message": "Select library type?", "type": "list", "items": [ { "value": "data", "label": "Data" }, { "value": "model", "label": "Model" }, { "value": "util", "label": "Util" }, { "value": "feature", "label": "Feature" }, { "value": "ui", "label": "Ui" } ] } }, "style": { "description": "The file extension to be used for style files.", "type": "string", "default": "none", "alias": "s", "x-prompt": { "message": "Which stylesheet format would you like to use?", "type": "list", "items": [ { "value": "css", "label": "CSS" }, { "value": "scss", "label": "SASS(.scss) [ http://sass-lang.com ]" }, { "value": "styl", "label": "Stylus(.styl) [ http://stylus-lang.com ]" }, { "value": "less", "label": "LESS [ http://lesscss.org ]" }, { "value": "styled-components", "label": "styled-components [ https://styled-components.com ]" }, { "value": "@emotion/styled", "label": "emotion [ https://emotion.sh ]" }, { "value": "styled-jsx", "label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]" }, { "value": "none", "label": "None" } ] } }, "linter": { "description": "The tool to use for running lint checks.", "type": "string", "enum": ["eslint", "tslint"], "default": "eslint" }, "unitTestRunner": { "type": "string", "enum": ["jest", "none"], "description": "Test runner to use for unit tests.", "default": "jest" }, "skipFormat": { "description": "Skip formatting files.", "type": "boolean", "default": false }, "skipTsConfig": { "type": "boolean", "default": false, "description": "Do not update `tsconfig.json` for development experience." }, "pascalCaseFiles": { "type": "boolean", "description": "Use pascal case component file name (e.g. `App.tsx`).", "alias": "P", "default": false }, "routing": { "type": "boolean", "description": "Generate library with routes." }, "appProject": { "type": "string", "description": "The application project to add the library route to.", "alias": "a" }, "publishable": { "type": "boolean", "description": "Create a publishable library." }, "buildable": { "type": "boolean", "default": false, "description": "Generate a buildable library." }, "importPath": { "type": "string", "description": "The library name used to import it, like `@myorg/my-awesome-lib`." }, "component": { "type": "boolean", "description": "Generate a default component.", "default": true }, "js": { "type": "boolean", "description": "Generate JavaScript files rather than TypeScript files.", "default": false }, "globalCss": { "type": "boolean", "description": "When `true`, the stylesheet is generated using global CSS instead of CSS modules (e.g. file is `*.css` rather than `*.module.css`).", "default": false }, "strict": { "type": "boolean", "description": "Whether to enable tsconfig strict mode or not.", "default": true }, "setParserOptionsProject": { "type": "boolean", "description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.", "default": false }, "standaloneConfig": { "description": "Split the project configuration into `/project.json` rather than including it inside `workspace.json`.", "type": "boolean" }, "compiler": { "type": "string", "enum": ["babel", "swc"], "default": "swc", "description": "Which compiler to use." } }, "required": ["name", "type", "scope", "domain"] }

The previous three methods covered the best styling options if you prefer Utility CSS. But perhaps you are more of a CSS-in-JS kind of person. In which case, Styled-JSX might be up your alley.