@storybook/react 7.0.0-alpha.8 → 7.0.0-beta.0

package/template/stories/docgen-components/ts-function-component/argTypes.snapshot

@@ -0,0 +1,396 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`react component properties ts-function-component 1`] = `
+Object {
+  "arrayOptional": Object {
+    "control": Object {
+      "type": "object",
+    },
+    "description": "",
+    "name": "arrayOptional",
+    "table": Object {
+      "defaultValue": Object {
+        "detail": undefined,
+        "summary": "['array',    'optional']",
+      },
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "Array",
+      },
+    },
+    "type": Object {
+      "name": "array",
+      "raw": "string[]",
+      "required": false,
+      "value": Array [
+        Object {
+          "name": "string",
+        },
+      ],
+    },
+  },
+  "arrayRequired": Object {
+    "control": Object {
+      "type": "object",
+    },
+    "description": "",
+    "name": "arrayRequired",
+    "table": Object {
+      "defaultValue": null,
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "Array",
+      },
+    },
+    "type": Object {
+      "name": "array",
+      "raw": "string[]",
+      "required": true,
+      "value": Array [
+        Object {
+          "name": "string",
+        },
+      ],
+    },
+  },
+  "booleanOptional": Object {
+    "control": Object {
+      "type": "boolean",
+    },
+    "description": "",
+    "name": "booleanOptional",
+    "table": Object {
+      "defaultValue": Object {
+        "detail": undefined,
+        "summary": "false",
+      },
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "boolean",
+      },
+    },
+    "type": Object {
+      "name": "boolean",
+      "required": false,
+    },
+  },
+  "booleanRequired": Object {
+    "control": Object {
+      "type": "boolean",
+    },
+    "description": "",
+    "name": "booleanRequired",
+    "table": Object {
+      "defaultValue": null,
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "boolean",
+      },
+    },
+    "type": Object {
+      "name": "boolean",
+      "required": true,
+    },
+  },
+  "dateOptional": Object {
+    "control": Object {
+      "type": "object",
+    },
+    "description": "",
+    "name": "dateOptional",
+    "table": Object {
+      "defaultValue": Object {
+        "detail": undefined,
+        "summary": "new Date('20 Jan 1983')",
+      },
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "Date",
+      },
+    },
+    "type": Object {
+      "name": "other",
+      "required": false,
+      "value": "Date",
+    },
+  },
+  "dateRequired": Object {
+    "control": Object {
+      "type": "object",
+    },
+    "description": "",
+    "name": "dateRequired",
+    "table": Object {
+      "defaultValue": null,
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "Date",
+      },
+    },
+    "type": Object {
+      "name": "other",
+      "required": true,
+      "value": "Date",
+    },
+  },
+  "functionOptional": Object {
+    "description": "",
+    "name": "functionOptional",
+    "table": Object {
+      "defaultValue": Object {
+        "detail": undefined,
+        "summary": "() => 'foo'",
+      },
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "signature",
+      },
+    },
+    "type": Object {
+      "name": "function",
+      "raw": "() => string",
+      "required": false,
+    },
+  },
+  "functionRequired": Object {
+    "description": "",
+    "name": "functionRequired",
+    "table": Object {
+      "defaultValue": null,
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "signature",
+      },
+    },
+    "type": Object {
+      "name": "function",
+      "raw": "() => string",
+      "required": true,
+    },
+  },
+  "globalReference": Object {
+    "control": Object {
+      "type": "object",
+    },
+    "description": "",
+    "name": "globalReference",
+    "table": Object {
+      "defaultValue": Object {
+        "detail": undefined,
+        "summary": "Date",
+      },
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "any",
+      },
+    },
+    "type": Object {
+      "name": "other",
+      "required": false,
+      "value": "any",
+    },
+  },
+  "importedReference": Object {
+    "control": Object {
+      "type": "text",
+    },
+    "description": "",
+    "name": "importedReference",
+    "table": Object {
+      "defaultValue": Object {
+        "detail": undefined,
+        "summary": "imported",
+      },
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "string",
+      },
+    },
+    "type": Object {
+      "name": "string",
+      "required": false,
+    },
+  },
+  "localReference": Object {
+    "control": Object {
+      "type": "text",
+    },
+    "description": "",
+    "name": "localReference",
+    "table": Object {
+      "defaultValue": Object {
+        "detail": undefined,
+        "summary": "'local-value'",
+      },
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "string",
+      },
+    },
+    "type": Object {
+      "name": "string",
+      "required": false,
+    },
+  },
+  "numberOptional": Object {
+    "control": Object {
+      "type": "number",
+    },
+    "description": "",
+    "name": "numberOptional",
+    "table": Object {
+      "defaultValue": Object {
+        "detail": undefined,
+        "summary": "1",
+      },
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "number",
+      },
+    },
+    "type": Object {
+      "name": "number",
+      "required": false,
+    },
+  },
+  "numberRequired": Object {
+    "control": Object {
+      "type": "number",
+    },
+    "description": "Description",
+    "name": "numberRequired",
+    "table": Object {
+      "defaultValue": null,
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "number",
+      },
+    },
+    "type": Object {
+      "name": "number",
+      "required": true,
+    },
+  },
+  "objectOptional": Object {
+    "control": Object {
+      "type": "object",
+    },
+    "description": "",
+    "name": "objectOptional",
+    "table": Object {
+      "defaultValue": Object {
+        "detail": undefined,
+        "summary": "{ object: 'optional' }",
+      },
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "Record",
+      },
+    },
+    "type": Object {
+      "name": "other",
+      "raw": "Record<string, string>",
+      "required": false,
+      "value": "Record",
+    },
+  },
+  "objectRequired": Object {
+    "control": Object {
+      "type": "object",
+    },
+    "description": "",
+    "name": "objectRequired",
+    "table": Object {
+      "defaultValue": null,
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "Record",
+      },
+    },
+    "type": Object {
+      "name": "other",
+      "raw": "Record<string, string>",
+      "required": true,
+      "value": "Record",
+    },
+  },
+  "stringGlobalName": Object {
+    "control": Object {
+      "type": "text",
+    },
+    "description": "",
+    "name": "stringGlobalName",
+    "table": Object {
+      "defaultValue": Object {
+        "detail": undefined,
+        "summary": "'top'",
+      },
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "string",
+      },
+    },
+    "type": Object {
+      "name": "string",
+      "required": false,
+    },
+  },
+  "stringOptional": Object {
+    "control": Object {
+      "type": "text",
+    },
+    "description": "",
+    "name": "stringOptional",
+    "table": Object {
+      "defaultValue": Object {
+        "detail": undefined,
+        "summary": "'stringOptional'",
+      },
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "string",
+      },
+    },
+    "type": Object {
+      "name": "string",
+      "required": false,
+    },
+  },
+  "stringRequired": Object {
+    "control": Object {
+      "type": "text",
+    },
+    "description": "",
+    "name": "stringRequired",
+    "table": Object {
+      "defaultValue": null,
+      "jsDocTags": undefined,
+      "type": Object {
+        "detail": undefined,
+        "summary": "string",
+      },
+    },
+    "type": Object {
+      "name": "string",
+      "required": true,
+    },
+  },
+}
+`;

