Skip to content

Tags: rmnv/react-styleguidist

Tags

v7.2.3

Toggle v7.2.3's commit message
Fix: Make slot components overridable (styleguidist#1087)

Fixes styleguidist#1070

v7.2.2

Toggle v7.2.2's commit message
Fix: Fix preview of method optional argument, JSDoc param and return …

…synonyms (styleguidist#1046)

Read 'param', 'arg', 'argument' JSDoc tags for method params, and 'return', 'returns' for method return value.

v7.2.1

Toggle v7.2.1's commit message
Fix: Fix section name regression

Fixes styleguidist#1078

v7.2.0

Toggle v7.2.0's commit message
Changelog: 🚀

## New features

* Add custom component display names ([styleguidist#933](styleguidist#933))

```
module.exports = {
  updateDocs(docs) {
    if (docs && docs.displayName) {
      docs.visibleName = docs.displayName.toLowerCase()
    }
    return docs
  }
}
```

* Made the mounting point id configurable. ([styleguidist#1050](styleguidist#1050))

## Bug fixes

* Cypress failing test ([styleguidist#1077](styleguidist#1077))

v7.1.3

Toggle v7.1.3's commit message
Fix: More bullet proof styles

max-width and background on body shouldn't break layout.

v7.1.2

Toggle v7.1.2's commit message
Fix: Restore support for evalInContext for custom slots (styleguidist…

…#1068)

Fixes styleguidist#1067

v7.1.1

Toggle v7.1.1's commit message
Fix: Add explicit recast dependency (styleguidist#1062)

Because react-docgen-displayname-handler has it as a peer dependency

Closes styleguidist#1061

v7.1.0

Toggle v7.1.0's commit message
Changelog: 🚀

## New features

### Updated page per section option

New options that you can use in sections:

* `sectionDepth` — Number of subsections with single pages, only available with pagePerSection is enabled.
* `exampleMode` — Initial state of the code example tab
* `usageMode` — Initial state of the props and methods tab

```
{
  name: 'UI Components',	       name: 'UI Components',
  content: 'docs/ui.md',	       content: 'docs/ui.md',
  components: 'lib/components/ui/*.js',
+  sectionDepth: 2,
+  exampleMode: 'expand', // 'hide' | 'collapse' | 'expand'
+  usageMode: 'expand' // 'hide' | 'collapse' | 'expand'
}
```

`showCode` and `showUsage` options are deprecated and will be removed in the next major release.

(styleguidist#1040 by @rafaesc)

### Command-line argument to open a browser on start

Run `npx styleguidist server --open` to run Styleguidist dev server and open it in the default browser.

(styleguidist#932 by @rubenmoya)

### Version number in sidebar

You can show a version number in the sidebar of your style guide (disabled by default) like this:

```js
const { version } = require('./package')
module.exports = {
	components: 'src/components/**/[A-Z]*.js',
	version
}
```

![](https://d3vv6lp55qjaqc.cloudfront.net/items/1T1w250l0N2l15301o3A/Image%202018-07-14%20at%207.35.48%20PM.png)

(styleguidist#1043 by @eemeli)

### Glob patterns in arrays and functions in `components` option

`components` option (global one or inside a section) can now accept an array of glob pattern strings, or a function returning glob pattern strings:

```js
{
  components: [
    'src/components/forms/**/[A-Z]*.js',
    'src/components/typography/**/[A-Z]*.js'
  ]
}
```

(styleguidist#1033 by @wkillerud)

## Bug fixes

* Better Flow union props rendering ([styleguidist#1035](styleguidist#1035))
* Inherit `font` and `font-weight` from body
* Isolate CodeMirror styles ([styleguidist#1049](styleguidist#1049)), closes [styleguidist#1047](styleguidist#1047)
* Lock react-docgen version to exactly 3.0.0-beta12 ([styleguidist#1041](styleguidist#1041))
* Remove support of deprecated React root container ID (app) ([styleguidist#1045](styleguidist#1045))

v7.0.20

Toggle v7.0.20's commit message
Fix: Keep deprecated headings strike-through on hover (styleguidist#1029

)

Fixes styleguidist#1026

v7.0.19

Toggle v7.0.19's commit message
Fix: Make h5 and h6 in Markdown look different from the body text (st…

…yleguidist#1024)