@patternfly/documentation-framework 1.5.3 → 1.6.0

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# 1.6.0 (2023-02-07)
+
+
+### Features
+
+* **docs:** allow propComponents from another source ([#3397](https://github.com/patternfly/patternfly-org/issues/3397)) ([017b568](https://github.com/patternfly/patternfly-org/commit/017b568ae2ff3c8aaca53566dab4fdea6f3fe492))
+
+
+
+
+
+## 1.5.4 (2023-02-07)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
 ## 1.5.3 (2023-02-06)
 
 **Note:** Version bump only for package @patternfly/documentation-framework

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@patternfly/documentation-framework",
   "description": "A framework to build documentation for PatternFly.",
-  "version": "1.5.3",
+  "version": "1.6.0",
   "author": "Red Hat",
   "license": "MIT",
   "private": false,
@@ -84,5 +84,5 @@
     "react": "^16.8.0 || ^17.0.0",
     "react-dom": "^16.8.0 || ^17.0.0"
   },
-  "gitHead": "a136f3771c669d04b94839b36592977b7b841f33"
+  "gitHead": "4ad5d447527c174b073efeaf3d5c720f9623ddc4"
 }

package/scripts/md/parseMD.js

@@ -61,7 +61,10 @@ function toReactComponent(mdFilePath, source, buildMode) {
       }
 
       const propComponents = [...new Set(frontmatter.propComponents || [])].reduce((acc, componentName) => {
-        const name = getTsDocName(componentName, getTsDocNameVariant(source));
+        // Use object properties if passed as propComponent
+        const component = componentName.component || componentName;
+        const src = componentName.source || source;
+        const name = getTsDocName(component, getTsDocNameVariant(src));
 
         if (tsDocs[name]) {
           acc.push(tsDocs[name]);

package/templates/patternfly-docs/content/extensions/extension/examples/basic.md

@@ -9,6 +9,7 @@ id: My extension
 source: react
 # If you use typescript, the name of the interface to display props for
 # These are found through the sourceProps function provdided in patternfly-docs.source.js
+# Can also pass object { component: string, source: string } allowing to specify the source
 propComponents: ['Button']
 ---