@teambit/docs 0.0.1046 → 0.0.1047

package/dist/docs.ui.runtime.d.ts

@@ -1,10 +1,11 @@
 /// <reference types="react" />
 import { ComponentUI } from '@teambit/component';
 import { ComponentCompareUI } from '@teambit/component-compare';
-import type { TitleBadgeSlot, TitleBadge } from './overview';
+import type { TitleBadgeSlot, TitleBadge, OverviewOptionsSlot, OverviewOptions } from './overview';
 export declare class DocsUI {
     readonly titleBadgeSlot: TitleBadgeSlot;
-    constructor(titleBadgeSlot: TitleBadgeSlot);
+    readonly overviewOptionsSlot: OverviewOptionsSlot;
+    constructor(titleBadgeSlot: TitleBadgeSlot, overviewOptionsSlot: OverviewOptionsSlot);
     /**
      * register a new title badge into the overview section of a component.
      */
@@ -14,9 +15,10 @@ export declare class DocsUI {
      */
     listTitleBadges(): TitleBadge[];
     getDocsCompare(): JSX.Element;
+    registerOverviewOptions(options: OverviewOptions): void;
     static dependencies: import("@teambit/harmony").Aspect[];
     static runtime: import("@teambit/harmony").RuntimeDefinition;
-    static slots: ((registerFn: () => string) => import("@teambit/harmony").SlotRegistry<TitleBadge>)[];
-    static provider([component, componentCompare]: [ComponentUI, ComponentCompareUI], config: any, [titleBadgeSlot]: [TitleBadgeSlot]): Promise<DocsUI>;
+    static slots: (((registerFn: () => string) => import("@teambit/harmony").SlotRegistry<TitleBadge>) | ((registerFn: () => string) => import("@teambit/harmony").SlotRegistry<OverviewOptions>))[];
+    static provider([component, componentCompare]: [ComponentUI, ComponentCompareUI], config: any, [titleBadgeSlot, overviewOptionsSlot]: [TitleBadgeSlot, OverviewOptionsSlot]): Promise<DocsUI>;
 }
 export default DocsUI;

package/dist/docs.ui.runtime.js

@@ -85,8 +85,9 @@ function _overview() {
   return data;
 }
 class DocsUI {
-  constructor(titleBadgeSlot) {
+  constructor(titleBadgeSlot, overviewOptionsSlot) {
     this.titleBadgeSlot = titleBadgeSlot;
+    this.overviewOptionsSlot = overviewOptionsSlot;
   }
 
   /**
@@ -106,12 +107,16 @@ class DocsUI {
   }
   getDocsCompare() {
     return /*#__PURE__*/_react().default.createElement(_docsUi().OverviewCompare, {
-      titleBadges: this.titleBadgeSlot
+      titleBadges: this.titleBadgeSlot,
+      overviewOptions: this.overviewOptionsSlot
     });
   }
-  static async provider([component, componentCompare], config, [titleBadgeSlot]) {
-    const docs = new DocsUI(titleBadgeSlot);
-    const section = new (_overview().OverviewSection)(titleBadgeSlot);
+  registerOverviewOptions(options) {
+    this.overviewOptionsSlot.register(options);
+  }
+  static async provider([component, componentCompare], config, [titleBadgeSlot, overviewOptionsSlot]) {
+    const docs = new DocsUI(titleBadgeSlot, overviewOptionsSlot);
+    const section = new (_overview().OverviewSection)(titleBadgeSlot, overviewOptionsSlot);
     const compareSection = new (_docsUi2().OverviewCompareSection)(docs);
     component.registerRoute(section.route);
     component.registerNavigation(section.navigationLink, section.order);
@@ -123,7 +128,7 @@ class DocsUI {
 exports.DocsUI = DocsUI;
 (0, _defineProperty2().default)(DocsUI, "dependencies", [_component().ComponentAspect, _componentCompare().default]);
 (0, _defineProperty2().default)(DocsUI, "runtime", _ui().UIRuntime);
-(0, _defineProperty2().default)(DocsUI, "slots", [_harmony().Slot.withType()]);
+(0, _defineProperty2().default)(DocsUI, "slots", [_harmony().Slot.withType(), _harmony().Slot.withType()]);
 var _default = DocsUI;
 exports.default = _default;
 _docs().DocsAspect.addRuntime(DocsUI);

package/dist/docs.ui.runtime.js.map

@@ -1 +1 @@
-{"version":3,"names":["DocsUI","constructor","titleBadgeSlot","registerTitleBadge","titleBadges","badges","Array","isArray","register","listTitleBadges","flatten","values","getDocsCompare","provider","component","componentCompare","config","docs","section","OverviewSection","compareSection","OverviewCompareSection","registerRoute","route","registerNavigation","navigationLink","order","registerRoutes","ComponentAspect","ComponentCompareAspect","UIRuntime","Slot","withType","DocsAspect","addRuntime"],"sources":["docs.ui.runtime.tsx"],"sourcesContent":["import React from 'react';\nimport { flatten } from 'lodash';\nimport { ComponentAspect, ComponentUI } from '@teambit/component';\nimport { Slot } from '@teambit/harmony';\nimport { UIRuntime } from '@teambit/ui';\nimport ComponentCompareAspect, { ComponentCompareUI } from '@teambit/component-compare';\nimport { OverviewCompare } from '@teambit/docs.ui.overview-compare';\nimport { OverviewCompareSection } from '@teambit/docs.ui.overview-compare-section';\nimport { DocsAspect } from './docs.aspect';\nimport { OverviewSection } from './overview.section';\nimport type { TitleBadgeSlot, TitleBadge } from './overview';\n\nexport class DocsUI {\n  constructor(readonly titleBadgeSlot: TitleBadgeSlot) {}\n\n  /**\n   * register a new title badge into the overview section of a component.\n   */\n  registerTitleBadge(titleBadges: TitleBadge | TitleBadge[]) {\n    const badges = Array.isArray(titleBadges) ? titleBadges : [titleBadges];\n    this.titleBadgeSlot.register(badges);\n    return this;\n  }\n\n  /**\n   * list all title badges registered.\n   */\n  listTitleBadges() {\n    return flatten(this.titleBadgeSlot.values());\n  }\n\n  getDocsCompare() {\n    return <OverviewCompare titleBadges={this.titleBadgeSlot} />;\n  }\n\n  static dependencies = [ComponentAspect, ComponentCompareAspect];\n\n  static runtime = UIRuntime;\n\n  static slots = [Slot.withType<TitleBadge>()];\n\n  static async provider(\n    [component, componentCompare]: [ComponentUI, ComponentCompareUI],\n    config,\n    [titleBadgeSlot]: [TitleBadgeSlot]\n  ) {\n    const docs = new DocsUI(titleBadgeSlot);\n    const section = new OverviewSection(titleBadgeSlot);\n    const compareSection = new OverviewCompareSection(docs);\n\n    component.registerRoute(section.route);\n    component.registerNavigation(section.navigationLink, section.order);\n    componentCompare.registerNavigation(compareSection);\n    componentCompare.registerRoutes([compareSection.route]);\n    return docs;\n  }\n}\n\nexport default DocsUI;\n\nDocsAspect.addRuntime(DocsUI);\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;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;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAGO,MAAMA,MAAM,CAAC;EAClBC,WAAW,CAAUC,cAA8B,EAAE;IAAA,KAAhCA,cAA8B,GAA9BA,cAA8B;EAAG;;EAEtD;AACF;AACA;EACEC,kBAAkB,CAACC,WAAsC,EAAE;IACzD,MAAMC,MAAM,GAAGC,KAAK,CAACC,OAAO,CAACH,WAAW,CAAC,GAAGA,WAAW,GAAG,CAACA,WAAW,CAAC;IACvE,IAAI,CAACF,cAAc,CAACM,QAAQ,CAACH,MAAM,CAAC;IACpC,OAAO,IAAI;EACb;;EAEA;AACF;AACA;EACEI,eAAe,GAAG;IAChB,OAAO,IAAAC,iBAAO,EAAC,IAAI,CAACR,cAAc,CAACS,MAAM,EAAE,CAAC;EAC9C;EAEAC,cAAc,GAAG;IACf,oBAAO,+BAAC,yBAAe;MAAC,WAAW,EAAE,IAAI,CAACV;IAAe,EAAG;EAC9D;EAQA,aAAaW,QAAQ,CACnB,CAACC,SAAS,EAAEC,gBAAgB,CAAoC,EAChEC,MAAM,EACN,CAACd,cAAc,CAAmB,EAClC;IACA,MAAMe,IAAI,GAAG,IAAIjB,MAAM,CAACE,cAAc,CAAC;IACvC,MAAMgB,OAAO,GAAG,KAAIC,2BAAe,EAACjB,cAAc,CAAC;IACnD,MAAMkB,cAAc,GAAG,KAAIC,iCAAsB,EAACJ,IAAI,CAAC;IAEvDH,SAAS,CAACQ,aAAa,CAACJ,OAAO,CAACK,KAAK,CAAC;IACtCT,SAAS,CAACU,kBAAkB,CAACN,OAAO,CAACO,cAAc,EAAEP,OAAO,CAACQ,KAAK,CAAC;IACnEX,gBAAgB,CAACS,kBAAkB,CAACJ,cAAc,CAAC;IACnDL,gBAAgB,CAACY,cAAc,CAAC,CAACP,cAAc,CAACG,KAAK,CAAC,CAAC;IACvD,OAAON,IAAI;EACb;AACF;AAAC;AAAA,gCA5CYjB,MAAM,kBAuBK,CAAC4B,4BAAe,EAAEC,2BAAsB,CAAC;AAAA,gCAvBpD7B,MAAM,aAyBA8B,eAAS;AAAA,gCAzBf9B,MAAM,WA2BF,CAAC+B,eAAI,CAACC,QAAQ,EAAc,CAAC;AAAA,eAmB/BhC,MAAM;AAAA;AAErBiC,kBAAU,CAACC,UAAU,CAAClC,MAAM,CAAC"}
+{"version":3,"names":["DocsUI","constructor","titleBadgeSlot","overviewOptionsSlot","registerTitleBadge","titleBadges","badges","Array","isArray","register","listTitleBadges","flatten","values","getDocsCompare","registerOverviewOptions","options","provider","component","componentCompare","config","docs","section","OverviewSection","compareSection","OverviewCompareSection","registerRoute","route","registerNavigation","navigationLink","order","registerRoutes","ComponentAspect","ComponentCompareAspect","UIRuntime","Slot","withType","DocsAspect","addRuntime"],"sources":["docs.ui.runtime.tsx"],"sourcesContent":["import React from 'react';\nimport { flatten } from 'lodash';\nimport { ComponentAspect, ComponentUI } from '@teambit/component';\nimport { Slot } from '@teambit/harmony';\nimport { UIRuntime } from '@teambit/ui';\nimport ComponentCompareAspect, { ComponentCompareUI } from '@teambit/component-compare';\nimport { OverviewCompare } from '@teambit/docs.ui.overview-compare';\nimport { OverviewCompareSection } from '@teambit/docs.ui.overview-compare-section';\nimport { DocsAspect } from './docs.aspect';\nimport { OverviewSection } from './overview.section';\nimport type { TitleBadgeSlot, TitleBadge, OverviewOptionsSlot, OverviewOptions } from './overview';\n\nexport class DocsUI {\n  constructor(readonly titleBadgeSlot: TitleBadgeSlot, readonly overviewOptionsSlot: OverviewOptionsSlot) {}\n\n  /**\n   * register a new title badge into the overview section of a component.\n   */\n  registerTitleBadge(titleBadges: TitleBadge | TitleBadge[]) {\n    const badges = Array.isArray(titleBadges) ? titleBadges : [titleBadges];\n    this.titleBadgeSlot.register(badges);\n    return this;\n  }\n\n  /**\n   * list all title badges registered.\n   */\n  listTitleBadges() {\n    return flatten(this.titleBadgeSlot.values());\n  }\n\n  getDocsCompare() {\n    return <OverviewCompare titleBadges={this.titleBadgeSlot} overviewOptions={this.overviewOptionsSlot} />;\n  }\n\n  registerOverviewOptions(options: OverviewOptions) {\n    this.overviewOptionsSlot.register(options);\n  }\n\n  static dependencies = [ComponentAspect, ComponentCompareAspect];\n\n  static runtime = UIRuntime;\n\n  static slots = [Slot.withType<TitleBadge>(), Slot.withType<OverviewOptions>()];\n\n  static async provider(\n    [component, componentCompare]: [ComponentUI, ComponentCompareUI],\n    config,\n    [titleBadgeSlot, overviewOptionsSlot]: [TitleBadgeSlot, OverviewOptionsSlot]\n  ) {\n    const docs = new DocsUI(titleBadgeSlot, overviewOptionsSlot);\n    const section = new OverviewSection(titleBadgeSlot, overviewOptionsSlot);\n    const compareSection = new OverviewCompareSection(docs);\n\n    component.registerRoute(section.route);\n    component.registerNavigation(section.navigationLink, section.order);\n    componentCompare.registerNavigation(compareSection);\n    componentCompare.registerRoutes([compareSection.route]);\n    return docs;\n  }\n}\n\nexport default DocsUI;\n\nDocsAspect.addRuntime(DocsUI);\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;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;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAGO,MAAMA,MAAM,CAAC;EAClBC,WAAW,CAAUC,cAA8B,EAAWC,mBAAwC,EAAE;IAAA,KAAnFD,cAA8B,GAA9BA,cAA8B;IAAA,KAAWC,mBAAwC,GAAxCA,mBAAwC;EAAG;;EAEzG;AACF;AACA;EACEC,kBAAkB,CAACC,WAAsC,EAAE;IACzD,MAAMC,MAAM,GAAGC,KAAK,CAACC,OAAO,CAACH,WAAW,CAAC,GAAGA,WAAW,GAAG,CAACA,WAAW,CAAC;IACvE,IAAI,CAACH,cAAc,CAACO,QAAQ,CAACH,MAAM,CAAC;IACpC,OAAO,IAAI;EACb;;EAEA;AACF;AACA;EACEI,eAAe,GAAG;IAChB,OAAO,IAAAC,iBAAO,EAAC,IAAI,CAACT,cAAc,CAACU,MAAM,EAAE,CAAC;EAC9C;EAEAC,cAAc,GAAG;IACf,oBAAO,+BAAC,yBAAe;MAAC,WAAW,EAAE,IAAI,CAACX,cAAe;MAAC,eAAe,EAAE,IAAI,CAACC;IAAoB,EAAG;EACzG;EAEAW,uBAAuB,CAACC,OAAwB,EAAE;IAChD,IAAI,CAACZ,mBAAmB,CAACM,QAAQ,CAACM,OAAO,CAAC;EAC5C;EAQA,aAAaC,QAAQ,CACnB,CAACC,SAAS,EAAEC,gBAAgB,CAAoC,EAChEC,MAAM,EACN,CAACjB,cAAc,EAAEC,mBAAmB,CAAwC,EAC5E;IACA,MAAMiB,IAAI,GAAG,IAAIpB,MAAM,CAACE,cAAc,EAAEC,mBAAmB,CAAC;IAC5D,MAAMkB,OAAO,GAAG,KAAIC,2BAAe,EAACpB,cAAc,EAAEC,mBAAmB,CAAC;IACxE,MAAMoB,cAAc,GAAG,KAAIC,iCAAsB,EAACJ,IAAI,CAAC;IAEvDH,SAAS,CAACQ,aAAa,CAACJ,OAAO,CAACK,KAAK,CAAC;IACtCT,SAAS,CAACU,kBAAkB,CAACN,OAAO,CAACO,cAAc,EAAEP,OAAO,CAACQ,KAAK,CAAC;IACnEX,gBAAgB,CAACS,kBAAkB,CAACJ,cAAc,CAAC;IACnDL,gBAAgB,CAACY,cAAc,CAAC,CAACP,cAAc,CAACG,KAAK,CAAC,CAAC;IACvD,OAAON,IAAI;EACb;AACF;AAAC;AAAA,gCAhDYpB,MAAM,kBA2BK,CAAC+B,4BAAe,EAAEC,2BAAsB,CAAC;AAAA,gCA3BpDhC,MAAM,aA6BAiC,eAAS;AAAA,gCA7BfjC,MAAM,WA+BF,CAACkC,eAAI,CAACC,QAAQ,EAAc,EAAED,eAAI,CAACC,QAAQ,EAAmB,CAAC;AAAA,eAmBjEnC,MAAM;AAAA;AAErBoC,kBAAU,CAACC,UAAU,CAACrC,MAAM,CAAC"}

package/dist/index.d.ts

@@ -10,7 +10,7 @@ export type { DocsPreview, DocsRootProps } from './docs.preview.runtime';
 export type { DocReader } from './doc-reader';
 export type { Docs, Example } from './docs';
 export { defaultDocs } from './docs';
-export type { TitleBadgeSlot, TitleBadge } from './overview';
+export type { TitleBadgeSlot, TitleBadge, OverviewOptionsSlot, OverviewOptions } from './overview';
 export { Overview, BadgePosition } from './overview';
 export { DocsAspect };
 export default DocsAspect;

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["DocsAspect"],"sources":["index.ts"],"sourcesContent":["import { DocsAspect } from './docs.aspect';\n\n/**\n * Doc entity.\n * @deprecated - please dont use this. use directly from @teambit/docs.entities.doc.\n */\nexport { Doc, DocProp, DocPropList } from '@teambit/docs.entities.doc';\n\nexport type { DocsMain } from './docs.main.runtime';\nexport type { DocsUI } from './docs.ui.runtime';\nexport type { DocsPreview, DocsRootProps } from './docs.preview.runtime';\nexport type { DocReader } from './doc-reader';\nexport type { Docs, Example } from './docs';\nexport { defaultDocs } from './docs';\n\nexport type { TitleBadgeSlot, TitleBadge } from './overview';\nexport { Overview, BadgePosition } from './overview';\n\nexport { DocsAspect };\nexport default DocsAspect;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAMA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAOA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAGA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAdA;AACA;AACA;AACA;AAHA,eAiBeA,kBAAU;AAAA"}
+{"version":3,"names":["DocsAspect"],"sources":["index.ts"],"sourcesContent":["import { DocsAspect } from './docs.aspect';\n\n/**\n * Doc entity.\n * @deprecated - please dont use this. use directly from @teambit/docs.entities.doc.\n */\nexport { Doc, DocProp, DocPropList } from '@teambit/docs.entities.doc';\n\nexport type { DocsMain } from './docs.main.runtime';\nexport type { DocsUI } from './docs.ui.runtime';\nexport type { DocsPreview, DocsRootProps } from './docs.preview.runtime';\nexport type { DocReader } from './doc-reader';\nexport type { Docs, Example } from './docs';\nexport { defaultDocs } from './docs';\n\nexport type { TitleBadgeSlot, TitleBadge, OverviewOptionsSlot, OverviewOptions } from './overview';\nexport { Overview, BadgePosition } from './overview';\n\nexport { DocsAspect };\nexport default DocsAspect;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAMA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAOA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAGA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAdA;AACA;AACA;AACA;AAHA,eAiBeA,kBAAU;AAAA"}

package/dist/overview/index.d.ts

@@ -1,2 +1,2 @@
 export { Overview, BadgePosition } from './overview';
-export type { TitleBadgeSlot, TitleBadge } from './overview';
+export type { TitleBadgeSlot, TitleBadge, OverviewOptionsSlot, OverviewOptions } from './overview';

package/dist/overview/index.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["export { Overview, BadgePosition } from './overview';\nexport type { TitleBadgeSlot, TitleBadge } from './overview';\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA"}
+{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["export { Overview, BadgePosition } from './overview';\nexport type { TitleBadgeSlot, TitleBadge, OverviewOptionsSlot, OverviewOptions } from './overview';\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA"}

package/dist/overview/overview.d.ts

@@ -12,7 +12,12 @@ export declare type TitleBadge = {
     position?: BadgePosition;
 };
 export declare type TitleBadgeSlot = SlotRegistry<TitleBadge[]>;
+export declare type OverviewOptions = () => {
+    queryParams?: string;
+};
+export declare type OverviewOptionsSlot = SlotRegistry<OverviewOptions>;
 export declare type OverviewProps = {
     titleBadges: TitleBadgeSlot;
+    overviewOptions: OverviewOptionsSlot;
 };
-export declare function Overview({ titleBadges }: OverviewProps): JSX.Element;
+export declare function Overview({ titleBadges, overviewOptions }: OverviewProps): JSX.Element;

package/dist/overview/overview.js

@@ -92,11 +92,13 @@ exports.BadgePosition = BadgePosition;
   BadgePosition[BadgePosition["Package"] = 3] = "Package";
 })(BadgePosition || (exports.BadgePosition = BadgePosition = {}));
 function Overview({
-  titleBadges
+  titleBadges,
+  overviewOptions
 }) {
   var _component$preview, _component$preview2, _component$preview3, _component$preview4, _component$preview5;
   const component = (0, _react().useContext)(_component().ComponentContext);
   const componentDescriptor = (0, _component().useComponentDescriptor)();
+  const overviewProps = (0, _lodash().flatten)(overviewOptions.values())[0];
   const showHeader = !((_component$preview = component.preview) !== null && _component$preview !== void 0 && _component$preview.legacyHeader);
   const [isLoading, setLoading] = (0, _react().useState)(true);
   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, {
@@ -115,6 +117,7 @@ function Overview({
   });
   const isScaling = (_component$preview2 = component.preview) === null || _component$preview2 === void 0 ? void 0 : _component$preview2.isScaling;
   const iframeQueryParams = `skipIncludes=${((_component$preview3 = component.preview) === null || _component$preview3 === void 0 ? void 0 : _component$preview3.skipIncludes) || 'false'}`;
+  const overviewPropsValues = overviewProps && overviewProps();
   return /*#__PURE__*/_react().default.createElement("div", {
     className: _overviewModule().default.overviewWrapper
   }, showHeader && /*#__PURE__*/_react().default.createElement(_componentUi().ComponentOverview, {
@@ -138,7 +141,7 @@ function Overview({
     },
     previewName: "overview",
     pubsub: true,
-    queryParams: [iframeQueryParams],
+    queryParams: [iframeQueryParams, (overviewPropsValues === null || overviewPropsValues === void 0 ? void 0 : overviewPropsValues.queryParams) || ''],
     viewport: null,
     fullContentHeight: true,
     disableScroll: true

package/dist/overview/overview.js.map

@@ -1 +1 @@
-{"version":3,"names":["BadgePosition","Overview","titleBadges","component","useContext","ComponentContext","componentDescriptor","useComponentDescriptor","showHeader","preview","legacyHeader","isLoading","setLoading","useState","buildStatus","host","margin","isScaling","iframeQueryParams","skipIncludes","styles","overviewWrapper","classNames","componentOverviewBlock","legacyPreview","displayName","version","description","labels","packageName","flatten","values","readme","width","height","overviewPropsTable","id","toString"],"sources":["overview.tsx"],"sourcesContent":["import React, { useContext, ComponentType, useState } from 'react';\nimport classNames from 'classnames';\nimport { flatten } from 'lodash';\n// import { Icon } from '@teambit/design.elements.icon';\nimport { PropertiesTable } from '@teambit/react.ui.docs.properties-table';\n// import { LinkedHeading } from '@teambit/documenter.ui.linked-heading';\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 } from '@teambit/component.ui.component-meta';\nimport { CompositionGallery } from '@teambit/compositions.panels.composition-gallery';\n// import { ReadmeSkeleton } from './readme-skeleton';\nimport styles from './overview.module.scss';\n\nexport enum BadgePosition {\n  Title,\n  SubTitle,\n  Labels,\n  Package,\n}\n\nexport type TitleBadge = {\n  component: ComponentType<any>;\n  weight?: number;\n  position?: BadgePosition;\n};\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\n  const showHeader = !component.preview?.legacyHeader;\n  const [isLoading, setLoading] = useState(true);\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  const isScaling = component.preview?.isScaling;\n\n  const iframeQueryParams = `skipIncludes=${component.preview?.skipIncludes || 'false'}`;\n\n  return (\n    <div className={styles.overviewWrapper}>\n      {showHeader && (\n        <ComponentOverview\n          className={classNames(styles.componentOverviewBlock, !isScaling && styles.legacyPreview)}\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          component={component}\n        />\n      )}\n\n      {/* TODO - @oded replace with new panel card same for compositions. */}\n\n      {/* <LinkedHeading size=\"xs\" className={styles.title}>\n        <Icon of=\"text\" /> <span>README</span>\n      </LinkedHeading> */}\n      <div className={styles.readme}>\n        {/* {isLoading && <ReadmeSkeleton />} */}\n        <ComponentPreview\n          onLoad={() => setLoading(false)}\n          component={component}\n          style={{ width: '100%', height: '100%' }}\n          previewName=\"overview\"\n          pubsub={true}\n          queryParams={[iframeQueryParams]}\n          viewport={null}\n          fullContentHeight\n          disableScroll={true}\n        />\n        {component.preview?.skipIncludes && <CompositionGallery isLoading={isLoading} component={component} />}\n        {component.preview?.skipIncludes && (\n          <PropertiesTable className={styles.overviewPropsTable} componentId={component.id.toString()} />\n        )}\n      </div>\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;AAEA;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;AAEA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAA4C;AAAA;AAV5C;AAEA;AAOA;AAAA,IAGYA,aAAa;AAAA;AAAA,WAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;AAAA,GAAbA,aAAa,6BAAbA,aAAa;AAmBlB,SAASC,QAAQ,CAAC;EAAEC;AAA2B,CAAC,EAAE;EAAA;EACvD,MAAMC,SAAS,GAAG,IAAAC,mBAAU,EAACC,6BAAgB,CAAC;EAC9C,MAAMC,mBAAmB,GAAG,IAAAC,mCAAsB,GAAE;EAEpD,MAAMC,UAAU,GAAG,wBAACL,SAAS,CAACM,OAAO,+CAAjB,mBAAmBC,YAAY;EACnD,MAAM,CAACC,SAAS,EAAEC,UAAU,CAAC,GAAG,IAAAC,iBAAQ,EAAC,IAAI,CAAC;EAE9C,IAAI,CAAAV,SAAS,aAATA,SAAS,uBAATA,SAAS,CAAEW,WAAW,MAAK,SAAS,IAAI,CAAAX,SAAS,aAATA,SAAS,uBAATA,SAAS,CAAEY,IAAI,MAAK,qBAAqB,EACnF,oBACE,+BAAC,qCAAiB;IAAC,KAAK,EAAE;MAAEC,MAAM,EAAE;IAAO,CAAE;IAAC,MAAM,EAAC,YAAY;IAAC,KAAK,EAAC;EAA2B,+BAE/E;EAGxB,IAAI,CAAAb,SAAS,aAATA,SAAS,uBAATA,SAAS,CAAEW,WAAW,MAAK,QAAQ,IAAI,CAAAX,SAAS,aAATA,SAAS,uBAATA,SAAS,CAAEY,IAAI,MAAK,qBAAqB,EAClF,oBAAO,+BAAC,qCAAiB;IAAC,KAAK,EAAE;MAAEC,MAAM,EAAE;IAAO,CAAE;IAAC,MAAM,EAAC,SAAS;IAAC,KAAK,EAAC;EAAkC,EAAG;EAEnH,MAAMC,SAAS,0BAAGd,SAAS,CAACM,OAAO,wDAAjB,oBAAmBQ,SAAS;EAE9C,MAAMC,iBAAiB,GAAI,gBAAe,wBAAAf,SAAS,CAACM,OAAO,wDAAjB,oBAAmBU,YAAY,KAAI,OAAQ,EAAC;EAEtF,oBACE;IAAK,SAAS,EAAEC,yBAAM,CAACC;EAAgB,GACpCb,UAAU,iBACT,+BAAC,gCAAiB;IAChB,SAAS,EAAE,IAAAc,qBAAU,EAACF,yBAAM,CAACG,sBAAsB,EAAE,CAACN,SAAS,IAAIG,yBAAM,CAACI,aAAa,CAAE;IACzF,WAAW,EAAErB,SAAS,CAACsB,WAAY;IACnC,OAAO,EAAEtB,SAAS,CAACuB,OAAQ;IAC3B,QAAQ,EAAEvB,SAAS,CAACwB,WAAY;IAChC,MAAM,EAAExB,SAAS,CAACyB,MAAO;IACzB,WAAW,EAAEzB,SAAS,CAAC0B,WAAY;IACnC,WAAW,EAAE,IAAAC,iBAAO,EAAC5B,WAAW,CAAC6B,MAAM,EAAE,CAAE;IAC3C,mBAAmB,EAAEzB,mBAAoB;IACzC,SAAS,EAAEH;EAAU,EAExB,eAOD;IAAK,SAAS,EAAEiB,yBAAM,CAACY;EAAO,gBAE5B,+BAAC,6BAAgB;IACf,MAAM,EAAE,MAAMpB,UAAU,CAAC,KAAK,CAAE;IAChC,SAAS,EAAET,SAAU;IACrB,KAAK,EAAE;MAAE8B,KAAK,EAAE,MAAM;MAAEC,MAAM,EAAE;IAAO,CAAE;IACzC,WAAW,EAAC,UAAU;IACtB,MAAM,EAAE,IAAK;IACb,WAAW,EAAE,CAAChB,iBAAiB,CAAE;IACjC,QAAQ,EAAE,IAAK;IACf,iBAAiB;IACjB,aAAa,EAAE;EAAK,EACpB,EACD,wBAAAf,SAAS,CAACM,OAAO,wDAAjB,oBAAmBU,YAAY,kBAAI,+BAAC,wCAAkB;IAAC,SAAS,EAAER,SAAU;IAAC,SAAS,EAAER;EAAU,EAAG,EACrG,wBAAAA,SAAS,CAACM,OAAO,wDAAjB,oBAAmBU,YAAY,kBAC9B,+BAAC,8BAAe;IAAC,SAAS,EAAEC,yBAAM,CAACe,kBAAmB;IAAC,WAAW,EAAEhC,SAAS,CAACiC,EAAE,CAACC,QAAQ;EAAG,EAC7F,CACG,CACF;AAEV"}
+{"version":3,"names":["BadgePosition","Overview","titleBadges","overviewOptions","component","useContext","ComponentContext","componentDescriptor","useComponentDescriptor","overviewProps","flatten","values","showHeader","preview","legacyHeader","isLoading","setLoading","useState","buildStatus","host","margin","isScaling","iframeQueryParams","skipIncludes","overviewPropsValues","styles","overviewWrapper","classNames","componentOverviewBlock","legacyPreview","displayName","version","description","labels","packageName","readme","width","height","queryParams","overviewPropsTable","id","toString"],"sources":["overview.tsx"],"sourcesContent":["import React, { useContext, ComponentType, useState } from 'react';\nimport classNames from 'classnames';\nimport { flatten } from 'lodash';\n// import { Icon } from '@teambit/design.elements.icon';\nimport { PropertiesTable } from '@teambit/react.ui.docs.properties-table';\n// import { LinkedHeading } from '@teambit/documenter.ui.linked-heading';\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 } from '@teambit/component.ui.component-meta';\nimport { CompositionGallery } from '@teambit/compositions.panels.composition-gallery';\n// import { ReadmeSkeleton } from './readme-skeleton';\nimport styles from './overview.module.scss';\n\nexport enum BadgePosition {\n  Title,\n  SubTitle,\n  Labels,\n  Package,\n}\n\nexport type TitleBadge = {\n  component: ComponentType<any>;\n  weight?: number;\n  position?: BadgePosition;\n};\n\nexport type TitleBadgeSlot = SlotRegistry<TitleBadge[]>;\n\nexport type OverviewOptions = () => { queryParams?: string };\n\nexport type OverviewOptionsSlot = SlotRegistry<OverviewOptions>;\n\nexport type OverviewProps = {\n  titleBadges: TitleBadgeSlot;\n  overviewOptions: OverviewOptionsSlot;\n};\n\nexport function Overview({ titleBadges, overviewOptions }: OverviewProps) {\n  const component = useContext(ComponentContext);\n  const componentDescriptor = useComponentDescriptor();\n  const overviewProps = flatten(overviewOptions.values())[0];\n  const showHeader = !component.preview?.legacyHeader;\n  const [isLoading, setLoading] = useState(true);\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  const isScaling = component.preview?.isScaling;\n\n  const iframeQueryParams = `skipIncludes=${component.preview?.skipIncludes || 'false'}`;\n\n  const overviewPropsValues = overviewProps && overviewProps();\n\n  return (\n    <div className={styles.overviewWrapper}>\n      {showHeader && (\n        <ComponentOverview\n          className={classNames(styles.componentOverviewBlock, !isScaling && styles.legacyPreview)}\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          component={component}\n        />\n      )}\n\n      {/* TODO - @oded replace with new panel card same for compositions. */}\n\n      {/* <LinkedHeading size=\"xs\" className={styles.title}>\n        <Icon of=\"text\" /> <span>README</span>\n      </LinkedHeading> */}\n      <div className={styles.readme}>\n        {/* {isLoading && <ReadmeSkeleton />} */}\n        <ComponentPreview\n          onLoad={() => setLoading(false)}\n          component={component}\n          style={{ width: '100%', height: '100%' }}\n          previewName=\"overview\"\n          pubsub={true}\n          queryParams={[iframeQueryParams, overviewPropsValues?.queryParams || '']}\n          viewport={null}\n          fullContentHeight\n          disableScroll={true}\n        />\n        {component.preview?.skipIncludes && <CompositionGallery isLoading={isLoading} component={component} />}\n        {component.preview?.skipIncludes && (\n          <PropertiesTable className={styles.overviewPropsTable} componentId={component.id.toString()} />\n        )}\n      </div>\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;AAEA;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;AAEA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAA4C;AAAA;AAV5C;AAEA;AAOA;AAAA,IAGYA,aAAa;AAAA;AAAA,WAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;AAAA,GAAbA,aAAa,6BAAbA,aAAa;AAwBlB,SAASC,QAAQ,CAAC;EAAEC,WAAW;EAAEC;AAA+B,CAAC,EAAE;EAAA;EACxE,MAAMC,SAAS,GAAG,IAAAC,mBAAU,EAACC,6BAAgB,CAAC;EAC9C,MAAMC,mBAAmB,GAAG,IAAAC,mCAAsB,GAAE;EACpD,MAAMC,aAAa,GAAG,IAAAC,iBAAO,EAACP,eAAe,CAACQ,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;EAC1D,MAAMC,UAAU,GAAG,wBAACR,SAAS,CAACS,OAAO,+CAAjB,mBAAmBC,YAAY;EACnD,MAAM,CAACC,SAAS,EAAEC,UAAU,CAAC,GAAG,IAAAC,iBAAQ,EAAC,IAAI,CAAC;EAE9C,IAAI,CAAAb,SAAS,aAATA,SAAS,uBAATA,SAAS,CAAEc,WAAW,MAAK,SAAS,IAAI,CAAAd,SAAS,aAATA,SAAS,uBAATA,SAAS,CAAEe,IAAI,MAAK,qBAAqB,EACnF,oBACE,+BAAC,qCAAiB;IAAC,KAAK,EAAE;MAAEC,MAAM,EAAE;IAAO,CAAE;IAAC,MAAM,EAAC,YAAY;IAAC,KAAK,EAAC;EAA2B,+BAE/E;EAGxB,IAAI,CAAAhB,SAAS,aAATA,SAAS,uBAATA,SAAS,CAAEc,WAAW,MAAK,QAAQ,IAAI,CAAAd,SAAS,aAATA,SAAS,uBAATA,SAAS,CAAEe,IAAI,MAAK,qBAAqB,EAClF,oBAAO,+BAAC,qCAAiB;IAAC,KAAK,EAAE;MAAEC,MAAM,EAAE;IAAO,CAAE;IAAC,MAAM,EAAC,SAAS;IAAC,KAAK,EAAC;EAAkC,EAAG;EAEnH,MAAMC,SAAS,0BAAGjB,SAAS,CAACS,OAAO,wDAAjB,oBAAmBQ,SAAS;EAE9C,MAAMC,iBAAiB,GAAI,gBAAe,wBAAAlB,SAAS,CAACS,OAAO,wDAAjB,oBAAmBU,YAAY,KAAI,OAAQ,EAAC;EAEtF,MAAMC,mBAAmB,GAAGf,aAAa,IAAIA,aAAa,EAAE;EAE5D,oBACE;IAAK,SAAS,EAAEgB,yBAAM,CAACC;EAAgB,GACpCd,UAAU,iBACT,+BAAC,gCAAiB;IAChB,SAAS,EAAE,IAAAe,qBAAU,EAACF,yBAAM,CAACG,sBAAsB,EAAE,CAACP,SAAS,IAAII,yBAAM,CAACI,aAAa,CAAE;IACzF,WAAW,EAAEzB,SAAS,CAAC0B,WAAY;IACnC,OAAO,EAAE1B,SAAS,CAAC2B,OAAQ;IAC3B,QAAQ,EAAE3B,SAAS,CAAC4B,WAAY;IAChC,MAAM,EAAE5B,SAAS,CAAC6B,MAAO;IACzB,WAAW,EAAE7B,SAAS,CAAC8B,WAAY;IACnC,WAAW,EAAE,IAAAxB,iBAAO,EAACR,WAAW,CAACS,MAAM,EAAE,CAAE;IAC3C,mBAAmB,EAAEJ,mBAAoB;IACzC,SAAS,EAAEH;EAAU,EAExB,eAOD;IAAK,SAAS,EAAEqB,yBAAM,CAACU;EAAO,gBAE5B,+BAAC,6BAAgB;IACf,MAAM,EAAE,MAAMnB,UAAU,CAAC,KAAK,CAAE;IAChC,SAAS,EAAEZ,SAAU;IACrB,KAAK,EAAE;MAAEgC,KAAK,EAAE,MAAM;MAAEC,MAAM,EAAE;IAAO,CAAE;IACzC,WAAW,EAAC,UAAU;IACtB,MAAM,EAAE,IAAK;IACb,WAAW,EAAE,CAACf,iBAAiB,EAAE,CAAAE,mBAAmB,aAAnBA,mBAAmB,uBAAnBA,mBAAmB,CAAEc,WAAW,KAAI,EAAE,CAAE;IACzE,QAAQ,EAAE,IAAK;IACf,iBAAiB;IACjB,aAAa,EAAE;EAAK,EACpB,EACD,wBAAAlC,SAAS,CAACS,OAAO,wDAAjB,oBAAmBU,YAAY,kBAAI,+BAAC,wCAAkB;IAAC,SAAS,EAAER,SAAU;IAAC,SAAS,EAAEX;EAAU,EAAG,EACrG,wBAAAA,SAAS,CAACS,OAAO,wDAAjB,oBAAmBU,YAAY,kBAC9B,+BAAC,8BAAe;IAAC,SAAS,EAAEE,yBAAM,CAACc,kBAAmB;IAAC,WAAW,EAAEnC,SAAS,CAACoC,EAAE,CAACC,QAAQ;EAAG,EAC7F,CACG,CACF;AAEV"}

package/dist/overview.section.d.ts

@@ -1,16 +1,17 @@
 /// <reference types="react" />
 import { Section } from '@teambit/component';
-import { TitleBadgeSlot } from './overview';
+import { TitleBadgeSlot, OverviewOptionsSlot } from './overview';
 export declare class OverviewSection implements Section {
     /**
      * title badge slot.
      */
     private titleBadgeSlot;
+    private overviewOptionsSlot;
     constructor(
     /**
      * title badge slot.
      */
-    titleBadgeSlot: TitleBadgeSlot);
+    titleBadgeSlot: TitleBadgeSlot, overviewOptionsSlot: OverviewOptionsSlot);
     navigationLink: {
         href: string;
         exact: boolean;

package/dist/overview.section.js

@@ -31,8 +31,9 @@ class OverviewSection {
   /**
    * title badge slot.
    */
-  titleBadgeSlot) {
+  titleBadgeSlot, overviewOptionsSlot) {
     this.titleBadgeSlot = titleBadgeSlot;
+    this.overviewOptionsSlot = overviewOptionsSlot;
     (0, _defineProperty2().default)(this, "navigationLink", {
       href: '.',
       exact: true,
@@ -41,7 +42,8 @@ class OverviewSection {
     (0, _defineProperty2().default)(this, "route", {
       index: true,
       element: /*#__PURE__*/_react().default.createElement(_overview().Overview, {
-        titleBadges: this.titleBadgeSlot
+        titleBadges: this.titleBadgeSlot,
+        overviewOptions: this.overviewOptionsSlot
       })
     });
     (0, _defineProperty2().default)(this, "order", 10);

package/dist/overview.section.js.map

@@ -1 +1 @@
-{"version":3,"names":["OverviewSection","constructor","titleBadgeSlot","href","exact","children","index","element"],"sources":["overview.section.tsx"],"sourcesContent":["import React from 'react';\nimport { Section } from '@teambit/component';\nimport { Overview, TitleBadgeSlot } from './overview';\n\nexport class OverviewSection implements Section {\n  constructor(\n    /**\n     * title badge slot.\n     */\n    private titleBadgeSlot: TitleBadgeSlot\n  ) {}\n\n  navigationLink = {\n    href: '.',\n    exact: true,\n    children: 'Overview',\n  };\n\n  route = {\n    index: true,\n    element: <Overview titleBadges={this.titleBadgeSlot} />,\n  };\n\n  order = 10;\n}\n"],"mappings":";;;;;;;;;;;;;;AAAA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAEA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAEO,MAAMA,eAAe,CAAoB;EAC9CC,WAAW;EACT;AACJ;AACA;EACYC,cAA8B,EACtC;IAAA,KADQA,cAA8B,GAA9BA,cAA8B;IAAA,wDAGvB;MACfC,IAAI,EAAE,GAAG;MACTC,KAAK,EAAE,IAAI;MACXC,QAAQ,EAAE;IACZ,CAAC;IAAA,+CAEO;MACNC,KAAK,EAAE,IAAI;MACXC,OAAO,eAAE,+BAAC,oBAAQ;QAAC,WAAW,EAAE,IAAI,CAACL;MAAe;IACtD,CAAC;IAAA,+CAEO,EAAE;EAbP;AAcL;AAAC"}
+{"version":3,"names":["OverviewSection","constructor","titleBadgeSlot","overviewOptionsSlot","href","exact","children","index","element"],"sources":["overview.section.tsx"],"sourcesContent":["import React from 'react';\nimport { Section } from '@teambit/component';\nimport { Overview, TitleBadgeSlot, OverviewOptionsSlot } from './overview';\n\nexport class OverviewSection implements Section {\n  constructor(\n    /**\n     * title badge slot.\n     */\n    private titleBadgeSlot: TitleBadgeSlot,\n    private overviewOptionsSlot: OverviewOptionsSlot\n  ) {}\n\n  navigationLink = {\n    href: '.',\n    exact: true,\n    children: 'Overview',\n  };\n\n  route = {\n    index: true,\n    element: <Overview titleBadges={this.titleBadgeSlot} overviewOptions={this.overviewOptionsSlot} />,\n  };\n\n  order = 10;\n}\n"],"mappings":";;;;;;;;;;;;;;AAAA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAEA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAEO,MAAMA,eAAe,CAAoB;EAC9CC,WAAW;EACT;AACJ;AACA;EACYC,cAA8B,EAC9BC,mBAAwC,EAChD;IAAA,KAFQD,cAA8B,GAA9BA,cAA8B;IAAA,KAC9BC,mBAAwC,GAAxCA,mBAAwC;IAAA,wDAGjC;MACfC,IAAI,EAAE,GAAG;MACTC,KAAK,EAAE,IAAI;MACXC,QAAQ,EAAE;IACZ,CAAC;IAAA,+CAEO;MACNC,KAAK,EAAE,IAAI;MACXC,OAAO,eAAE,+BAAC,oBAAQ;QAAC,WAAW,EAAE,IAAI,CAACN,cAAe;QAAC,eAAe,EAAE,IAAI,CAACC;MAAoB;IACjG,CAAC;IAAA,+CAEO,EAAE;EAbP;AAcL;AAAC"}

package/dist/{preview-1682999172371.js → preview-1683084947241.js}

@@ -1,5 +1,5 @@
-import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.docs_docs@0.0.1046/dist/docs.composition.js';
-import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.docs_docs@0.0.1046/dist/docs.docs.mdx';
+import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.docs_docs@0.0.1047/dist/docs.composition.js';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.docs_docs@0.0.1047/dist/docs.docs.mdx';
 
 export const compositions = [compositions_0];
 export const overview = [overview_0];

package/docs.ui.runtime.tsx

@@ -8,10 +8,10 @@ import { OverviewCompare } from '@teambit/docs.ui.overview-compare';
 import { OverviewCompareSection } from '@teambit/docs.ui.overview-compare-section';
 import { DocsAspect } from './docs.aspect';
 import { OverviewSection } from './overview.section';
-import type { TitleBadgeSlot, TitleBadge } from './overview';
+import type { TitleBadgeSlot, TitleBadge, OverviewOptionsSlot, OverviewOptions } from './overview';
 
 export class DocsUI {
-  constructor(readonly titleBadgeSlot: TitleBadgeSlot) {}
+  constructor(readonly titleBadgeSlot: TitleBadgeSlot, readonly overviewOptionsSlot: OverviewOptionsSlot) {}
 
   /**
    * register a new title badge into the overview section of a component.
@@ -30,22 +30,26 @@ export class DocsUI {
   }
 
   getDocsCompare() {
-    return <OverviewCompare titleBadges={this.titleBadgeSlot} />;
+    return <OverviewCompare titleBadges={this.titleBadgeSlot} overviewOptions={this.overviewOptionsSlot} />;
+  }
+
+  registerOverviewOptions(options: OverviewOptions) {
+    this.overviewOptionsSlot.register(options);
   }
 
   static dependencies = [ComponentAspect, ComponentCompareAspect];
 
   static runtime = UIRuntime;
 
-  static slots = [Slot.withType<TitleBadge>()];
+  static slots = [Slot.withType<TitleBadge>(), Slot.withType<OverviewOptions>()];
 
   static async provider(
     [component, componentCompare]: [ComponentUI, ComponentCompareUI],
     config,
-    [titleBadgeSlot]: [TitleBadgeSlot]
+    [titleBadgeSlot, overviewOptionsSlot]: [TitleBadgeSlot, OverviewOptionsSlot]
   ) {
-    const docs = new DocsUI(titleBadgeSlot);
-    const section = new OverviewSection(titleBadgeSlot);
+    const docs = new DocsUI(titleBadgeSlot, overviewOptionsSlot);
+    const section = new OverviewSection(titleBadgeSlot, overviewOptionsSlot);
     const compareSection = new OverviewCompareSection(docs);
 
     component.registerRoute(section.route);

package/overview/index.ts

@@ -1,2 +1,2 @@
 export { Overview, BadgePosition } from './overview';
-export type { TitleBadgeSlot, TitleBadge } from './overview';
+export type { TitleBadgeSlot, TitleBadge, OverviewOptionsSlot, OverviewOptions } from './overview';

package/overview/overview.tsx

@@ -28,14 +28,19 @@ export type TitleBadge = {
 
 export type TitleBadgeSlot = SlotRegistry<TitleBadge[]>;
 
+export type OverviewOptions = () => { queryParams?: string };
+
+export type OverviewOptionsSlot = SlotRegistry<OverviewOptions>;
+
 export type OverviewProps = {
   titleBadges: TitleBadgeSlot;
+  overviewOptions: OverviewOptionsSlot;
 };
 
-export function Overview({ titleBadges }: OverviewProps) {
+export function Overview({ titleBadges, overviewOptions }: OverviewProps) {
   const component = useContext(ComponentContext);
   const componentDescriptor = useComponentDescriptor();
-
+  const overviewProps = flatten(overviewOptions.values())[0];
   const showHeader = !component.preview?.legacyHeader;
   const [isLoading, setLoading] = useState(true);
 
@@ -53,6 +58,8 @@ export function Overview({ titleBadges }: OverviewProps) {
 
   const iframeQueryParams = `skipIncludes=${component.preview?.skipIncludes || 'false'}`;
 
+  const overviewPropsValues = overviewProps && overviewProps();
+
   return (
     <div className={styles.overviewWrapper}>
       {showHeader && (
@@ -82,7 +89,7 @@ export function Overview({ titleBadges }: OverviewProps) {
           style={{ width: '100%', height: '100%' }}
           previewName="overview"
           pubsub={true}
-          queryParams={[iframeQueryParams]}
+          queryParams={[iframeQueryParams, overviewPropsValues?.queryParams || '']}
           viewport={null}
           fullContentHeight
           disableScroll={true}

package/overview.section.tsx

@@ -1,13 +1,14 @@
 import React from 'react';
 import { Section } from '@teambit/component';
-import { Overview, TitleBadgeSlot } from './overview';
+import { Overview, TitleBadgeSlot, OverviewOptionsSlot } from './overview';
 
 export class OverviewSection implements Section {
   constructor(
     /**
      * title badge slot.
      */
-    private titleBadgeSlot: TitleBadgeSlot
+    private titleBadgeSlot: TitleBadgeSlot,
+    private overviewOptionsSlot: OverviewOptionsSlot
   ) {}
 
   navigationLink = {
@@ -18,7 +19,7 @@ export class OverviewSection implements Section {
 
   route = {
     index: true,
-    element: <Overview titleBadges={this.titleBadgeSlot} />,
+    element: <Overview titleBadges={this.titleBadgeSlot} overviewOptions={this.overviewOptionsSlot} />,
   };
 
   order = 10;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/docs",
-  "version": "0.0.1046",
+  "version": "0.0.1047",
   "homepage": "https://bit.cloud/teambit/docs/docs",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.docs",
     "name": "docs",
-    "version": "0.0.1046"
+    "version": "0.0.1047"
   },
   "dependencies": {
     "graphql-tag": "2.12.1",
@@ -19,24 +19,24 @@
     "@teambit/component-id": "0.0.427",
     "@teambit/design.ui.surfaces.status-message-card": "0.0.17",
     "@teambit/base-ui.loaders.skeleton": "1.0.1",
-    "@teambit/compiler": "0.0.1046",
-    "@teambit/component": "0.0.1046",
-    "@teambit/pkg": "0.0.1046",
-    "@teambit/workspace": "0.0.1046",
-    "@teambit/cli": "0.0.704",
-    "@teambit/dev-files": "0.0.1046",
-    "@teambit/envs": "0.0.1046",
-    "@teambit/graphql": "0.0.1046",
-    "@teambit/logger": "0.0.797",
-    "@teambit/preview": "0.0.1046",
-    "@teambit/component-compare": "0.0.294",
-    "@teambit/docs.ui.overview-compare-section": "0.0.11",
-    "@teambit/docs.ui.overview-compare": "0.0.223",
-    "@teambit/ui": "0.0.1046",
-    "@teambit/pubsub": "0.0.1046",
-    "@teambit/component.ui.component-meta": "0.0.271",
-    "@teambit/compositions.panels.composition-gallery": "0.0.66",
-    "@teambit/preview.ui.component-preview": "0.0.518",
+    "@teambit/compiler": "0.0.1047",
+    "@teambit/component": "0.0.1047",
+    "@teambit/pkg": "0.0.1047",
+    "@teambit/workspace": "0.0.1047",
+    "@teambit/cli": "0.0.705",
+    "@teambit/dev-files": "0.0.1047",
+    "@teambit/envs": "0.0.1047",
+    "@teambit/graphql": "0.0.1047",
+    "@teambit/logger": "0.0.798",
+    "@teambit/preview": "0.0.1047",
+    "@teambit/component-compare": "0.0.295",
+    "@teambit/docs.ui.overview-compare-section": "0.0.12",
+    "@teambit/docs.ui.overview-compare": "0.0.224",
+    "@teambit/ui": "0.0.1047",
+    "@teambit/pubsub": "0.0.1047",
+    "@teambit/component.ui.component-meta": "0.0.272",
+    "@teambit/compositions.panels.composition-gallery": "0.0.67",
+    "@teambit/preview.ui.component-preview": "0.0.519",
     "@teambit/react.ui.docs.properties-table": "0.0.12"
   },
   "devDependencies": {
@@ -51,7 +51,7 @@
     "@teambit/docs.content.docs-overview": "1.95.9"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.483",
+    "@teambit/legacy": "1.0.484",
     "react": "^16.8.0 || ^17.0.0",
     "react-dom": "^16.8.0 || ^17.0.0"
   },