@teambit/docs 0.0.741 → 0.0.744

package/dist/overview/legacy-docs.d.ts

@@ -0,0 +1,2 @@
+import { ComponentModel } from '@teambit/component';
+export declare function hasLegacyDocs(component: ComponentModel, envType: string): boolean;

package/dist/overview/legacy-docs.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.hasLegacyDocs = hasLegacyDocs;
+// these envs had header in their docs
+const ENV_WITH_LEGACY_DOCS = ['react', 'env', 'aspect', 'lit', 'html', 'node', 'mdx', 'react-native', 'readme'];
+
+function hasLegacyDocs(component, envType) {
+  var _component$preview;
+
+  const previewIncludesEnvsTemplate = (component === null || component === void 0 ? void 0 : (_component$preview = component.preview) === null || _component$preview === void 0 ? void 0 : _component$preview.includesEnvTemplate) !== false;
+  return previewIncludesEnvsTemplate && ENV_WITH_LEGACY_DOCS.includes(envType);
+}
+
+//# sourceMappingURL=legacy-docs.js.map

package/dist/overview/legacy-docs.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["ENV_WITH_LEGACY_DOCS","hasLegacyDocs","component","envType","previewIncludesEnvsTemplate","preview","includesEnvTemplate","includes"],"sources":["legacy-docs.tsx"],"sourcesContent":["import { ComponentModel } from '@teambit/component';\n\n// these envs had header in their docs\nconst ENV_WITH_LEGACY_DOCS = ['react', 'env', 'aspect', 'lit', 'html', 'node', 'mdx', 'react-native', 'readme'];\n\nexport function hasLegacyDocs(component: ComponentModel, envType: string) {\n  const previewIncludesEnvsTemplate = component?.preview?.includesEnvTemplate !== false;\n\n  return previewIncludesEnvsTemplate && ENV_WITH_LEGACY_DOCS.includes(envType);\n}\n"],"mappings":";;;;;;AAEA;AACA,MAAMA,oBAAoB,GAAG,CAAC,OAAD,EAAU,KAAV,EAAiB,QAAjB,EAA2B,KAA3B,EAAkC,MAAlC,EAA0C,MAA1C,EAAkD,KAAlD,EAAyD,cAAzD,EAAyE,QAAzE,CAA7B;;AAEO,SAASC,aAAT,CAAuBC,SAAvB,EAAkDC,OAAlD,EAAmE;EAAA;;EACxE,MAAMC,2BAA2B,GAAG,CAAAF,SAAS,SAAT,IAAAA,SAAS,WAAT,kCAAAA,SAAS,CAAEG,OAAX,0EAAoBC,mBAApB,MAA4C,KAAhF;EAEA,OAAOF,2BAA2B,IAAIJ,oBAAoB,CAACO,QAArB,CAA8BJ,OAA9B,CAAtC;AACD"}

package/dist/overview/overview.js

@@ -101,25 +101,33 @@ function _overviewModule() {
   return data;
 }
 
