Release v3.1.0

Author: CarstenWickner

CHANGELOG.MD

@@ -4,7 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [3.1.0] - 2019-10-11
+### Changed
+- declare all dependencies as external to allow tree-shaking by consumers
+
 ### Fixed
 - declaration of ES module in package.json
 - provide CommonJS output as fall-back
@@ -89,7 +92,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [1.0.0] - 2019-03-03
 - initial implementation
 
-[Unreleased]: https://github.com/CarstenWickner/react-jsonschema-inspector/compare/v3.0.0...HEAD
+[3.1.0]: https://github.com/CarstenWickner/react-jsonschema-inspector/compare/v3.0.0...v3.1.0
 [3.0.0]: https://github.com/CarstenWickner/react-jsonschema-inspector/compare/v2.3.0...v3.0.0
 [2.3.0]: https://github.com/CarstenWickner/react-jsonschema-inspector/compare/v2.2.0...v2.3.0
 [2.2.0]: https://github.com/CarstenWickner/react-jsonschema-inspector/compare/v2.1.0...v2.2.0

package.json

@@ -1,6 +1,6 @@
 {
     "name": "react-jsonschema-inspector",
-    "version": "3.1.0-SNAPSHOT",
+    "version": "3.1.0",
     "description": "View component for traversing/searching in a JSON Schema",
     "homepage": "https://CarstenWickner.github.io/react-jsonschema-inspector",
     "author": "Carsten Wickner",

stories/Inspector.stories.mdx

@@ -0,0 +1,54 @@
+import { action } from '@storybook/addon-actions';
+import { Meta, Preview, Story } from '@storybook/addon-docs/blocks';
+import "./style-overrides.css";
+
+import { Inspector, getMaximumFieldValueFromSchemaGroup } from "../src/index";
+
+import metaSchema from "./schema-meta.json";
+import hyperMetaSchema from "./schema-hyper-meta.json";
+import linksMetaSchema from "./schema-links-meta.json";
+
+<Meta title='MDX|Inspector' component={Inspector} />
+
+# Inspector
+
+<Preview>
+    <Story name="show-case">
+        <Inspector
+            schemas={{
+                "Meta Core JSON Schema": { $ref: "http://json-schema.org/draft-07/schema#" },
+                "Meta Hyper JSON Schema": { $ref: "http://json-schema.org/draft-07/hyper-schema#" },
+                "Meta Links JSON Schema": { $ref: "http://json-schema.org/draft-07/links#" }
+            }}
+            referenceSchemas={[metaSchema, hyperMetaSchema, linksMetaSchema]}
+            searchOptions={{
+                fields: ["title", "description"],
+                byPropertyName: true
+            }}
+            buildArrayProperties={(arrayItemSchema, arraySchemaGroup, optionIndexes) => ({
+                "[0]": arrayItemSchema,
+                length: {
+                    title: "Number of Items",
+                    type: "number",
+                    minimum: getMaximumFieldValueFromSchemaGroup(arraySchemaGroup, "minItems", 0, optionIndexes)
+                }
+            })}
+            renderEmptyDetails={({ rootColumnSchemas }) => (
+                <div style={{ padding: "0.5em 1em 0" }}>
+                    <h3>JSON Schema Inspector</h3>
+                    <p>
+                        {`Just click on one of the ${Object.keys(rootColumnSchemas).length} schema titles
+                            on the left side in order to traverse their nested properties
+                            – but don't get lost in the circular references.`}
+                    </p>
+                    <img
+                        src="https://raw.githubusercontent.com/CarstenWickner/react-jsonschema-inspector/master/logo.svg?sanitize=true"
+                        alt="JSON Schema Inspector Logo"
+                        style={{ width: "70%", margin: "0 15%" }}
+                    />
+                </div>
+            )}
+            onSelect={action("onSelect")}
+        />
+    </Story>
+</Preview>