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

package/template/stories/docgen-components/jsdoc/properties.snapshot

@@ -0,0 +1,857 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`react component properties jsdoc 1`] = `
+Object {
+  "rows": Array [
+    Object {
+      "defaultValue": null,
+      "description": "simple description.",
+      "name": "case1",
+      "required": false,
+      "sbType": Object {
+        "name": "string",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "string",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "multi
+lines
+description",
+      "name": "case2",
+      "required": false,
+      "sbType": Object {
+        "name": "string",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "string",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "*description* **with** \`formatting\`",
+      "name": "case3",
+      "required": false,
+      "sbType": Object {
+        "name": "string",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "string",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "simple description and dummy JSDoc tag.",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": null,
+            "name": "event",
+          },
+        ],
+        "returns": false,
+      },
+      "name": "case4",
+      "required": false,
+      "sbType": Object {
+        "name": "string",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "string",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": null,
+            "name": "event",
+          },
+        ],
+        "returns": false,
+      },
+      "name": "case5",
+      "required": false,
+      "sbType": Object {
+        "name": "string",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "string",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "simple description with a @.",
+      "name": "case6",
+      "required": false,
+      "sbType": Object {
+        "name": "string",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "string",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "",
+      "name": "case7",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "func",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "func with a simple description.",
+      "name": "case8",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "func",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": null,
+            "name": "event",
+          },
+        ],
+        "returns": false,
+      },
+      "name": "case9",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(event)",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "param with name",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": null,
+            "name": "event",
+          },
+        ],
+        "returns": false,
+      },
+      "name": "case10",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(event)",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "param with name & type",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": null,
+            "name": "event",
+          },
+        ],
+        "returns": false,
+      },
+      "name": "case11",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(event: SyntheticEvent)",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "param with name, type & description",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": "React's original event",
+            "name": "event",
+          },
+        ],
+        "returns": false,
+      },
+      "name": "case12",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(event: SyntheticEvent)",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "param with type",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": null,
+            "name": "SyntheticEvent",
+          },
+        ],
+        "returns": false,
+      },
+      "name": "case13",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(SyntheticEvent)",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "param with type & description",
+      "name": "case14",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "func",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "param with name & description",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": "React's original event",
+            "name": "event",
+          },
+        ],
+        "returns": false,
+      },
+      "name": "case15",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(event)",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "autofix event-",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": "React's original event",
+            "name": "event",
+          },
+        ],
+        "returns": false,
+      },
+      "name": "case16",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(event)",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "autofix event.",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": null,
+            "name": "event",
+          },
+        ],
+        "returns": Object {
+          "description": null,
+        },
+      },
+      "name": "case17",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(event) => string",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "with an empty param.",
+      "name": "case18",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "func",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "with multiple empty params.",
+      "name": "case19",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "func",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "with arg alias.",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": null,
+            "name": "event",
+          },
+        ],
+        "returns": false,
+      },
+      "name": "case20",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(event)",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "with argument alias.",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": null,
+            "name": "event",
+          },
+        ],
+        "returns": false,
+      },
+      "name": "case21",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(event)",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "with multiple params.",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": null,
+            "name": "event",
+          },
+          Object {
+            "description": null,
+            "name": "stringValue",
+          },
+          Object {
+            "description": null,
+            "name": "numberValue",
+          },
+        ],
+        "returns": false,
+      },
+      "name": "case22",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(event: SyntheticEvent, stringValue: string, numberValue: number)",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "with an empty returns",
+      "name": "case23",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "func",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "with a returns with a type",
+      "jsDocTags": Object {
+        "params": false,
+        "returns": Object {
+          "description": null,
+        },
+      },
+      "name": "case24",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "() => SyntheticEvent",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "with a returns with a type & description",
+      "jsDocTags": Object {
+        "params": false,
+        "returns": Object {
+          "description": "React's original event",
+        },
+      },
+      "name": "case25",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "() => SyntheticEvent",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "single param and a returns",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": null,
+            "name": "stringValue",
+          },
+        ],
+        "returns": Object {
+          "description": "React's original event",
+        },
+      },
+      "name": "case26",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(stringValue: string) => SyntheticEvent",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "multiple params and a returns",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": null,
+            "name": "stringValue",
+          },
+          Object {
+            "description": null,
+            "name": "numberValue",
+          },
+        ],
+        "returns": Object {
+          "description": "React's original event",
+        },
+      },
+      "name": "case27",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(stringValue: string, numberValue: number) => SyntheticEvent",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "multiple returns",
+      "jsDocTags": Object {
+        "params": false,
+        "returns": Object {
+          "description": "Second returns",
+        },
+      },
+      "name": "case28",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "() => string",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "param with unsupported JSDoc tags",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": "React's original event",
+            "name": "event",
+          },
+        ],
+        "returns": false,
+      },
+      "name": "case29",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(event: SyntheticEvent)",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "param record type",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": null,
+            "name": "myType",
+          },
+        ],
+        "returns": false,
+      },
+      "name": "case30",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(myType: ({a: number, b: string}))",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "param array type",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": null,
+            "name": "myType",
+          },
+        ],
+        "returns": false,
+      },
+      "name": "case31",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(myType: string[])",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "param union type",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": null,
+            "name": "myType",
+          },
+        ],
+        "returns": false,
+      },
+      "name": "case32",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(myType: (number|boolean))",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "param any type",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": null,
+            "name": "myType",
+          },
+        ],
+        "returns": false,
+      },
+      "name": "case33",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(myType: any)",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "param repeatable type",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": null,
+            "name": "myType",
+          },
+        ],
+        "returns": false,
+      },
+      "name": "case34",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(myType)",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "optional param",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": null,
+            "name": "myType",
+          },
+        ],
+        "returns": false,
+      },
+      "name": "case35",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(myType: number)",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "optional param",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": null,
+            "name": "myType",
+          },
+        ],
+        "returns": false,
+      },
+      "name": "case36",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(myType: number)",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "dot in param name",
+      "jsDocTags": Object {
+        "params": Array [
+          Object {
+            "description": null,
+            "name": "my.type",
+          },
+        ],
+        "returns": false,
+      },
+      "name": "case37",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "(my.type: number)",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "returns record type",
+      "jsDocTags": Object {
+        "params": false,
+        "returns": Object {
+          "description": null,
+        },
+      },
+      "name": "case38",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "() => ({a: number, b: string})",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "returns array type",
+      "jsDocTags": Object {
+        "params": false,
+        "returns": Object {
+          "description": null,
+        },
+      },
+      "name": "case39",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "() => string[]",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "returns union type",
+      "jsDocTags": Object {
+        "params": false,
+        "returns": Object {
+          "description": null,
+        },
+      },
+      "name": "case40",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "() => (number|boolean)",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "returns any type",
+      "jsDocTags": Object {
+        "params": false,
+        "returns": Object {
+          "description": null,
+        },
+      },
+      "name": "case41",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "() => any",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "returns primitive",
+      "jsDocTags": Object {
+        "params": false,
+        "returns": Object {
+          "description": null,
+        },
+      },
+      "name": "case42",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "() => string",
+      },
+    },
+    Object {
+      "defaultValue": null,
+      "description": "returns void",
+      "jsDocTags": Object {
+        "params": false,
+        "returns": Object {
+          "description": null,
+        },
+      },
+      "name": "case43",
+      "required": false,
+      "sbType": Object {
+        "name": "function",
+      },
+      "type": Object {
+        "detail": undefined,
+        "summary": "() => void",
+      },
+    },
+  ],
+}
+`;