+function _legacyDocs() {
+  const data = require("./legacy-docs");
+
+  _legacyDocs = function () {
+    return data;
+  };
+
+  return data;
+}
+
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
-const ENV_LIST_WITH_DOCS_TEMPLATE = ['react', 'env', 'aspect', 'lit', 'html', 'node', 'mdx', 'react-native', 'readme']; // envs using react based docs
-
 const ENV_ASPECT_NAME = 'teambit.envs/envs';
 
 function Overview({
   titleBadges
 }) {
-  var _componentDescriptor$, _component$preview;
+  var _componentDescriptor$;
 
   const component = (0, _react().useContext)(_component().ComponentContext);
   const componentDescriptor = (0, _component().useComponentDescriptor)();
   const lanesModel = (0, _lanesUi().useLanesContext)();
   const currentLane = lanesModel === null || lanesModel === void 0 ? void 0 : lanesModel.viewedLane;
   const envType = componentDescriptor === null || componentDescriptor === void 0 ? void 0 : (_componentDescriptor$ = componentDescriptor.get(ENV_ASPECT_NAME)) === null || _componentDescriptor$ === void 0 ? void 0 : _componentDescriptor$.type;
-  const showHeaderOutsideIframe = (component === null || component === void 0 ? void 0 : (_component$preview = component.preview) === null || _component$preview === void 0 ? void 0 : _component$preview.includesEnvTemplate) === false || !ENV_LIST_WITH_DOCS_TEMPLATE.includes(envType);
+  const showHeader = !(0, _legacyDocs().hasLegacyDocs)(component, envType);
   if ((component === null || component === void 0 ? void 0 : component.buildStatus) === 'pending' && (component === null || component === void 0 ? void 0 : component.host) === 'teambit.scope/scope') return /*#__PURE__*/_react().default.createElement(_designUiSurfaces().StatusMessageCard, {
     style: {
       margin: 'auto'
@@ -134,43 +142,22 @@ function Overview({
     status: "FAILURE",
     title: "failed to get component preview "
   });
-
-  if (showHeaderOutsideIframe) {
-    const badges = (0, _lodash().default)(titleBadges.values());
-    return /*#__PURE__*/_react().default.createElement("div", {
-      className: _overviewModule().default.overviewWrapper
-    }, /*#__PURE__*/_react().default.createElement(_lanesUi().LaneBreadcrumb, {
-      lane: currentLane
-    }), /*#__PURE__*/_react().default.createElement(_designUi().Separator, {
-      isPresentational: true
-    }), /*#__PURE__*/_react().default.createElement(_componentUi().ComponentOverview, {
-      className: _overviewModule().default.componentOverviewBlock,
-      displayName: component.displayName,
-      version: component.version,
-      abstract: component.description,
-      labels: component.labels,
-      packageName: component.packageName,
-      titleBadges: badges,
-      componentDescriptor: componentDescriptor,
-      deprecation: component.deprecation
-    }), /*#__PURE__*/_react().default.createElement(_previewUi().ComponentPreview, {
-      component: component,
-      style: {
-        width: '100%',
-        height: '100%'
-      },
-      previewName: "overview",
-      fullContentHeight: true,
-      scrolling: "no"
-    }));
-  }
-
-  return currentLane ? /*#__PURE__*/_react().default.createElement("div", {
+  return /*#__PURE__*/_react().default.createElement("div", {
     className: _overviewModule().default.overviewWrapper
-  }, /*#__PURE__*/_react().default.createElement(_lanesUi().LaneBreadcrumb, {
+  }, currentLane && /*#__PURE__*/_react().default.createElement(_lanesUi().LaneBreadcrumb, {
     lane: currentLane
-  }), /*#__PURE__*/_react().default.createElement(_designUi().Separator, {
+  }), currentLane && /*#__PURE__*/_react().default.createElement(_designUi().Separator, {
     isPresentational: true
+  }), showHeader && /*#__PURE__*/_react().default.createElement(_componentUi().ComponentOverview, {
+    className: _overviewModule().default.componentOverviewBlock,
+    displayName: component.displayName,
+    version: component.version,
+    abstract: component.description,
+    labels: component.labels,
+    packageName: component.packageName,
+    titleBadges: (0, _lodash().default)(titleBadges.values()),
+    componentDescriptor: componentDescriptor,
+    deprecation: component.deprecation
   }), /*#__PURE__*/_react().default.createElement(_previewUi().ComponentPreview, {
     component: component,
     style: {
@@ -180,15 +167,7 @@ function Overview({
     previewName: "overview",
     fullContentHeight: true,
     scrolling: "no"
-  })) : /*#__PURE__*/_react().default.createElement(_previewUi().ComponentPreview, {
-    component: component,
-    style: {
-      width: '100%',
-      height: '100%'
-    },
-    previewName: "overview",
-    fullContentHeight: true
-  });
+  }));
 }
 
 //# sourceMappingURL=overview.js.map

package/dist/overview/overview.js.map

@@ -1 +1 @@
-{"version":3,"names":["ENV_LIST_WITH_DOCS_TEMPLATE","ENV_ASPECT_NAME","Overview","titleBadges","component","useContext","ComponentContext","componentDescriptor","useComponentDescriptor","lanesModel","useLanesContext","currentLane","viewedLane","envType","get","type","showHeaderOutsideIframe","preview","includesEnvTemplate","includes","buildStatus","host","margin","badges","flatten","values","styles","overviewWrapper","componentOverviewBlock","displayName","version","description","labels","packageName","deprecation","width","height"],"sources":["overview.tsx"],"sourcesContent":["import React, { useContext } from 'react';\nimport flatten from 'lodash.flatten';\nimport { ComponentContext, useComponentDescriptor } from '@teambit/component';\nimport type { SlotRegistry } from '@teambit/harmony';\nimport { ComponentPreview } from '@teambit/preview.ui.component-preview';\nimport { StatusMessageCard } from '@teambit/design.ui.surfaces.status-message-card';\nimport { ComponentOverview, TitleBadge } from '@teambit/component.ui.component-meta';\nimport { LaneBreadcrumb, useLanesContext } from '@teambit/lanes.ui.lanes';\nimport { Separator } from '@teambit/design.ui.separator';\nimport styles from './overview.module.scss';\n\nconst ENV_LIST_WITH_DOCS_TEMPLATE = ['react', 'env', 'aspect', 'lit', 'html', 'node', 'mdx', 'react-native', 'readme']; // envs using react based docs\n\nconst ENV_ASPECT_NAME = 'teambit.envs/envs';\n\nexport type TitleBadgeSlot = SlotRegistry<TitleBadge[]>;\n\nexport type OverviewProps = {\n  titleBadges: TitleBadgeSlot;\n};\n\nexport function Overview({ titleBadges }: OverviewProps) {\n  const component = useContext(ComponentContext);\n  const componentDescriptor = useComponentDescriptor();\n  const lanesModel = useLanesContext();\n  const currentLane = lanesModel?.viewedLane;\n\n  const envType: string = componentDescriptor?.get<any>(ENV_ASPECT_NAME)?.type;\n  const showHeaderOutsideIframe =\n    component?.preview?.includesEnvTemplate === false || !ENV_LIST_WITH_DOCS_TEMPLATE.includes(envType);\n\n  if (component?.buildStatus === 'pending' && component?.host === 'teambit.scope/scope')\n    return (\n      <StatusMessageCard style={{ margin: 'auto' }} status=\"PROCESSING\" title=\"component preview pending\">\n        this might take some time\n      </StatusMessageCard>\n    );\n  if (component?.buildStatus === 'failed' && component?.host === 'teambit.scope/scope')\n    return (\n      <StatusMessageCard\n        style={{ margin: 'auto' }}\n        status=\"FAILURE\"\n        title=\"failed to get component preview \"\n      ></StatusMessageCard>\n    );\n\n  if (showHeaderOutsideIframe) {\n    const badges = flatten(titleBadges.values());\n\n    return (\n      <div className={styles.overviewWrapper}>\n        <LaneBreadcrumb lane={currentLane} />\n        <Separator isPresentational />\n        <ComponentOverview\n          className={styles.componentOverviewBlock}\n          displayName={component.displayName}\n          version={component.version}\n          abstract={component.description}\n          labels={component.labels}\n          packageName={component.packageName}\n          titleBadges={badges}\n          componentDescriptor={componentDescriptor}\n          deprecation={component.deprecation}\n        />\n        <ComponentPreview\n          component={component}\n          style={{ width: '100%', height: '100%' }}\n          previewName=\"overview\"\n          fullContentHeight\n          scrolling=\"no\"\n        />\n      </div>\n    );\n  }\n\n  return currentLane ? (\n    <div className={styles.overviewWrapper}>\n      <LaneBreadcrumb lane={currentLane} />\n      <Separator isPresentational />\n      <ComponentPreview\n        component={component}\n        style={{ width: '100%', height: '100%' }}\n        previewName=\"overview\"\n        fullContentHeight\n        scrolling=\"no\"\n      />\n    </div>\n  ) : (\n    <ComponentPreview\n      component={component}\n      style={{ width: '100%', height: '100%' }}\n      previewName=\"overview\"\n      fullContentHeight\n    />\n  );\n}\n"],"mappings":";;;;;;;;;;;;;AAAA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;;;;;AAEA,MAAMA,2BAA2B,GAAG,CAAC,OAAD,EAAU,KAAV,EAAiB,QAAjB,EAA2B,KAA3B,EAAkC,MAAlC,EAA0C,MAA1C,EAAkD,KAAlD,EAAyD,cAAzD,EAAyE,QAAzE,CAApC,C,CAAwH;;AAExH,MAAMC,eAAe,GAAG,mBAAxB;;AAQO,SAASC,QAAT,CAAkB;EAAEC;AAAF,CAAlB,EAAkD;EAAA;;EACvD,MAAMC,SAAS,GAAG,IAAAC,mBAAA,EAAWC,6BAAX,CAAlB;EACA,MAAMC,mBAAmB,GAAG,IAAAC,mCAAA,GAA5B;EACA,MAAMC,UAAU,GAAG,IAAAC,0BAAA,GAAnB;EACA,MAAMC,WAAW,GAAGF,UAAH,aAAGA,UAAH,uBAAGA,UAAU,CAAEG,UAAhC;EAEA,MAAMC,OAAe,GAAGN,mBAAH,aAAGA,mBAAH,gDAAGA,mBAAmB,CAAEO,GAArB,CAA8Bb,eAA9B,CAAH,0DAAG,sBAAgDc,IAAxE;EACA,MAAMC,uBAAuB,GAC3B,CAAAZ,SAAS,SAAT,IAAAA,SAAS,WAAT,kCAAAA,SAAS,CAAEa,OAAX,0EAAoBC,mBAApB,MAA4C,KAA5C,IAAqD,CAAClB,2BAA2B,CAACmB,QAA5B,CAAqCN,OAArC,CADxD;EAGA,IAAI,CAAAT,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEgB,WAAX,MAA2B,SAA3B,IAAwC,CAAAhB,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEiB,IAAX,MAAoB,qBAAhE,EACE,oBACE,+BAAC,qCAAD;IAAmB,KAAK,EAAE;MAAEC,MAAM,EAAE;IAAV,CAA1B;IAA8C,MAAM,EAAC,YAArD;IAAkE,KAAK,EAAC;EAAxE,+BADF;EAKF,IAAI,CAAAlB,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEgB,WAAX,MAA2B,QAA3B,IAAuC,CAAAhB,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEiB,IAAX,MAAoB,qBAA/D,EACE,oBACE,+BAAC,qCAAD;IACE,KAAK,EAAE;MAAEC,MAAM,EAAE;IAAV,CADT;IAEE,MAAM,EAAC,SAFT;IAGE,KAAK,EAAC;EAHR,EADF;;EAQF,IAAIN,uBAAJ,EAA6B;IAC3B,MAAMO,MAAM,GAAG,IAAAC,iBAAA,EAAQrB,WAAW,CAACsB,MAAZ,EAAR,CAAf;IAEA,oBACE;MAAK,SAAS,EAAEC,yBAAA,CAAOC;IAAvB,gBACE,+BAAC,yBAAD;MAAgB,IAAI,EAAEhB;IAAtB,EADF,eAEE,+BAAC,qBAAD;MAAW,gBAAgB;IAA3B,EAFF,eAGE,+BAAC,gCAAD;MACE,SAAS,EAAEe,yBAAA,CAAOE,sBADpB;MAEE,WAAW,EAAExB,SAAS,CAACyB,WAFzB;MAGE,OAAO,EAAEzB,SAAS,CAAC0B,OAHrB;MAIE,QAAQ,EAAE1B,SAAS,CAAC2B,WAJtB;MAKE,MAAM,EAAE3B,SAAS,CAAC4B,MALpB;MAME,WAAW,EAAE5B,SAAS,CAAC6B,WANzB;MAOE,WAAW,EAAEV,MAPf;MAQE,mBAAmB,EAAEhB,mBARvB;MASE,WAAW,EAAEH,SAAS,CAAC8B;IATzB,EAHF,eAcE,+BAAC,6BAAD;MACE,SAAS,EAAE9B,SADb;MAEE,KAAK,EAAE;QAAE+B,KAAK,EAAE,MAAT;QAAiBC,MAAM,EAAE;MAAzB,CAFT;MAGE,WAAW,EAAC,UAHd;MAIE,iBAAiB,MAJnB;MAKE,SAAS,EAAC;IALZ,EAdF,CADF;EAwBD;;EAED,OAAOzB,WAAW,gBAChB;IAAK,SAAS,EAAEe,yBAAA,CAAOC;EAAvB,gBACE,+BAAC,yBAAD;IAAgB,IAAI,EAAEhB;EAAtB,EADF,eAEE,+BAAC,qBAAD;IAAW,gBAAgB;EAA3B,EAFF,eAGE,+BAAC,6BAAD;IACE,SAAS,EAAEP,SADb;IAEE,KAAK,EAAE;MAAE+B,KAAK,EAAE,MAAT;MAAiBC,MAAM,EAAE;IAAzB,CAFT;IAGE,WAAW,EAAC,UAHd;IAIE,iBAAiB,MAJnB;IAKE,SAAS,EAAC;EALZ,EAHF,CADgB,gBAahB,+BAAC,6BAAD;IACE,SAAS,EAAEhC,SADb;IAEE,KAAK,EAAE;MAAE+B,KAAK,EAAE,MAAT;MAAiBC,MAAM,EAAE;IAAzB,CAFT;IAGE,WAAW,EAAC,UAHd;IAIE,iBAAiB;EAJnB,EAbF;AAoBD"}
+{"version":3,"names":["ENV_ASPECT_NAME","Overview","titleBadges","component","useContext","ComponentContext","componentDescriptor","useComponentDescriptor","lanesModel","useLanesContext","currentLane","viewedLane","envType","get","type","showHeader","hasLegacyDocs","buildStatus","host","margin","styles","overviewWrapper","componentOverviewBlock","displayName","version","description","labels","packageName","flatten","values","deprecation","width","height"],"sources":["overview.tsx"],"sourcesContent":["import React, { useContext } from 'react';\nimport flatten from 'lodash.flatten';\nimport { ComponentContext, useComponentDescriptor } from '@teambit/component';\nimport type { SlotRegistry } from '@teambit/harmony';\nimport { ComponentPreview } from '@teambit/preview.ui.component-preview';\nimport { StatusMessageCard } from '@teambit/design.ui.surfaces.status-message-card';\nimport { ComponentOverview, TitleBadge } from '@teambit/component.ui.component-meta';\nimport { LaneBreadcrumb, useLanesContext } from '@teambit/lanes.ui.lanes';\nimport { Separator } from '@teambit/design.ui.separator';\nimport styles from './overview.module.scss';\nimport { hasLegacyDocs } from './legacy-docs';\n\nconst ENV_ASPECT_NAME = 'teambit.envs/envs';\n\nexport type TitleBadgeSlot = SlotRegistry<TitleBadge[]>;\n\nexport type OverviewProps = {\n  titleBadges: TitleBadgeSlot;\n};\n\nexport function Overview({ titleBadges }: OverviewProps) {\n  const component = useContext(ComponentContext);\n  const componentDescriptor = useComponentDescriptor();\n  const lanesModel = useLanesContext();\n  const currentLane = lanesModel?.viewedLane;\n\n  const envType = componentDescriptor?.get<any>(ENV_ASPECT_NAME)?.type;\n  const showHeader = !hasLegacyDocs(component, envType);\n\n  if (component?.buildStatus === 'pending' && component?.host === 'teambit.scope/scope')\n    return (\n      <StatusMessageCard style={{ margin: 'auto' }} status=\"PROCESSING\" title=\"component preview pending\">\n        this might take some time\n      </StatusMessageCard>\n    );\n\n  if (component?.buildStatus === 'failed' && component?.host === 'teambit.scope/scope')\n    return <StatusMessageCard style={{ margin: 'auto' }} status=\"FAILURE\" title=\"failed to get component preview \" />;\n\n  return (\n    <div className={styles.overviewWrapper}>\n      {currentLane && <LaneBreadcrumb lane={currentLane} />}\n      {currentLane && <Separator isPresentational />}\n      {showHeader && (\n        <ComponentOverview\n          className={styles.componentOverviewBlock}\n          displayName={component.displayName}\n          version={component.version}\n          abstract={component.description}\n          labels={component.labels}\n          packageName={component.packageName}\n          titleBadges={flatten(titleBadges.values())}\n          componentDescriptor={componentDescriptor}\n          deprecation={component.deprecation}\n        />\n      )}\n      <ComponentPreview\n        component={component}\n        style={{ width: '100%', height: '100%' }}\n        previewName=\"overview\"\n        fullContentHeight\n        scrolling=\"no\"\n      />\n    </div>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;AAAA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;;;;;AAEA,MAAMA,eAAe,GAAG,mBAAxB;;AAQO,SAASC,QAAT,CAAkB;EAAEC;AAAF,CAAlB,EAAkD;EAAA;;EACvD,MAAMC,SAAS,GAAG,IAAAC,mBAAA,EAAWC,6BAAX,CAAlB;EACA,MAAMC,mBAAmB,GAAG,IAAAC,mCAAA,GAA5B;EACA,MAAMC,UAAU,GAAG,IAAAC,0BAAA,GAAnB;EACA,MAAMC,WAAW,GAAGF,UAAH,aAAGA,UAAH,uBAAGA,UAAU,CAAEG,UAAhC;EAEA,MAAMC,OAAO,GAAGN,mBAAH,aAAGA,mBAAH,gDAAGA,mBAAmB,CAAEO,GAArB,CAA8Bb,eAA9B,CAAH,0DAAG,sBAAgDc,IAAhE;EACA,MAAMC,UAAU,GAAG,CAAC,IAAAC,2BAAA,EAAcb,SAAd,EAAyBS,OAAzB,CAApB;EAEA,IAAI,CAAAT,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEc,WAAX,MAA2B,SAA3B,IAAwC,CAAAd,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEe,IAAX,MAAoB,qBAAhE,EACE,oBACE,+BAAC,qCAAD;IAAmB,KAAK,EAAE;MAAEC,MAAM,EAAE;IAAV,CAA1B;IAA8C,MAAM,EAAC,YAArD;IAAkE,KAAK,EAAC;EAAxE,+BADF;EAMF,IAAI,CAAAhB,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEc,WAAX,MAA2B,QAA3B,IAAuC,CAAAd,SAAS,SAAT,IAAAA,SAAS,WAAT,YAAAA,SAAS,CAAEe,IAAX,MAAoB,qBAA/D,EACE,oBAAO,+BAAC,qCAAD;IAAmB,KAAK,EAAE;MAAEC,MAAM,EAAE;IAAV,CAA1B;IAA8C,MAAM,EAAC,SAArD;IAA+D,KAAK,EAAC;EAArE,EAAP;EAEF,oBACE;IAAK,SAAS,EAAEC,yBAAA,CAAOC;EAAvB,GACGX,WAAW,iBAAI,+BAAC,yBAAD;IAAgB,IAAI,EAAEA;EAAtB,EADlB,EAEGA,WAAW,iBAAI,+BAAC,qBAAD;IAAW,gBAAgB;EAA3B,EAFlB,EAGGK,UAAU,iBACT,+BAAC,gCAAD;IACE,SAAS,EAAEK,yBAAA,CAAOE,sBADpB;IAEE,WAAW,EAAEnB,SAAS,CAACoB,WAFzB;IAGE,OAAO,EAAEpB,SAAS,CAACqB,OAHrB;IAIE,QAAQ,EAAErB,SAAS,CAACsB,WAJtB;IAKE,MAAM,EAAEtB,SAAS,CAACuB,MALpB;IAME,WAAW,EAAEvB,SAAS,CAACwB,WANzB;IAOE,WAAW,EAAE,IAAAC,iBAAA,EAAQ1B,WAAW,CAAC2B,MAAZ,EAAR,CAPf;IAQE,mBAAmB,EAAEvB,mBARvB;IASE,WAAW,EAAEH,SAAS,CAAC2B;EATzB,EAJJ,eAgBE,+BAAC,6BAAD;IACE,SAAS,EAAE3B,SADb;IAEE,KAAK,EAAE;MAAE4B,KAAK,EAAE,MAAT;MAAiBC,MAAM,EAAE;IAAzB,CAFT;IAGE,WAAW,EAAC,UAHd;IAIE,iBAAiB,MAJnB;IAKE,SAAS,EAAC;EALZ,EAhBF,CADF;AA0BD"}

package/dist/overview.section.d.ts

@@ -17,9 +17,8 @@ export declare class OverviewSection implements Section {
         children: string;
     };
     route: {
-        path: string;
-        exact: boolean;
-        children: JSX.Element;
+        index: boolean;
+        element: JSX.Element;
     };
     order: number;
 }

package/dist/overview.section.js

@@ -45,14 +45,13 @@ class OverviewSection {
   docs) {
     this.docs = docs;
     (0, _defineProperty2().default)(this, "navigationLink", {
-      href: '',
+      href: '.',
       exact: true,
       children: 'Overview'
     });
     (0, _defineProperty2().default)(this, "route", {
-      path: '',
-      exact: true,
-      children: /*#__PURE__*/_react().default.createElement(_overview().Overview, {
+      index: true,
+      element: /*#__PURE__*/_react().default.createElement(_overview().Overview, {
         titleBadges: this.docs.titleBadgeSlot
       })
     });

package/dist/overview.section.js.map

@@ -1 +1 @@
-{"version":3,"names":["OverviewSection","constructor","docs","href","exact","children","path","titleBadgeSlot"],"sources":["overview.section.tsx"],"sourcesContent":["import { Section } from '@teambit/component';\nimport React from 'react';\n\nimport { DocsUI } from './docs.ui.runtime';\nimport { Overview } from './overview';\n\nexport class OverviewSection implements Section {\n  constructor(\n    /**\n     * docs ui extension.\n     */\n    private docs: DocsUI\n  ) {}\n\n  navigationLink = {\n    href: '',\n    exact: true,\n    children: 'Overview',\n  };\n\n  route = {\n    path: '',\n    exact: true,\n    children: <Overview titleBadges={this.docs.titleBadgeSlot} />,\n  };\n\n  order = 10;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAGA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEO,MAAMA,eAAN,CAAyC;EAC9CC,WAAW;EACT;AACJ;AACA;EACYC,IAJC,EAKT;IAAA,KADQA,IACR,GADQA,IACR;IAAA,wDAEe;MACfC,IAAI,EAAE,EADS;MAEfC,KAAK,EAAE,IAFQ;MAGfC,QAAQ,EAAE;IAHK,CAFf;IAAA,+CAQM;MACNC,IAAI,EAAE,EADA;MAENF,KAAK,EAAE,IAFD;MAGNC,QAAQ,eAAE,+BAAC,oBAAD;QAAU,WAAW,EAAE,KAAKH,IAAL,CAAUK;MAAjC;IAHJ,CARN;IAAA,+CAcM,EAdN;EAAE;;AAN0C"}
+{"version":3,"names":["OverviewSection","constructor","docs","href","exact","children","index","element","titleBadgeSlot"],"sources":["overview.section.tsx"],"sourcesContent":["import { Section } from '@teambit/component';\nimport React from 'react';\n\nimport { DocsUI } from './docs.ui.runtime';\nimport { Overview } from './overview';\n\nexport class OverviewSection implements Section {\n  constructor(\n    /**\n     * docs ui extension.\n     */\n    private docs: DocsUI\n  ) {}\n\n  navigationLink = {\n    href: '.',\n    exact: true,\n    children: 'Overview',\n  };\n\n  route = {\n    index: true,\n    element: <Overview titleBadges={this.docs.titleBadgeSlot} />,\n  };\n\n  order = 10;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAGA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAEO,MAAMA,eAAN,CAAyC;EAC9CC,WAAW;EACT;AACJ;AACA;EACYC,IAJC,EAKT;IAAA,KADQA,IACR,GADQA,IACR;IAAA,wDAEe;MACfC,IAAI,EAAE,GADS;MAEfC,KAAK,EAAE,IAFQ;MAGfC,QAAQ,EAAE;IAHK,CAFf;IAAA,+CAQM;MACNC,KAAK,EAAE,IADD;MAENC,OAAO,eAAE,+BAAC,oBAAD;QAAU,WAAW,EAAE,KAAKL,IAAL,CAAUM;MAAjC;IAFH,CARN;IAAA,+CAaM,EAbN;EAAE;;AAN0C"}

package/overview/legacy-docs.tsx

@@ -0,0 +1,10 @@
+import { ComponentModel } from '@teambit/component';
+
+// these envs had header in their docs
+const ENV_WITH_LEGACY_DOCS = ['react', 'env', 'aspect', 'lit', 'html', 'node', 'mdx', 'react-native', 'readme'];
+
+export function hasLegacyDocs(component: ComponentModel, envType: string) {
+  const previewIncludesEnvsTemplate = component?.preview?.includesEnvTemplate !== false;
+
+  return previewIncludesEnvsTemplate && ENV_WITH_LEGACY_DOCS.includes(envType);
+}

package/overview/overview.tsx

@@ -8,8 +8,7 @@ import { ComponentOverview, TitleBadge } from '@teambit/component.ui.component-m
 import { LaneBreadcrumb, useLanesContext } from '@teambit/lanes.ui.lanes';
 import { Separator } from '@teambit/design.ui.separator';
 import styles from './overview.module.scss';
-
-const ENV_LIST_WITH_DOCS_TEMPLATE = ['react', 'env', 'aspect', 'lit', 'html', 'node', 'mdx', 'react-native', 'readme']; // envs using react based docs
+import { hasLegacyDocs } from './legacy-docs';
 
 const ENV_ASPECT_NAME = 'teambit.envs/envs';
 
@@ -25,9 +24,8 @@ export function Overview({ titleBadges }: OverviewProps) {
   const lanesModel = useLanesContext();
   const currentLane = lanesModel?.viewedLane;
 
-  const envType: string = componentDescriptor?.get<any>(ENV_ASPECT_NAME)?.type;
-  const showHeaderOutsideIframe =
-    component?.preview?.includesEnvTemplate === false || !ENV_LIST_WITH_DOCS_TEMPLATE.includes(envType);
+  const envType = componentDescriptor?.get<any>(ENV_ASPECT_NAME)?.type;
+  const showHeader = !hasLegacyDocs(component, envType);
 
   if (component?.buildStatus === 'pending' && component?.host === 'teambit.scope/scope')
     return (
@@ -35,22 +33,15 @@ export function Overview({ titleBadges }: OverviewProps) {
         this might take some time
       </StatusMessageCard>
     );
-  if (component?.buildStatus === 'failed' && component?.host === 'teambit.scope/scope')
-    return (
-      <StatusMessageCard
-        style={{ margin: 'auto' }}
-        status="FAILURE"
-        title="failed to get component preview "
-      ></StatusMessageCard>
-    );
 
-  if (showHeaderOutsideIframe) {
-    const badges = flatten(titleBadges.values());
+  if (component?.buildStatus === 'failed' && component?.host === 'teambit.scope/scope')
+    return <StatusMessageCard style={{ margin: 'auto' }} status="FAILURE" title="failed to get component preview " />;
 
-    return (
-      <div className={styles.overviewWrapper}>
-        <LaneBreadcrumb lane={currentLane} />
-        <Separator isPresentational />
+  return (
+    <div className={styles.overviewWrapper}>
+      {currentLane && <LaneBreadcrumb lane={currentLane} />}
+      {currentLane && <Separator isPresentational />}
+      {showHeader && (
         <ComponentOverview
           className={styles.componentOverviewBlock}
           displayName={component.displayName}
@@ -58,25 +49,11 @@ export function Overview({ titleBadges }: OverviewProps) {
           abstract={component.description}
           labels={component.labels}
           packageName={component.packageName}
-          titleBadges={badges}
+          titleBadges={flatten(titleBadges.values())}
           componentDescriptor={componentDescriptor}
           deprecation={component.deprecation}
         />
-        <ComponentPreview
-          component={component}
-          style={{ width: '100%', height: '100%' }}
-          previewName="overview"
-          fullContentHeight
-          scrolling="no"
-        />
-      </div>
-    );
-  }
-
-  return currentLane ? (
-    <div className={styles.overviewWrapper}>
-      <LaneBreadcrumb lane={currentLane} />
-      <Separator isPresentational />
+      )}
       <ComponentPreview
         component={component}
         style={{ width: '100%', height: '100%' }}
@@ -85,12 +62,5 @@ export function Overview({ titleBadges }: OverviewProps) {
         scrolling="no"
       />
     </div>
-  ) : (
-    <ComponentPreview
-      component={component}
-      style={{ width: '100%', height: '100%' }}
-      previewName="overview"
-      fullContentHeight
-    />
   );
 }

package/overview.section.tsx

@@ -13,15 +13,14 @@ export class OverviewSection implements Section {
   ) {}
 
   navigationLink = {
-    href: '',
+    href: '.',
     exact: true,
     children: 'Overview',
   };
 
   route = {
-    path: '',
-    exact: true,
-    children: <Overview titleBadges={this.docs.titleBadgeSlot} />,
+    index: true,
+    element: <Overview titleBadges={this.docs.titleBadgeSlot} />,
   };
 
   order = 10;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/docs",
-  "version": "0.0.741",
+  "version": "0.0.744",
   "homepage": "https://bit.dev/teambit/docs/docs",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.docs",
     "name": "docs",
-    "version": "0.0.741"
+    "version": "0.0.744"
   },
   "dependencies": {
     "graphql-tag": "2.12.1",
@@ -15,23 +15,23 @@
     "core-js": "^3.0.0",
     "@teambit/harmony": "0.3.3",
     "@teambit/design.ui.separator": "0.0.354",
-    "@teambit/compiler": "0.0.741",
-    "@teambit/component": "0.0.741",
+    "@teambit/compiler": "0.0.744",
+    "@teambit/component": "0.0.744",
     "@teambit/docs.entities.doc": "0.0.3",
-    "@teambit/pkg": "0.0.741",
-    "@teambit/workspace": "0.0.741",
-    "@teambit/cli": "0.0.492",
-    "@teambit/dev-files": "0.0.741",
-    "@teambit/envs": "0.0.741",
-    "@teambit/graphql": "0.0.741",
-    "@teambit/logger": "0.0.584",
-    "@teambit/preview": "0.0.741",
+    "@teambit/pkg": "0.0.744",
+    "@teambit/workspace": "0.0.744",
+    "@teambit/cli": "0.0.493",
+    "@teambit/dev-files": "0.0.744",
+    "@teambit/envs": "0.0.744",
+    "@teambit/graphql": "0.0.744",
+    "@teambit/logger": "0.0.586",
+    "@teambit/preview": "0.0.744",
     "@teambit/component-id": "0.0.402",
-    "@teambit/component.ui.component-meta": "0.0.51",
-    "@teambit/ui": "0.0.741",
-    "@teambit/pubsub": "0.0.741",
+    "@teambit/component.ui.component-meta": "0.0.52",
+    "@teambit/ui": "0.0.744",
+    "@teambit/pubsub": "0.0.744",
     "@teambit/design.ui.surfaces.status-message-card": "0.0.7",
-    "@teambit/lanes.ui.lanes": "0.0.58",
+    "@teambit/lanes.ui.lanes": "0.0.60",
     "@teambit/preview.ui.component-preview": "0.0.493"
   },
   "devDependencies": {
@@ -45,7 +45,7 @@
     "@teambit/docs.content.docs-overview": "1.95.9"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.272",
+    "@teambit/legacy": "1.0.273",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -73,7 +73,7 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.272",
+        "@teambit/legacy": "1.0.273",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }

package/{preview-1653494536947.js → preview-1653827208409.js}

@@ -1,2 +1,2 @@
-export const compositions = [require('/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.docs_docs@0.0.741/dist/docs.composition.js')]
-export const overview = [require('/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.docs_docs@0.0.741/dist/docs.docs.mdx')]
+export const compositions = [require('/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.docs_docs@0.0.744/dist/docs.composition.js')]
+export const overview = [require('/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.docs_docs@0.0.744/dist/docs.docs.mdx')]