package/template/stories/docgen-components/ts-function-component/docgen.snapshot

@@ -0,0 +1,241 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`react component properties ts-function-component 1`] = `
+"import React from 'react';
+import { imported } from '../imported';
+const local = 'local-value';
+
+/**
+ * A component that renders its props
+ */
+export const PropsWriter = props => /*#__PURE__*/React.createElement(\\"pre\\", null, JSON.stringify(props));
+PropsWriter.defaultProps = {
+  numberOptional: 1,
+  stringOptional: 'stringOptional',
+  booleanOptional: false,
+  arrayOptional: ['array', 'optional'],
+  objectOptional: {
+    object: 'optional'
+  },
+  functionOptional: () => 'foo',
+  dateOptional: new Date('20 Jan 1983'),
+  localReference: local,
+  importedReference: imported,
+  globalReference: Date,
+  stringGlobalName: 'top'
+};
+export const component = PropsWriter;
+PropsWriter.__docgenInfo = {
+  \\"description\\": \\"A component that renders its props\\",
+  \\"methods\\": [],
+  \\"displayName\\": \\"PropsWriter\\",
+  \\"props\\": {
+    \\"numberOptional\\": {
+      \\"defaultValue\\": {
+        \\"value\\": \\"1\\",
+        \\"computed\\": false
+      },
+      \\"required\\": false,
+      \\"tsType\\": {
+        \\"name\\": \\"number\\"
+      },
+      \\"description\\": \\"\\"
+    },
+    \\"stringOptional\\": {
+      \\"defaultValue\\": {
+        \\"value\\": \\"'stringOptional'\\",
+        \\"computed\\": false
+      },
+      \\"required\\": false,
+      \\"tsType\\": {
+        \\"name\\": \\"string\\"
+      },
+      \\"description\\": \\"\\"
+    },
+    \\"booleanOptional\\": {
+      \\"defaultValue\\": {
+        \\"value\\": \\"false\\",
+        \\"computed\\": false
+      },
+      \\"required\\": false,
+      \\"tsType\\": {
+        \\"name\\": \\"boolean\\"
+      },
+      \\"description\\": \\"\\"
+    },
+    \\"arrayOptional\\": {
+      \\"defaultValue\\": {
+        \\"value\\": \\"['array', 'optional']\\",
+        \\"computed\\": false
+      },
+      \\"required\\": false,
+      \\"tsType\\": {
+        \\"name\\": \\"Array\\",
+        \\"elements\\": [{
+          \\"name\\": \\"string\\"
+        }],
+        \\"raw\\": \\"string[]\\"
+      },
+      \\"description\\": \\"\\"
+    },
+    \\"objectOptional\\": {
+      \\"defaultValue\\": {
+        \\"value\\": \\"{ object: 'optional' }\\",
+        \\"computed\\": false
+      },
+      \\"required\\": false,
+      \\"tsType\\": {
+        \\"name\\": \\"Record\\",
+        \\"elements\\": [{
+          \\"name\\": \\"string\\"
+        }, {
+          \\"name\\": \\"string\\"
+        }],
+        \\"raw\\": \\"Record<string, string>\\"
+      },
+      \\"description\\": \\"\\"
+    },
+    \\"functionOptional\\": {
+      \\"defaultValue\\": {
+        \\"value\\": \\"() => 'foo'\\",
+        \\"computed\\": false
+      },
+      \\"required\\": false,
+      \\"tsType\\": {
+        \\"name\\": \\"signature\\",
+        \\"type\\": \\"function\\",
+        \\"raw\\": \\"() => string\\",
+        \\"signature\\": {
+          \\"arguments\\": [],
+          \\"return\\": {
+            \\"name\\": \\"string\\"
+          }
+        }
+      },
+      \\"description\\": \\"\\"
+    },
+    \\"dateOptional\\": {
+      \\"defaultValue\\": {
+        \\"value\\": \\"new Date('20 Jan 1983')\\",
+        \\"computed\\": false
+      },
+      \\"required\\": false,
+      \\"tsType\\": {
+        \\"name\\": \\"Date\\"
+      },
+      \\"description\\": \\"\\"
+    },
+    \\"localReference\\": {
+      \\"defaultValue\\": {
+        \\"value\\": \\"'local-value'\\",
+        \\"computed\\": false
+      },
+      \\"required\\": false,
+      \\"tsType\\": {
+        \\"name\\": \\"string\\"
+      },
+      \\"description\\": \\"\\"
+    },
+    \\"importedReference\\": {
+      \\"defaultValue\\": {
+        \\"value\\": \\"imported\\",
+        \\"computed\\": true
+      },
+      \\"required\\": false,
+      \\"tsType\\": {
+        \\"name\\": \\"string\\"
+      },
+      \\"description\\": \\"\\"
+    },
+    \\"globalReference\\": {
+      \\"defaultValue\\": {
+        \\"value\\": \\"Date\\",
+        \\"computed\\": true
+      },
+      \\"required\\": false,
+      \\"tsType\\": {
+        \\"name\\": \\"any\\"
+      },
+      \\"description\\": \\"\\"
+    },
+    \\"stringGlobalName\\": {
+      \\"defaultValue\\": {
+        \\"value\\": \\"'top'\\",
+        \\"computed\\": false
+      },
+      \\"required\\": false,
+      \\"tsType\\": {
+        \\"name\\": \\"string\\"
+      },
+      \\"description\\": \\"\\"
+    },
+    \\"numberRequired\\": {
+      \\"required\\": true,
+      \\"tsType\\": {
+        \\"name\\": \\"number\\"
+      },
+      \\"description\\": \\"Description\\"
+    },
+    \\"stringRequired\\": {
+      \\"required\\": true,
+      \\"tsType\\": {
+        \\"name\\": \\"string\\"
+      },
+      \\"description\\": \\"\\"
+    },
+    \\"booleanRequired\\": {
+      \\"required\\": true,
+      \\"tsType\\": {
+        \\"name\\": \\"boolean\\"
+      },
+      \\"description\\": \\"\\"
+    },
+    \\"arrayRequired\\": {
+      \\"required\\": true,
+      \\"tsType\\": {
+        \\"name\\": \\"Array\\",
+        \\"elements\\": [{
+          \\"name\\": \\"string\\"
+        }],
+        \\"raw\\": \\"string[]\\"
+      },
+      \\"description\\": \\"\\"
+    },
+    \\"objectRequired\\": {
+      \\"required\\": true,
+      \\"tsType\\": {
+        \\"name\\": \\"Record\\",
+        \\"elements\\": [{
+          \\"name\\": \\"string\\"
+        }, {
+          \\"name\\": \\"string\\"
+        }],
+        \\"raw\\": \\"Record<string, string>\\"
+      },
+      \\"description\\": \\"\\"
+    },
+    \\"functionRequired\\": {
+      \\"required\\": true,
+      \\"tsType\\": {
+        \\"name\\": \\"signature\\",
+        \\"type\\": \\"function\\",
+        \\"raw\\": \\"() => string\\",
+        \\"signature\\": {
+          \\"arguments\\": [],
+          \\"return\\": {
+            \\"name\\": \\"string\\"
+          }
+        }
+      },
+      \\"description\\": \\"\\"
+    },
+    \\"dateRequired\\": {
+      \\"required\\": true,
+      \\"tsType\\": {
+        \\"name\\": \\"Date\\"
+      },
+      \\"description\\": \\"\\"
+    }
+  }
+};"
+`;

