Support ES6 exports #820
Comments
|
Yeah I thought the response to #633 was a little flat. A lot of developers use only named exports for a bunch of reasons. Without this I need to hack styleguidist to make it usable. |
|
@marcdavi-es Well if you're in a hurry, you can get around it with const Button = require('./dist/Components/Button').Button;But it's very error prone. |
|
@seivan thanks :). I had a dig around to try a more robust solution. I'm a bit puzzled by what I found. Given this set up... // styleguide.config.js
module.exports = {
components: 'path/to/component.js',
};
// path/to/component.js
import React from 'react';
export const SomeComponent = () => <div>Hello, I'm SomeComponent</div>;
// path/to/Readme.md
```js
console.log(SomeComponent);
```...I see in the console That suggests that the exports of In this case, the following 'works'... // path/to/Readme.md
```js
<SomeComponent.SomeComponent />
```...which seems odd. Perhaps I'm missing something obvious here. If a contributor is looking at this, I'm super happy to work on a potential fix. I could do with some help pointing to where the modules are exposed though. So far I've had a dig around UPDATEI've just realised that it's probably Looking into UPDATEOpened PR #825 adding limited support for named exports 🤞 |
|
@marcdavi-es I just tested your idea, and as you said, it worked. |
|
any update on this? |
👋 **[Support Styleguidist](https://opencollective.com/styleguidist) on Open Collective** 👋 ## New features ### Page per section 🚧 This is a huge improvement for large style guides: now you can show only one component at a page instead of all components.  To enable: ```js module.exports = { pagePerSection: true }; ``` This is an experimental feature and we need your feedback to make it better and really useful. For example, right now there’s no isolated mode. So feel free to share your ideas [in issues](https://github.com/styleguidist/react-styleguidist/issues). (#835 by @bitionaire and @stepancar, closes #494 and #768) ### “Fork me” ribbon One more step to make Styleguidist usable for documenting open source projects:  New config option to enable the ribbon, define the URL and change the label: ```js module.exports = { ribbon: { url: 'http://example.com/', text: 'Fork me on GitHub' } }; ``` And two new [theme variables](https://github.com/styleguidist/react-styleguidist/blob/master/src/styles/theme.js) to change colors: `color.ribbonBackground` and `color.ribbonText`. (#861 by @glebez and @wkwiatek, part of #195, closes #647) ### Options to change CLI output on server start and build Two new options, `printServerInstructions` and `printBuildInstructions`: ```js module.exports = { printBuildInstructions(config) { console.log( `Style guide published to ${ config.styleguideDir }. Something else interesting.` ); } }; ``` (#878 by @roblevintennis, closes #876) ### Option to modify props A new option, `updateDocs` to modify props before rendering. For example, you can load a component version number from a JSON file: ```js module.exports = { updateDocs(docs) { if (docs.doclets.version) { const versionFilePath = path.resolve( path.dirname(file), docs.doclets.version ); const version = require(versionFilePath).version; docs.doclets.version = version; docs.tags.version[0].description = version; } return docs; } }; ``` (#868 by @ryanoglesby08) ### Limited support for named exports Styleguidist used to require default exports for components. Now you can use named exports too, though Styleguidist still supports only one component per file. I hope this change will make some users happier, see more details [in the docs](https://react-styleguidist.js.org/docs/components.html#loading-and-exposing-components). (#825 by @marcdavi-es, closes #820 and #633) ### Allow arrays of component paths in sections More flexibility in structuring your style guide: ```js module.exports = { sections: [ { name: 'Forms', components: [ 'lib/components/ui/Button.js', 'lib/components/ui/Input.js' ] } ] }; ``` (#794 by @glebez, closes #774) ### Sort properties by `required` and `name` attributes This change should make props tables more predictable for the users. Instead of relying on developers to sort props in a meaningful way, Styleguidist will show required props first, and sort props in each group alphabetically. To disable sorting, use the identity function: ```javascript module.exports = { sortProps: props => props }; ``` (#784 by @dotcs) ## Bug fixes * Allow `Immutable` state in examples (#870 by @nicoffee, closes #864) * Change template container ID to prevent clashes (#859 by @glebez, closes #753) * Better props definitions with Flow types (#781 by @nanot1m)
|
🎉 This issue has been resolved in version 6.5.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
I see this issue was closed without any comments and also locked #633
Is there a reason only default exports are allowed and not named exports?
We're in a position to rely on ES6 exports to allow tree shaking and would rather not use default exports.
I was wondering if there is any wiggle room here or if you stand strong on this?
The text was updated successfully, but these errors were encountered: