@teambit/api-reference.renderers.react - npm Package Compare versions

Comparing version 0.0.15 to 0.0.16

dist/react.renderer.js

@@ -13,2 +13,3 @@ "use strict";
 const semantics_entities_semantic_schema_1 = require("@teambit/semantics.entities.semantic-schema");
+const base_react_navigation_link_1 = require("@teambit/base-react.navigation.link");
 const react_renderer_module_scss_1 = __importDefault(require("./react.renderer.module.scss"));
@@ -18,2 +19,3 @@ exports.reactRenderer = {
     Component: ReactComponent,
+    OverviewComponent: ReactOverviewComponent,
     nodeType: 'React',
@@ -56,2 +58,36 @@ icon: { name: 'React', url: 'https://static.bit.dev/extensions-icons/react.svg' },
 }
+function ReactOverviewComponent(props) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+    const { apiNode: { api }, renderers,
+    // apiRefModel,
+     } = props;
+    const reactNode = api;
+    const { returnType, props: reactProps } = reactNode;
+    const returnTypeRenderer = renderers.find((renderer) => renderer.predicate(returnType));
+    const paramRenderer = reactProps && renderers.find((renderer) => renderer.predicate(reactProps));
+    const paramRef = reactProps === null || reactProps === void 0 ? void 0 : reactProps.type;
+    const paramRefRenderer = paramRef && renderers.find((renderer) => renderer.predicate(paramRef));
+    const PropsRefComponent = paramRef && (paramRefRenderer === null || paramRefRenderer === void 0 ? void 0 : paramRefRenderer.Component) ? (react_1.default.createElement(paramRefRenderer.Component, Object.assign({}, props, { key: `props-ref-${reactProps.name}`, depth: ((_a = props.depth) !== null && _a !== void 0 ? _a : 0) + 1, apiNode: Object.assign(Object.assign({}, props.apiNode), { renderer: paramRefRenderer, api: paramRef }), metadata: { [paramRef.__schema]: { columnView: true } } }))) : null;
+    const ParamComponent = reactProps && (paramRenderer === null || paramRenderer === void 0 ? void 0 : paramRenderer.Component) ? (react_1.default.createElement(paramRenderer.Component, Object.assign({}, props, { key: `props-${reactProps.name}`, depth: ((_b = props.depth) !== null && _b !== void 0 ? _b : 0) + 1, apiNode: Object.assign(Object.assign({}, props.apiNode), { renderer: paramRenderer, api: reactProps }), metadata: { [reactProps.__schema]: { columnView: true } } }))) : ((reactProps && (react_1.default.createElement(api_reference_renderers_parameter_1.parameterRenderer.Component, Object.assign({}, props, { key: `props-${reactProps.name}`, depth: ((_c = props.depth) !== null && _c !== void 0 ? _c : 0) + 1, apiNode: Object.assign(Object.assign({}, props.apiNode), { renderer: api_reference_renderers_parameter_1.parameterRenderer, api: reactProps }), metadata: { [reactProps.__schema]: { columnView: true } } })))) ||
+        null);
+    const docComment = (_e = (_d = api.doc) === null || _d === void 0 ? void 0 : _d.findTag(semantics_entities_semantic_schema_1.TagName.return)) === null || _e === void 0 ? void 0 : _e.comment;
+    const icon = exports.reactRenderer.icon;
+    const description = (_g = (_f = api.doc) === null || _f === void 0 ? void 0 : _f.comment) !== null && _g !== void 0 ? _g : (_j = (_h = api === null || api === void 0 ? void 0 : api.doc) === null || _h === void 0 ? void 0 : _h.tags) === null || _j === void 0 ? void 0 : _j.filter((tag) => tag.comment).reduce((acc, tag) => { var _a; return acc.concat((_a = `${tag.comment}\n`) !== null && _a !== void 0 ? _a : ''); }, '');
+    return (react_1.default.createElement("div", { className: react_renderer_module_scss_1.default.reactOverview },
+        react_1.default.createElement("div", { className: react_renderer_module_scss_1.default.reactOverviewHeader },
+            react_1.default.createElement("div", { className: react_renderer_module_scss_1.default.headingLeft },
+                icon && (react_1.default.createElement("div", { className: react_renderer_module_scss_1.default.icon },
+                    react_1.default.createElement("img", { src: icon.url, alt: icon.name }))),
+                react_1.default.createElement("div", { className: react_renderer_module_scss_1.default.title },
+                    react_1.default.createElement(base_react_navigation_link_1.Link, { href: `~api-reference?selectedAPI=${api.name}` }, api.name)))),
+        description && react_1.default.createElement("div", { className: react_renderer_module_scss_1.default.description }, description),
+        ParamComponent && (react_1.default.createElement("div", { className: (0, classnames_1.default)(react_renderer_module_scss_1.default.container, react_renderer_module_scss_1.default.topPad) },
+            react_1.default.createElement("div", { className: react_renderer_module_scss_1.default.title }, "Props"),
+            react_1.default.createElement("div", { className: react_renderer_module_scss_1.default.paramRef }, PropsRefComponent),
+            ParamComponent)),
+        react_1.default.createElement("div", { className: react_renderer_module_scss_1.default.container },
+            react_1.default.createElement("div", { className: react_renderer_module_scss_1.default.title }, "Returns"),
+            docComment && react_1.default.createElement("div", { className: react_renderer_module_scss_1.default.docComment }, docComment),
+            react_1.default.createElement("div", { className: react_renderer_module_scss_1.default.returnType }, (returnTypeRenderer && (react_1.default.createElement(returnTypeRenderer.Component, Object.assign({}, props, { apiNode: Object.assign(Object.assign({}, props.apiNode), { api: returnType, renderer: returnTypeRenderer }), depth: ((_k = props.depth) !== null && _k !== void 0 ? _k : 0) + 1 })))) || react_1.default.createElement("div", { className: api_reference_models_api_node_renderer_1.nodeStyles.node }, returnType.toString())))));
+}
 //# sourceMappingURL=react.renderer.js.map

package.json

 {
   "name": "@teambit/api-reference.renderers.react",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "homepage": "https://bit.cloud/teambit/api-reference/renderers/react",
@@ -9,3 +9,3 @@ "main": "dist/index.js",
     "name": "renderers/react",
-    "version": "0.0.15"
+    "version": "0.0.16"
   },
@@ -15,6 +15,7 @@ "dependencies": {
     "core-js": "^3.0.0",
-    "@teambit/api-reference.models.api-node-renderer": "0.0.17",
-    "@teambit/api-reference.renderers.api-node-details": "0.0.28",
-    "@teambit/semantics.entities.semantic-schema": "0.0.59",
-    "@teambit/api-reference.renderers.parameter": "0.0.27"
+    "@teambit/base-react.navigation.link": "2.0.27",
+    "@teambit/api-reference.models.api-node-renderer": "0.0.18",
+    "@teambit/api-reference.renderers.api-node-details": "0.0.29",
+    "@teambit/api-reference.renderers.parameter": "0.0.28",
+    "@teambit/semantics.entities.semantic-schema": "0.0.60"
   },
@@ -36,2 +37,4 @@ "devDependencies": {
   "license": "Apache-2.0",
+  "optionalDependencies": {},
+  "peerDependenciesMeta": {},
   "private": false,
@@ -38,0 +41,0 @@ "engines": {

No alert changes

Improved metrics

Total package byte prevSize

33886

increased by64.58%

Lines of code

429

increased by43.48%

Worsened metrics

Dependency count

9

increased by12.5%

Dependency changes

• + Added@teambit/base-react.navigation.link@2.0.27

• + Added@teambit/api-reference.hooks.use-api-ref-url@0.0.13(transitive)

• + Added@teambit/api-reference.renderers.api-node-details@0.0.29(transitive)

• + Added@teambit/api-reference.renderers.parameter@0.0.28(transitive)

• + Added@teambit/api-reference.renderers.schema-node-member-summary@0.0.34(transitive)

• + Added@teambit/api-reference.renderers.schema-nodes-index@0.0.26(transitive)

• + Added@teambit/api-reference.utils.custom-prism-syntax-highlighter-theme@0.0.5(transitive)

• + Added@teambit/api-reference.utils.schema-node-signature-transform@0.0.16(transitive)

• + Added@teambit/bit-error@0.0.404(transitive)

• + Added@teambit/component-id@1.2.0(transitive)

• + Added@teambit/component-version@1.0.3(transitive)

• + Added@teambit/legacy-bit-id@1.1.0(transitive)

• + Added@teambit/semantics.entities.semantic-schema@0.0.60(transitive)

• + Addedreact-syntax-highlighter@15.5.0(transitive)

• + Addedsemver@7.5.2(transitive)

• - Removed@teambit/api-reference.hooks.use-api-ref-url@0.0.9(transitive)

• - Removed@teambit/api-reference.models.api-node-renderer@0.0.17(transitive)

• - Removed@teambit/api-reference.models.api-reference-model@0.0.17(transitive)

• - Removed@teambit/api-reference.renderers.api-node-details@0.0.28(transitive)

• - Removed@teambit/api-reference.renderers.parameter@0.0.230.0.27(transitive)

• - Removed@teambit/api-reference.renderers.schema-node-member-summary@0.0.25(transitive)

• - Removed@teambit/api-reference.renderers.schema-nodes-index@0.0.25(transitive)

• - Removed@teambit/api-reference.utils.custom-prism-syntax-highlighter-theme@0.0.1(transitive)

• - Removed@teambit/api-reference.utils.schema-node-signature-transform@0.0.15(transitive)

• - Removed@teambit/bit-error@0.0.402(transitive)

• - Removed@teambit/component-id@0.0.427(transitive)

• - Removed@teambit/component-version@0.0.408(transitive)

• - Removed@teambit/legacy-bit-id@0.0.423(transitive)

• - Removed@teambit/semantics.entities.semantic-schema@0.0.59(transitive)

• - Removedsemver@7.3.4(transitive)

• Updated@teambit/api-reference.models.api-node-renderer@0.0.18

• Updated@teambit/api-reference.renderers.api-node-details@0.0.29

• Updated@teambit/api-reference.renderers.parameter@0.0.28

• Updated@teambit/semantics.entities.semantic-schema@0.0.60