package/template/stories/docgen-components/ts-function-component/input.tsx

@@ -0,0 +1,52 @@
+import React from 'react';
+
+import { imported } from '../imported';
+
+const local = 'local-value';
+
+interface PropsWriterProps {
+  /**
+   * Description
+   */
+  numberRequired: number;
+  numberOptional?: number;
+  stringRequired: string;
+  stringOptional?: string;
+  booleanRequired: boolean;
+  booleanOptional?: boolean;
+  arrayRequired: string[];
+  arrayOptional?: string[];
+  objectRequired: Record<string, string>;
+  objectOptional?: Record<string, string>;
+  functionRequired: () => string;
+  functionOptional?: () => string;
+  dateRequired: Date;
+  dateOptional?: Date;
+  localReference?: string;
+  importedReference?: string;
+  globalReference?: any;
+  stringGlobalName?: string;
+}
+
+/**
+ * A component that renders its props
+ */
+export const PropsWriter: React.FC<PropsWriterProps> = (props: PropsWriterProps) => (
+  <pre>{JSON.stringify(props)}</pre>
+);
+
+PropsWriter.defaultProps = {
+  numberOptional: 1,
+  stringOptional: 'stringOptional',
+  booleanOptional: false,
+  arrayOptional: ['array', 'optional'],
+  objectOptional: { object: 'optional' },
+  functionOptional: () => 'foo',
+  dateOptional: new Date('20 Jan 1983'),
+  localReference: local,
+  importedReference: imported,
+  globalReference: Date,
+  stringGlobalName: 'top',
+};
+
+export const component = PropsWriter;