@teambit/tagged-exports 0.0.14 → 0.0.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/tagged-exports.js +15 -13
  2. package/dist/tagged-exports.js.map +1 -1
  3. package/package.json +2 -2
  4. package/tagged-exports.tsx +19 -16
  5. /package/dist/{preview-1721791303259.js → preview-1725247248940.js} +0 -0
package/dist/tagged-exports.js CHANGED
@@ -31,35 +31,37 @@ function TaggedExports(_a) {
31
31
  const showTableOfContents = ((_b = api.apiModel) === null || _b === void 0 ? void 0 : _b.taggedAPINodes.length) === 0;
32
32
  const taggedAPIs = (_c = api.apiModel) === null || _c === void 0 ? void 0 : _c.taggedAPINodes;
33
33
  const loading = !!api.loading;
34
- if (!loading && !api.apiModel)
34
+ if (loading) {
35
+ return (react_1.default.createElement(documenter_ui_section_1.Section, Object.assign({}, rest, { className: tagged_exports_module_scss_1.default.section }),
36
+ react_1.default.createElement("div", { className: tagged_exports_module_scss_1.default.loader },
37
+ react_1.default.createElement("div", { className: tagged_exports_module_scss_1.default.loaderTitle },
38
+ react_1.default.createElement(base_ui_loaders_skeleton_1.CircleSkeleton, { size: 1.5 }),
39
+ react_1.default.createElement(base_ui_loaders_skeleton_1.WordSkeleton, { length: 5 })),
40
+ react_1.default.createElement(base_ui_loaders_skeleton_1.BlockSkeleton, { lines: 8 }),
41
+ react_1.default.createElement(base_ui_loaders_skeleton_1.BlockSkeleton, { lines: 4 }))));
42
+ }
43
+ if (!api.apiModel || !api.apiModel.apiNodes.length)
35
44
  return null;
36
- const Loader = (react_1.default.createElement("div", { className: tagged_exports_module_scss_1.default.loader },
37
- react_1.default.createElement("div", { className: tagged_exports_module_scss_1.default.loaderTitle },
38
- react_1.default.createElement(base_ui_loaders_skeleton_1.CircleSkeleton, { size: 1.5 }),
39
- react_1.default.createElement(base_ui_loaders_skeleton_1.WordSkeleton, { length: 5 })),
40
- react_1.default.createElement(base_ui_loaders_skeleton_1.BlockSkeleton, { lines: 8 }),
41
- react_1.default.createElement(base_ui_loaders_skeleton_1.BlockSkeleton, { lines: 4 })));
42
45
  return (react_1.default.createElement(documenter_ui_section_1.Section, Object.assign({}, rest, { className: tagged_exports_module_scss_1.default.section }),
43
46
  react_1.default.createElement(documenter_ui_linked_heading_1.LinkedHeading, { className: tagged_exports_module_scss_1.default.heading, size: 'sm' },
44
47
  react_1.default.createElement("div", { className: tagged_exports_module_scss_1.default.title },
45
48
  react_1.default.createElement("img", { style: { width: 24 }, src: "https://static.bit.dev/bit-icons/api-ref.svg" }),
46
49
  react_1.default.createElement("span", null, "API"))),
47
- showTableOfContents && api.apiModel && (react_1.default.createElement("div", { className: tagged_exports_module_scss_1.default.content },
50
+ showTableOfContents && (react_1.default.createElement("div", { className: tagged_exports_module_scss_1.default.content },
48
51
  react_1.default.createElement(api_reference_overview_api_reference_table_of_contents_1.APIReferenceTableOfContents, { apiModel: api.apiModel }))),
49
- !loading && (react_1.default.createElement("div", { className: tagged_exports_module_scss_1.default.taggedAPIs }, taggedAPIs === null || taggedAPIs === void 0 ? void 0 : taggedAPIs.map((taggedAPI, index) => {
52
+ react_1.default.createElement("div", { className: tagged_exports_module_scss_1.default.taggedAPIs }, taggedAPIs === null || taggedAPIs === void 0 ? void 0 : taggedAPIs.map((taggedAPI, index) => {
50
53
  const OverviewComponent = taggedAPI.renderer.OverviewComponent;
51
54
  // @todo - change this to be non nullable
52
55
  if (!OverviewComponent)
53
56
  return null;
54
57
  return (react_1.default.createElement(OverviewComponent, { apiNode: taggedAPI, key: `${taggedAPI.api.name}-${index}`, apiRefModel: api.apiModel, renderers: renderers.nodeRenderers }));
55
- }))),
56
- !loading && showBanner && (react_1.default.createElement("div", { className: tagged_exports_module_scss_1.default.banner },
58
+ })),
59
+ showBanner && (react_1.default.createElement("div", { className: tagged_exports_module_scss_1.default.banner },
57
60
  react_1.default.createElement("img", { style: { width: 16 }, src: "https://static.bit.dev/bit-icons/lightbulb-thinking.svg" }),
58
61
  react_1.default.createElement("span", null,
59
62
  "Use the",
60
63
  react_1.default.createElement("span", { className: tagged_exports_module_scss_1.default.highlighted }, "@exports"),
61
- "jsdoc tag to only show relevant APIs with details for your users"))),
62
- loading && Loader));
64
+ "jsdoc tag to only show relevant APIs with details for your users")))));
63
65
  }
