@storybook/addon-info - npm Package Compare versions

Comparing version 3.2.7 to 3.2.9

package.json

 {
   "name": "@storybook/addon-info",
-  "version": "3.2.7",
+  "version": "3.2.9",
   "description": "A Storybook addon to show additional information for your stories.",
@@ -5,0 +5,0 @@ "license": "MIT",

README.md

@@ -44,3 +44,3 @@ # Storybook Info Addon
 
-`withInfo` can also take an options object in case you want to configure how
+`withInfo` can also take an [options object](#global-options) in case you want to configure how
 the info panel looks on a per-story basis:
@@ -54,6 +54,4 @@
     withInfo({
-      text: 'doc string about my component',
-      maxPropsIntoLine: 1,
-      maxPropObjectKeys: 10,
-      maxPropArrayLength: 10,
+      text: 'String or React Element with docs about my component', // Warning! This option's name will be likely renamed to "summary" in 3.3 release. Follow this PR #1501 for details
+      // other possible options see in Global options section below
     )(() =>
@@ -83,4 +81,10 @@ <Component>Click the "?" mark at top-right to view the info.</Component>
 setDefaults({
-  inline: true,
-  maxPropsIntoLine: 1,
+  header: false, // Toggles display of header with component name and description
+  inline: true, // Displays info inline vs click button to view
+  source: true, // Displays the source of story Component
+  propTables: [/* Components used in story */], // displays Prop Tables with this components
+  propTablesExclude: [], // Exclude Components from being shoun in Prop Tables section
+  styles: {}, // Overrides styles of addon
+  marksyConf: {}, // Overrides components used to display markdown. Warning! This option's name will be likely deprecated in favor to "components" with the same API in 3.3 release. Follow this PR #1501 for details
+  maxPropsIntoLine: 1, // Max props to display per line in source code
   maxPropObjectKeys: 10,
@@ -87,0 +91,0 @@ maxPropArrayLength: 10,

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

292490

increased by0.28%

Number of lines in readme file

187

increased by2.19%

No dependency changes