64
66
  exports.TaggedExports = TaggedExports;
65
67
  //# sourceMappingURL=tagged-exports.js.map
package/dist/tagged-exports.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"tagged-exports.js","sourceRoot":"","sources":["../tagged-exports.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,kDAA0B;AAC1B,wFAAsE;AACtE,0EAAyD;AACzD,sFAA8D;AAC9D,gFAAgG;AAChG,0GAAoF;AACpF,4IAA8G;AAG9G,8FAAkD;AAOlD,SAAgB,aAAa,CAAC,EAAwD;;QAAxD,EAAE,WAAW,EAAE,UAAU,OAA+B,EAA1B,IAAI,cAAlC,6BAAoC,CAAF;IAC9D,MAAM,SAAS,GAAG,IAAA,0DAAkB,GAAE,CAAC;IACvC,MAAM,GAAG,GAAG,IAAA,oCAAM,EAAC,WAAW,EAAE,SAAS,CAAC,aAAa,CAAC,CAAC;IACzD,MAAM,mBAAmB,GAAG,CAAA,MAAA,GAAG,CAAC,QAAQ,0CAAE,cAAc,CAAC,MAAM,MAAK,CAAC,CAAC;IAEtE,MAAM,UAAU,GAAG,MAAA,GAAG,CAAC,QAAQ,0CAAE,cAAc,CAAC;IAChD,MAAM,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC;IAE9B,IAAI,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ;QAAE,OAAO,IAAI,CAAC;IAE3C,MAAM,MAAM,GAAG,CACb,uCAAK,SAAS,EAAE,oCAAM,CAAC,MAAM;QAC3B,uCAAK,SAAS,EAAE,oCAAM,CAAC,WAAW;YAChC,8BAAC,yCAAc,IAAC,IAAI,EAAE,GAAG,GAAI;YAC7B,8BAAC,uCAAY,IAAC,MAAM,EAAE,CAAC,GAAI,CACvB;QAEN,8BAAC,wCAAa,IAAC,KAAK,EAAE,CAAC,GAAI;QAC3B,8BAAC,wCAAa,IAAC,KAAK,EAAE,CAAC,GAAI,CACvB,CACP,CAAC;IAEF,OAAO,CACL,8BAAC,+BAAO,oBAAK,IAAI,IAAE,SAAS,EAAE,oCAAM,CAAC,OAAO;QAC1C,8BAAC,4CAAa,IAAC,SAAS,EAAE,oCAAM,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI;YAClD,uCAAK,SAAS,EAAE,oCAAM,CAAC,KAAK;gBAC1B,uCAAK,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,GAAG,EAAC,8CAA8C,GAAG;gBAChF,kDAAgB,CACZ,CACQ;QACf,mBAAmB,IAAI,GAAG,CAAC,QAAQ,IAAI,CACtC,uCAAK,SAAS,EAAE,oCAAM,CAAC,OAAO;YAC5B,8BAAC,oFAA2B,IAAC,QAAQ,EAAE,GAAG,CAAC,QAAQ,GAAI,CACnD,CACP;QACA,CAAC,OAAO,IAAI,CACX,uCAAK,SAAS,EAAE,oCAAM,CAAC,UAAU,IAC9B,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,GAAG,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE;YACpC,MAAM,iBAAiB,GAAG,SAAS,CAAC,QAAQ,CAAC,iBAAiB,CAAC;YAC/D,yCAAyC;YACzC,IAAI,CAAC,iBAAiB;gBAAE,OAAO,IAAI,CAAC;YACpC,OAAO,CACL,8BAAC,iBAAiB,IAChB,OAAO,EAAE,SAAS,EAClB,GAAG,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,IAAI,KAAK,EAAE,EACrC,WAAW,EAAE,GAAG,CAAC,QAA6B,EAC9C,SAAS,EAAE,SAAS,CAAC,aAAa,GAClC,CACH,CAAC;QACJ,CAAC,CAAC,CACE,CACP;QACA,CAAC,OAAO,IAAI,UAAU,IAAI,CACzB,uCAAK,SAAS,EAAE,oCAAM,CAAC,MAAM;YAC3B,uCAAK,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,GAAG,EAAC,yDAAyD,GAAG;YAC3F;;gBAEE,wCAAM,SAAS,EAAE,oCAAM,CAAC,WAAW,eAAiB;mFAE/C,CACH,CACP;QACA,OAAO,IAAI,MAAM,CACV,CACX,CAAC;AACJ,CAAC;AAjED,sCAiEC"}
1
+ {"version":3,"file":"tagged-exports.js","sourceRoot":"","sources":["../tagged-exports.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,kDAA0B;AAC1B,wFAAsE;AACtE,0EAAyD;AACzD,sFAA8D;AAC9D,gFAAgG;AAChG,0GAAoF;AACpF,4IAA8G;AAG9G,8FAAkD;AAOlD,SAAgB,aAAa,CAAC,EAAwD;;QAAxD,EAAE,WAAW,EAAE,UAAU,OAA+B,EAA1B,IAAI,cAAlC,6BAAoC,CAAF;IAC9D,MAAM,SAAS,GAAG,IAAA,0DAAkB,GAAE,CAAC;IACvC,MAAM,GAAG,GAAG,IAAA,oCAAM,EAAC,WAAW,EAAE,SAAS,CAAC,aAAa,CAAC,CAAC;IACzD,MAAM,mBAAmB,GAAG,CAAA,MAAA,GAAG,CAAC,QAAQ,0CAAE,cAAc,CAAC,MAAM,MAAK,CAAC,CAAC;IAEtE,MAAM,UAAU,GAAG,MAAA,GAAG,CAAC,QAAQ,0CAAE,cAAc,CAAC;IAChD,MAAM,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC;IAE9B,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,CACL,8BAAC,+BAAO,oBAAK,IAAI,IAAE,SAAS,EAAE,oCAAM,CAAC,OAAO;YAC1C,uCAAK,SAAS,EAAE,oCAAM,CAAC,MAAM;gBAC3B,uCAAK,SAAS,EAAE,oCAAM,CAAC,WAAW;oBAChC,8BAAC,yCAAc,IAAC,IAAI,EAAE,GAAG,GAAI;oBAC7B,8BAAC,uCAAY,IAAC,MAAM,EAAE,CAAC,GAAI,CACvB;gBAEN,8BAAC,wCAAa,IAAC,KAAK,EAAE,CAAC,GAAI;gBAC3B,8BAAC,wCAAa,IAAC,KAAK,EAAE,CAAC,GAAI,CACvB,CACE,CACX,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,GAAG,CAAC,QAAQ,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC;IAEhE,OAAO,CACL,8BAAC,+BAAO,oBAAK,IAAI,IAAE,SAAS,EAAE,oCAAM,CAAC,OAAO;QAC1C,8BAAC,4CAAa,IAAC,SAAS,EAAE,oCAAM,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI;YAClD,uCAAK,SAAS,EAAE,oCAAM,CAAC,KAAK;gBAC1B,uCAAK,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,GAAG,EAAC,8CAA8C,GAAG;gBAChF,kDAAgB,CACZ,CACQ;QACf,mBAAmB,IAAI,CACtB,uCAAK,SAAS,EAAE,oCAAM,CAAC,OAAO;YAC5B,8BAAC,oFAA2B,IAAC,QAAQ,EAAE,GAAG,CAAC,QAAQ,GAAI,CACnD,CACP;QAEC,uCAAK,SAAS,EAAE,oCAAM,CAAC,UAAU,IAC9B,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,GAAG,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE;YACpC,MAAM,iBAAiB,GAAG,SAAS,CAAC,QAAQ,CAAC,iBAAiB,CAAC;YAC/D,yCAAyC;YACzC,IAAI,CAAC,iBAAiB;gBAAE,OAAO,IAAI,CAAC;YACpC,OAAO,CACL,8BAAC,iBAAiB,IAChB,OAAO,EAAE,SAAS,EAClB,GAAG,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,IAAI,KAAK,EAAE,EACrC,WAAW,EAAE,GAAG,CAAC,QAA6B,EAC9C,SAAS,EAAE,SAAS,CAAC,aAAa,GAClC,CACH,CAAC;QACJ,CAAC,CAAC,CACE;QAEP,UAAU,IAAI,CACb,uCAAK,SAAS,EAAE,oCAAM,CAAC,MAAM;YAC3B,uCAAK,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,GAAG,EAAC,yDAAyD,GAAG;YAC3F;;gBAEE,wCAAM,SAAS,EAAE,oCAAM,CAAC,WAAW,eAAiB;mFAE/C,CACH,CACP,CACO,CACX,CAAC;AACJ,CAAC;AApED,sCAoEC"}
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@teambit/tagged-exports",
3
- "version": "0.0.14",
3
+ "version": "0.0.15",
4
4
  "homepage": "https://bit.cloud/teambit/api-reference/tagged-exports",
5
5
  "main": "dist/index.js",
6
6
  "componentId": {
7
7
  "scope": "teambit.api-reference",
8
8
  "name": "tagged-exports",
9
- "version": "0.0.14"
9
+ "version": "0.0.15"
10
10
  },
11
11
  "dependencies": {
12
12
  "core-js": "^3.0.0",
package/tagged-exports.tsx CHANGED
@@ -22,19 +22,23 @@ export function TaggedExports({ componentId, showBanner, ...rest }: TaggedExport
22
22
  const taggedAPIs = api.apiModel?.taggedAPINodes;
23
23
  const loading = !!api.loading;
24
24
 
25
- if (!loading && !api.apiModel) return null;
25
+ if (loading) {
26
+ return (
27
+ <Section {...rest} className={styles.section}>
28
+ <div className={styles.loader}>
29
+ <div className={styles.loaderTitle}>
30
+ <CircleSkeleton size={1.5} />
31
+ <WordSkeleton length={5} />
32
+ </div>
26
33
 
27
- const Loader = (
28
- <div className={styles.loader}>
29
- <div className={styles.loaderTitle}>
30
- <CircleSkeleton size={1.5} />
31
- <WordSkeleton length={5} />
32
- </div>
34
+ <BlockSkeleton lines={8} />
35
+ <BlockSkeleton lines={4} />
36
+ </div>
37
+ </Section>
38
+ );
39
+ }
33
40
 
34
- <BlockSkeleton lines={8} />
35
- <BlockSkeleton lines={4} />
36
- </div>
37
- );
41
+ if (!api.apiModel || !api.apiModel.apiNodes.length) return null;
38
42
 
39
43
  return (
40
44
  <Section {...rest} className={styles.section}>
@@ -44,12 +48,12 @@ export function TaggedExports({ componentId, showBanner, ...rest }: TaggedExport
44
48
  <span>API</span>
45
49
  </div>
46
50
  </LinkedHeading>
47
- {showTableOfContents && api.apiModel && (
51
+ {showTableOfContents && (
48
52
  <div className={styles.content}>
49
53
  <APIReferenceTableOfContents apiModel={api.apiModel} />
50
54
  </div>
51
55
  )}
52
- {!loading && (
56
+ {
53
57
  <div className={styles.taggedAPIs}>
54
58
  {taggedAPIs?.map((taggedAPI, index) => {
55
59
  const OverviewComponent = taggedAPI.renderer.OverviewComponent;
@@ -65,8 +69,8 @@ export function TaggedExports({ componentId, showBanner, ...rest }: TaggedExport
65
69
  );
66
70
  })}
67
71
  </div>
68
- )}
69
- {!loading && showBanner && (
72
+ }
73
+ {showBanner && (
70
74
  <div className={styles.banner}>
71
75
  <img style={{ width: 16 }} src="https://static.bit.dev/bit-icons/lightbulb-thinking.svg" />
72
76
  <span>
@@ -76,7 +80,6 @@ export function TaggedExports({ componentId, showBanner, ...rest }: TaggedExport
76
80
  </span>
77
81
  </div>
78
82
  )}
79
- {loading && Loader}
80
83
  </Section>
81
84
  );
82
85
  }